From af8396b0810a09daed05d1c3a818b8b81a1b9678 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 1 Oct 2026 02:54:17 +0000 Subject: [PATCH] feat: Updated OpenAPI spec --- ...ogram.AccountClient.GetAccountApiKeys.g.cs | 4 +- ...gram.AccountClient.GetAccountInvoices.g.cs | 4 +- ...deogram.AccountClient.GetAccountUsage.g.cs | 4 +- ...tReferenceUsage.JsonSerializerContext.g.cs | 164 ++ ...enceUsageClient.Authorizations.Bearer.g.cs | 35 + ...erenceUsageClient.Constructors.Bearer.g.cs | 31 + ...nceUsageClient.GetAssetReferenceUsage.g.cs | 545 ++++ .../Ideogram.AssetReferenceUsageClient.g.cs | 143 + ...ogram.AutoModel.JsonSerializerContext.g.cs | 2 +- ...toModelClient.PostGenerateImageV2Auto.g.cs | 84 +- ...deogram.AutoModelClient.PostToolRemix.g.cs | 148 +- .../Generated/Ideogram.AutoModelClient.g.cs | 2 +- ...Ideogram.Design.JsonSerializerContext.g.cs | 35 +- ...gnClient.PostLayerizeDesignIdeogramV3.g.cs | 102 +- ...am.EditWorkflow.JsonSerializerContext.g.cs | 2 +- ...am.EditWorkflowClient.PostAdLocalizer.g.cs | 96 +- ...gram.EditWorkflowClient.PostAdResizer.g.cs | 169 +- ...m.EditWorkflowClient.PostAdVariations.g.cs | 90 +- ...gram.EditWorkflowClient.PostColorways.g.cs | 104 +- ...EditWorkflowClient.PostGhostMannequin.g.cs | 126 +- ...ogram.EditWorkflowClient.PostLookbook.g.cs | 6 +- ...m.EditWorkflowClient.PostMaterialSwap.g.cs | 116 +- ...tWorkflowClient.PostModelPoseVariants.g.cs | 75 +- ...gram.EditWorkflowClient.PostModelSwap.g.cs | 55 +- ...gram.EditWorkflowClient.PostPackshots.g.cs | 12 +- ...tWorkflowClient.PostPreciseMaskedEdit.g.cs | 6 +- ...tWorkflowClient.PostSkechersStyleEdit.g.cs | 24 +- ...EditWorkflowClient.PostSketchToRender.g.cs | 67 +- ...ogram.EditWorkflowClient.PostSoleSwap.g.cs | 12 +- ...ditWorkflowClient.PostSwanSLogoDesign.g.cs | 24 +- ...itWorkflowClient.PostSwanSLogoInstall.g.cs | 24 +- ...am.EditWorkflowClient.PostSwapProduct.g.cs | 30 +- ...m.EditWorkflowClient.PostVirtualTryOn.g.cs | 6 +- ...ram.Generations.JsonSerializerContext.g.cs | 327 +++ ...nerationsClient.Authorizations.Bearer.g.cs | 35 + ...GenerationsClient.Constructors.Bearer.g.cs | 31 + ...ram.GenerationsClient.GetGenerationV2.g.cs | 578 ++++ .../Generated/Ideogram.GenerationsClient.g.cs | 143 + ...gram.IAccountClient.GetAccountApiKeys.g.cs | 4 +- ...ram.IAccountClient.GetAccountInvoices.g.cs | 4 +- ...eogram.IAccountClient.GetAccountUsage.g.cs | 4 +- ...enceUsageClient.Authorizations.Bearer.g.cs | 16 + ...nceUsageClient.GetAssetReferenceUsage.g.cs | 40 + .../Ideogram.IAssetReferenceUsageClient.g.cs | 48 + ...toModelClient.PostGenerateImageV2Auto.g.cs | 84 +- ...eogram.IAutoModelClient.PostToolRemix.g.cs | 130 +- .../Generated/Ideogram.IAutoModelClient.g.cs | 2 +- ...gnClient.PostLayerizeDesignIdeogramV3.g.cs | 84 +- ...m.IEditWorkflowClient.PostAdLocalizer.g.cs | 96 +- ...ram.IEditWorkflowClient.PostAdResizer.g.cs | 169 +- ....IEditWorkflowClient.PostAdVariations.g.cs | 90 +- ...ram.IEditWorkflowClient.PostColorways.g.cs | 104 +- ...EditWorkflowClient.PostGhostMannequin.g.cs | 126 +- ...gram.IEditWorkflowClient.PostLookbook.g.cs | 6 +- ....IEditWorkflowClient.PostMaterialSwap.g.cs | 116 +- ...tWorkflowClient.PostModelPoseVariants.g.cs | 75 +- ...ram.IEditWorkflowClient.PostModelSwap.g.cs | 55 +- ...ram.IEditWorkflowClient.PostPackshots.g.cs | 12 +- ...tWorkflowClient.PostPreciseMaskedEdit.g.cs | 6 +- ...tWorkflowClient.PostSkechersStyleEdit.g.cs | 6 +- ...EditWorkflowClient.PostSketchToRender.g.cs | 67 +- ...gram.IEditWorkflowClient.PostSoleSwap.g.cs | 12 +- ...ditWorkflowClient.PostSwanSLogoDesign.g.cs | 6 +- ...itWorkflowClient.PostSwanSLogoInstall.g.cs | 6 +- ...m.IEditWorkflowClient.PostSwapProduct.g.cs | 12 +- ....IEditWorkflowClient.PostVirtualTryOn.g.cs | 6 +- ...nerationsClient.Authorizations.Bearer.g.cs | 16 + ...am.IGenerationsClient.GetGenerationV2.g.cs | 56 + .../Ideogram.IGenerationsClient.g.cs | 48 + .../Generated/Ideogram.IIdeogramClient.g.cs | 29 +- ...ibeClient.PostDescribeImageIdeogramV3.g.cs | 40 +- ...ibeClient.PostDescribeImageIdeogramV4.g.cs | 58 +- ...teClient.PostGenerateImageV2GptImage2.g.cs | 81 +- ...nt.PostGenerateImageV2GptImage25Flare.g.cs | 91 +- ...PostGenerateImageV2GptImage25Sunburst.g.cs | 94 +- ...eClient.PostGenerateImageV2Ideogram45.g.cs | 154 +- ...eClient.PostGenerateImageV2IdeogramV2.g.cs | 54 +- ...Client.PostGenerateImageV2IdeogramV2A.g.cs | 55 +- ...eClient.PostGenerateImageV2IdeogramV3.g.cs | 78 +- ...ostGenerateImageV2IdeogramV3Character.g.cs | 112 +- ...tGenerateImageV2IdeogramV3CustomModel.g.cs | 66 +- ...tGenerateImageV2IdeogramV3Transparent.g.cs | 57 +- ...eClient.PostGenerateImageV2IdeogramV4.g.cs | 96 +- ...tGenerateImageV2IdeogramV4CustomModel.g.cs | 84 +- ...tGenerateImageV2IdeogramV4Transparent.g.cs | 111 +- ...Client.PostGenerateImageV2NanoBanana2.g.cs | 81 +- ...ient.PostGenerateImageV2NanoBananaPro.g.cs | 81 +- ...ent.PostGenerateImageV2PImageIdeogram.g.cs | 65 +- ...erateClient.PostGenerateImageV2ZImage.g.cs | 51 +- .../Ideogram.IImagesGenerateClient.g.cs | 2 +- ...ntClient.PostInpaintImageV2IdeogramV3.g.cs | 110 +- ...PostInpaintImageV2IdeogramV3Character.g.cs | 146 +- ...stInpaintImageV2IdeogramV3CustomModel.g.cs | 74 +- .../Ideogram.IImagesInpaintClient.g.cs | 5 +- ...ient.PostPreciseEditImageV2Ideogram45.g.cs | 157 +- ...ogram.IImagesReframeClient.IdeogramV3.g.cs | 63 +- ...gram.IImagesReframeClient.NanoBanana2.g.cs | 39 +- ...emixClient.PostRemixImageV2IdeogramV3.g.cs | 91 +- ...t.PostRemixImageV2IdeogramV3Character.g.cs | 134 +- ...PostRemixImageV2IdeogramV3CustomModel.g.cs | 92 +- ...emixClient.PostRemixImageV2IdeogramV4.g.cs | 93 +- .../Ideogram.IImagesRemixClient.g.cs | 5 +- ...eClient.PostUpscaleImageNanoBananaPro.g.cs | 90 +- ...aleClient.PostUpscaleImageTopazBloom2.g.cs | 87 +- ...eClient.PostUpscaleImageTopazRedefine.g.cs | 99 +- ...lient.PostUpscaleImageTopazStandardV2.g.cs | 88 +- ...lient.PostUpscaleImageTopazTextRefine.g.cs | 88 +- ...eClient.PostUpscaleImageTopazWonder35.g.cs | 87 +- ...alClient.PostRemoveObjectFromV2Assets.g.cs | 61 +- .../Ideogram.IObjectRemovalClient.g.cs | 5 +- ...Ideogram.IToolClient.RemoveBackground.g.cs | 66 +- ...deogram.IToolClient.ReplaceBackground.g.cs | 61 +- ...oolClient.ReplaceBackgroundIdeogramV3.g.cs | 71 +- .../Ideogram.IToolsClient.PostUpscale.g.cs | 87 +- ...ostEditVideoMinimaxH3ReferenceToVideo.g.cs | 98 +- ...deoEditClient.PostEditVideoSeedDance2.g.cs | 12 +- ...erateVideoKlingV3StandardImageToVideo.g.cs | 89 +- ...nerateVideoKlingV3StandardTextToVideo.g.cs | 36 +- ...ostGenerateVideoMinimaxH3ImageToVideo.g.cs | 89 +- ...PostGenerateVideoMinimaxH3TextToVideo.g.cs | 36 +- ...tGenerateVideoSeedDance25ImageToVideo.g.cs | 89 +- ...erateVideoSeedDance25ReferenceToVideo.g.cs | 108 +- ...stGenerateVideoSeedDance25TextToVideo.g.cs | 45 +- ...stGenerateVideoSeedDance2ImageToVideo.g.cs | 83 +- ...nerateVideoSeedDance2ReferenceToVideo.g.cs | 111 +- ...ostGenerateVideoSeedDance2TextToVideo.g.cs | 36 +- ....IVideoGenerateClient.PostLivingImage.g.cs | 79 + ...deoGenerateClient.PostProduct360Video.g.cs | 12 +- .../Generated/Ideogram.IdeogramClient.g.cs | 37 +- ...m.ImageDescribe.JsonSerializerContext.g.cs | 2 +- ...ibeClient.PostDescribeImageIdeogramV3.g.cs | 40 +- ...ibeClient.PostDescribeImageIdeogramV4.g.cs | 58 +- ....ImagesGenerate.JsonSerializerContext.g.cs | 2 +- ...teClient.PostGenerateImageV2GptImage2.g.cs | 81 +- ...nt.PostGenerateImageV2GptImage25Flare.g.cs | 91 +- ...PostGenerateImageV2GptImage25Sunburst.g.cs | 94 +- ...eClient.PostGenerateImageV2Ideogram45.g.cs | 154 +- ...eClient.PostGenerateImageV2IdeogramV2.g.cs | 54 +- ...Client.PostGenerateImageV2IdeogramV2A.g.cs | 55 +- ...eClient.PostGenerateImageV2IdeogramV3.g.cs | 78 +- ...ostGenerateImageV2IdeogramV3Character.g.cs | 112 +- ...tGenerateImageV2IdeogramV3CustomModel.g.cs | 66 +- ...tGenerateImageV2IdeogramV3Transparent.g.cs | 57 +- ...eClient.PostGenerateImageV2IdeogramV4.g.cs | 96 +- ...tGenerateImageV2IdeogramV4CustomModel.g.cs | 84 +- ...tGenerateImageV2IdeogramV4Transparent.g.cs | 111 +- ...Client.PostGenerateImageV2NanoBanana2.g.cs | 81 +- ...ient.PostGenerateImageV2NanoBananaPro.g.cs | 81 +- ...ent.PostGenerateImageV2PImageIdeogram.g.cs | 65 +- ...erateClient.PostGenerateImageV2ZImage.g.cs | 51 +- .../Ideogram.ImagesGenerateClient.g.cs | 2 +- ...m.ImagesInpaint.JsonSerializerContext.g.cs | 2 +- ...ntClient.PostInpaintImageV2IdeogramV3.g.cs | 110 +- ...PostInpaintImageV2IdeogramV3Character.g.cs | 146 +- ...stInpaintImageV2IdeogramV3CustomModel.g.cs | 92 +- .../Ideogram.ImagesInpaintClient.g.cs | 5 +- ...agesPreciseEdit.JsonSerializerContext.g.cs | 2 +- ...ient.PostPreciseEditImageV2Ideogram45.g.cs | 157 +- ...m.ImagesReframe.JsonSerializerContext.g.cs | 2 +- ...eogram.ImagesReframeClient.IdeogramV3.g.cs | 63 +- ...ogram.ImagesReframeClient.NanoBanana2.g.cs | 39 +- ...ram.ImagesRemix.JsonSerializerContext.g.cs | 2 +- ...emixClient.PostRemixImageV2IdeogramV3.g.cs | 91 +- ...t.PostRemixImageV2IdeogramV3Character.g.cs | 134 +- ...PostRemixImageV2IdeogramV3CustomModel.g.cs | 92 +- ...emixClient.PostRemixImageV2IdeogramV4.g.cs | 93 +- .../Generated/Ideogram.ImagesRemixClient.g.cs | 5 +- ...m.ImagesUpscale.JsonSerializerContext.g.cs | 2 +- ...eClient.PostUpscaleImageNanoBananaPro.g.cs | 90 +- ...aleClient.PostUpscaleImageTopazBloom2.g.cs | 87 +- ...eClient.PostUpscaleImageTopazRedefine.g.cs | 99 +- ...lient.PostUpscaleImageTopazStandardV2.g.cs | 88 +- ...lient.PostUpscaleImageTopazTextRefine.g.cs | 88 +- ...eClient.PostUpscaleImageTopazWonder35.g.cs | 87 +- ...ram.JsonConverters.LivingImageQuality.g.cs | 53 + ...Converters.LivingImageQualityNullable.g.cs | 60 + .../Ideogram.JsonSerializerContext.g.cs | 64 +- .../Ideogram.JsonSerializerContextTypes.g.cs | 1018 +++---- .../Ideogram.Models.AdLocalizerRequest.g.cs | 40 +- ...ram.Models.AdLocalizerRequestLanguage.g.cs | 2 +- .../Ideogram.Models.AdLocalizerResponse.g.cs | 3 +- .../Ideogram.Models.AdResizerRequest.g.cs | 102 +- ...ogram.Models.AdResizerRequestPlatform.g.cs | 32 +- ...ram.Models.AdResizerRequestResolution.g.cs | 7 +- .../Ideogram.Models.AdResizerResponse.g.cs | 2 +- .../Ideogram.Models.AdVariationsRequest.g.cs | 40 +- ...dels.AdVariationsRequestVariationType.g.cs | 2 +- .../Ideogram.Models.AdVariationsResponse.g.cs | 2 +- ...m.Models.AssetReferenceUsageItem.Json.g.cs | 141 + ...eogram.Models.AssetReferenceUsageItem.g.cs | 62 + ...dels.AssetReferenceUsageResponse.Json.g.cs | 141 + ...am.Models.AssetReferenceUsageResponse.g.cs | 54 + .../Ideogram.Models.ColorwaysRequest.g.cs | 70 +- .../Ideogram.Models.ColorwaysResponse.g.cs | 2 +- ...Models.DescribeImageIdeogramV3Request.g.cs | 14 +- ...Models.DescribeImageIdeogramV4Request.g.cs | 26 +- ...VideoMinimaxH3ReferenceToVideoRequest.g.cs | 15 +- ...s.GenerateImageGptImage25FlareRequest.g.cs | 28 +- ....GenerateImageGptImage25FlareResponse.g.cs | 16 +- ...enerateImageGptImage25SunburstRequest.g.cs | 28 +- ...nerateImageGptImage25SunburstResponse.g.cs | 16 +- ....Models.GenerateImageGptImage2Request.g.cs | 20 +- ...Models.GenerateImageGptImage2Response.g.cs | 16 +- ...Models.GenerateImageIdeogram45Request.g.cs | 115 +- ...GenerateImageIdeogram45RequestQuality.g.cs | 2 +- ...odels.GenerateImageIdeogram45Response.g.cs | 16 +- ...odels.GenerateImageIdeogramV2ARequest.g.cs | 8 +- ...dels.GenerateImageIdeogramV2AResponse.g.cs | 16 +- ...Models.GenerateImageIdeogramV2Request.g.cs | 12 +- ...odels.GenerateImageIdeogramV2Response.g.cs | 16 +- ...nerateImageIdeogramV3CharacterRequest.g.cs | 53 +- ...erateImageIdeogramV3CharacterResponse.g.cs | 16 +- ...rateImageIdeogramV3CustomModelRequest.g.cs | 24 +- ...ramV3CustomModelRequestRenderingSpeed.g.cs | 2 +- ...ateImageIdeogramV3CustomModelResponse.g.cs | 16 +- ...Models.GenerateImageIdeogramV3Request.g.cs | 24 +- ...odels.GenerateImageIdeogramV3Response.g.cs | 16 +- ...rateImageIdeogramV3TransparentRequest.g.cs | 12 +- ...ateImageIdeogramV3TransparentResponse.g.cs | 16 +- ...rateImageIdeogramV4CustomModelRequest.g.cs | 48 +- ...ramV4CustomModelRequestRenderingSpeed.g.cs | 2 +- ...ateImageIdeogramV4CustomModelResponse.g.cs | 16 +- ...Models.GenerateImageIdeogramV4Request.g.cs | 48 +- ...odels.GenerateImageIdeogramV4Response.g.cs | 16 +- ...rateImageIdeogramV4TransparentRequest.g.cs | 66 +- ...mV4TransparentRequestOutputResolution.g.cs | 10 +- ...ateImageIdeogramV4TransparentResponse.g.cs | 16 +- ...odels.GenerateImageNanoBanana2Request.g.cs | 20 +- ...dels.GenerateImageNanoBanana2Response.g.cs | 16 +- ...els.GenerateImageNanoBananaProRequest.g.cs | 20 +- ...ls.GenerateImageNanoBananaProResponse.g.cs | 16 +- ...ls.GenerateImagePImageIdeogramRequest.g.cs | 22 +- ...eImagePImageIdeogramRequestResolution.g.cs | 2 +- ...s.GenerateImagePImageIdeogramResponse.g.cs | 16 +- ...ram.Models.GenerateImageV2AutoRequest.g.cs | 33 +- ...erateImageV2AutoRequestResolutionTier.g.cs | 2 +- ...am.Models.GenerateImageV2AutoResponse.g.cs | 16 +- ...ram.Models.GenerateImageZImageRequest.g.cs | 12 +- ...am.Models.GenerateImageZImageResponse.g.cs | 16 +- ...m.Models.GenerateVideoKlingV3Response.g.cs | 16 +- ...deoKlingV3StandardImageToVideoRequest.g.cs | 26 +- ...rateVideoMinimaxH3ImageToVideoRequest.g.cs | 26 +- ...Models.GenerateVideoMinimaxH3Response.g.cs | 14 +- ...teVideoSeedDance25ImageToVideoRequest.g.cs | 26 +- ...deoSeedDance25ReferenceToVideoRequest.g.cs | 24 +- ...dels.GenerateVideoSeedDance25Response.g.cs | 16 +- ...ateVideoSeedDance2ImageToVideoRequest.g.cs | 25 +- ...ideoSeedDance2ReferenceToVideoRequest.g.cs | 24 +- ...odels.GenerateVideoSeedDance2Response.g.cs | 16 +- ...Ideogram.Models.GhostMannequinRequest.g.cs | 136 +- ...deogram.Models.GhostMannequinResponse.g.cs | 4 +- ...npaintImageIdeogramV3CharacterRequest.g.cs | 50 +- ...geIdeogramV3CharacterRequestStyleType.g.cs | 2 +- ...paintImageIdeogramV3CharacterResponse.g.cs | 6 +- ...aintImageIdeogramV3CustomModelRequest.g.cs | 33 +- ...intImageIdeogramV3CustomModelResponse.g.cs | 2 +- ....Models.InpaintImageIdeogramV3Request.g.cs | 36 +- ...Models.InpaintImageIdeogramV3Response.g.cs | 6 +- ...odels.LayerizeDesignIdeogramV3Request.g.cs | 18 +- ...dels.LayerizeDesignIdeogramV3Response.g.cs | 16 +- .../Ideogram.Models.LivingImageQuality.g.cs | 52 + ...eogram.Models.LivingImageRequest.Json.g.cs | 141 + .../Ideogram.Models.LivingImageRequest.g.cs | 91 + ...ogram.Models.LivingImageResponse.Json.g.cs | 141 + .../Ideogram.Models.LivingImageResponse.g.cs | 62 + .../Ideogram.Models.LookbookResponse.g.cs | 2 +- .../Ideogram.Models.MaterialSwapRequest.g.cs | 90 +- .../Ideogram.Models.MaterialSwapResponse.g.cs | 2 +- ...ogram.Models.ModelPoseVariantsRequest.g.cs | 40 +- ...gram.Models.ModelPoseVariantsResponse.g.cs | 2 +- .../Ideogram.Models.ModelSwapRequest.g.cs | 10 +- .../Ideogram.Models.ModelSwapResponse.g.cs | 3 +- .../Ideogram.Models.PackshotsResponse.g.cs | 2 +- ...els.PreciseEditImageIdeogram45Request.g.cs | 51 +- ...ls.PreciseEditImageIdeogram45Response.g.cs | 19 +- ....Models.ReframeImageIdeogramV3Request.g.cs | 17 +- ...Models.ReframeImageIdeogramV3Response.g.cs | 6 +- ...Models.ReframeImageNanoBanana2Request.g.cs | 5 +- ...odels.ReframeImageNanoBanana2Response.g.cs | 6 +- ....RemixImageIdeogramV3CharacterRequest.g.cs | 35 +- ...RemixImageIdeogramV3CharacterResponse.g.cs | 6 +- ...emixImageIdeogramV3CustomModelRequest.g.cs | 16 +- ...mixImageIdeogramV3CustomModelResponse.g.cs | 6 +- ...am.Models.RemixImageIdeogramV3Request.g.cs | 20 +- ...m.Models.RemixImageIdeogramV3Response.g.cs | 6 +- ...am.Models.RemixImageIdeogramV4Request.g.cs | 27 +- ...m.Models.RemixImageIdeogramV4Response.g.cs | 6 +- ...Models.RemoveBackgroundV2AssetRequest.g.cs | 6 +- ...gram.Models.RemoveBackgroundV2Request.g.cs | 26 +- ...ram.Models.RemoveBackgroundV2Response.g.cs | 19 +- ...odels.RemoveObjectFromV2AssetsRequest.g.cs | 32 +- ...dels.RemoveObjectFromV2AssetsResponse.g.cs | 11 +- ...ls.ReplaceBackgroundIdeogramV3Request.g.cs | 40 +- ...ogram.Models.ReplaceBackgroundRequest.g.cs | 32 +- ...gram.Models.ReplaceBackgroundResponse.g.cs | 6 +- ...Ideogram.Models.SketchToRenderRequest.g.cs | 37 +- ...deogram.Models.SketchToRenderResponse.g.cs | 3 +- ...eogram.Models.SwanSLogoDesignResponse.g.cs | 4 +- ...ogram.Models.SwanSLogoInstallResponse.g.cs | 4 +- .../Ideogram.Models.ToolRemixRequest.g.cs | 56 +- ...Models.ToolRemixRequestResolutionTier.g.cs | 2 +- .../Ideogram.Models.ToolRemixResponse.g.cs | 20 +- ...dels.UpscaleImageNanoBananaProRequest.g.cs | 17 +- ...els.UpscaleImageNanoBananaProResponse.g.cs | 17 +- ...Models.UpscaleImageTopazBloom2Request.g.cs | 17 +- ...odels.UpscaleImageTopazBloom2Response.g.cs | 17 +- ...dels.UpscaleImageTopazRedefineRequest.g.cs | 29 +- ...eTopazRedefineRequestSubjectDetection.g.cs | 2 +- ...els.UpscaleImageTopazRedefineResponse.g.cs | 17 +- ...ls.UpscaleImageTopazStandardV2Request.g.cs | 37 +- ...opazStandardV2RequestSubjectDetection.g.cs | 2 +- ...s.UpscaleImageTopazStandardV2Response.g.cs | 17 +- ...ls.UpscaleImageTopazTextRefineRequest.g.cs | 37 +- ...opazTextRefineRequestSubjectDetection.g.cs | 2 +- ...s.UpscaleImageTopazTextRefineResponse.g.cs | 17 +- ...dels.UpscaleImageTopazWonder35Request.g.cs | 17 +- ...els.UpscaleImageTopazWonder35Response.g.cs | 17 +- .../Ideogram.Models.UpscaleToolRequest.g.cs | 17 +- .../Ideogram.Models.UpscaleToolResponse.g.cs | 17 +- .../Ideogram.Models.VirtualTryOnResponse.g.cs | 2 +- ...m.ObjectRemoval.JsonSerializerContext.g.cs | 2 +- ...alClient.PostRemoveObjectFromV2Assets.g.cs | 61 +- .../Ideogram.ObjectRemovalClient.g.cs | 5 +- .../Ideogram.Tool.JsonSerializerContext.g.cs | 2 +- .../Ideogram.ToolClient.RemoveBackground.g.cs | 66 +- ...Ideogram.ToolClient.ReplaceBackground.g.cs | 61 +- ...oolClient.ReplaceBackgroundIdeogramV3.g.cs | 71 +- .../Ideogram.Tools.JsonSerializerContext.g.cs | 2 +- .../Ideogram.ToolsClient.PostUpscale.g.cs | 87 +- ...ogram.VideoEdit.JsonSerializerContext.g.cs | 47 +- ...ostEditVideoMinimaxH3ReferenceToVideo.g.cs | 116 +- ...deoEditClient.PostEditVideoSeedDance2.g.cs | 30 +- ...m.VideoGenerate.JsonSerializerContext.g.cs | 48 +- ...erateVideoKlingV3StandardImageToVideo.g.cs | 89 +- ...nerateVideoKlingV3StandardTextToVideo.g.cs | 36 +- ...ostGenerateVideoMinimaxH3ImageToVideo.g.cs | 89 +- ...PostGenerateVideoMinimaxH3TextToVideo.g.cs | 36 +- ...tGenerateVideoSeedDance25ImageToVideo.g.cs | 89 +- ...erateVideoSeedDance25ReferenceToVideo.g.cs | 126 +- ...stGenerateVideoSeedDance25TextToVideo.g.cs | 45 +- ...stGenerateVideoSeedDance2ImageToVideo.g.cs | 83 +- ...nerateVideoSeedDance2ReferenceToVideo.g.cs | 129 +- ...ostGenerateVideoSeedDance2TextToVideo.g.cs | 36 +- ...m.VideoGenerateClient.PostLivingImage.g.cs | 739 ++++++ ...deoGenerateClient.PostProduct360Video.g.cs | 12 +- .../Generated/autosdk.generated-examples.json | 785 +++--- src/libs/Ideogram/openapi.json | 2331 ++++++++++------- 347 files changed, 11210 insertions(+), 11305 deletions(-) create mode 100644 src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsage.JsonSerializerContext.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.Authorizations.Bearer.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.Constructors.Bearer.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.GetAssetReferenceUsage.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.Generations.JsonSerializerContext.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.GenerationsClient.Authorizations.Bearer.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.GenerationsClient.Constructors.Bearer.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.GenerationsClient.GetGenerationV2.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.GenerationsClient.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.Authorizations.Bearer.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.GetAssetReferenceUsage.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.Authorizations.Bearer.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.GetGenerationV2.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostLivingImage.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.JsonConverters.LivingImageQuality.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.JsonConverters.LivingImageQualityNullable.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageItem.Json.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageItem.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageResponse.Json.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageResponse.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.Models.LivingImageQuality.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.Models.LivingImageRequest.Json.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.Models.LivingImageRequest.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.Models.LivingImageResponse.Json.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.Models.LivingImageResponse.g.cs create mode 100644 src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostLivingImage.g.cs diff --git a/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountApiKeys.g.cs b/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountApiKeys.g.cs index 79c654cb..931f57a5 100644 --- a/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountApiKeys.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountApiKeys.g.cs @@ -40,7 +40,7 @@ partial void ProcessGetAccountApiKeysResponseContent( ref string content); /// - /// List your organization's API keys
+ /// List API keys
/// Lists the API keys in your organization. Key material is redacted —
/// the full key is only shown once, when it is created. Disabled and
/// archived keys are included (see each key's `status`) so historical
@@ -63,7 +63,7 @@ partial void ProcessGetAccountApiKeysResponseContent( return __response.Body; } /// - /// List your organization's API keys
+ /// List API keys
/// Lists the API keys in your organization. Key material is redacted —
/// the full key is only shown once, when it is created. Disabled and
/// archived keys are included (see each key's `status`) so historical
diff --git a/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountInvoices.g.cs b/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountInvoices.g.cs index 22185fa1..a28dd8a3 100644 --- a/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountInvoices.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountInvoices.g.cs @@ -40,7 +40,7 @@ partial void ProcessGetAccountInvoicesResponseContent( ref string content); /// - /// List your organization's invoices
+ /// List invoices
/// Returns your organization's invoices with their line items — the
/// billing record your usage reports reconcile against. Amounts are
/// decimal strings in the invoice's currency.
@@ -62,7 +62,7 @@ partial void ProcessGetAccountInvoicesResponseContent( return __response.Body; } /// - /// List your organization's invoices
+ /// List invoices
/// Returns your organization's invoices with their line items — the
/// billing record your usage reports reconcile against. Amounts are
/// decimal strings in the invoice's currency.
diff --git a/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountUsage.g.cs b/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountUsage.g.cs index 148682f9..d4d8628e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountUsage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.AccountClient.GetAccountUsage.g.cs @@ -48,7 +48,7 @@ partial void ProcessGetAccountUsageResponseContent( ref string content); /// - /// Retrieve your organization's API usage and spend over time
+ /// Get usage and spend
/// Returns your organization's billed API usage as dense time buckets of
/// line items. Every line item carries the billed dollar amount; products
/// billed per item also carry `billed_units` (unit, quantity, and unit
@@ -99,7 +99,7 @@ partial void ProcessGetAccountUsageResponseContent( return __response.Body; } /// - /// Retrieve your organization's API usage and spend over time
+ /// Get usage and spend
/// Returns your organization's billed API usage as dense time buckets of
/// line items. Every line item carries the billed dollar amount; products
/// billed per item also carry `billed_units` (unit, quantity, and unit
diff --git a/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsage.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsage.JsonSerializerContext.g.cs new file mode 100644 index 00000000..5c8ca383 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsage.JsonSerializerContext.g.cs @@ -0,0 +1,164 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// + /// + [global::System.Text.Json.Serialization.JsonSourceGenerationOptions( + DefaultIgnoreCondition = global::System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull + )] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.Dictionary))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.Dictionary))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List), TypeInfoPropertyName = "SystemCollectionsGeneric_ObjectList")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Text.Json.JsonElement?))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(string))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(long))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.DateTime))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetReferenceUsageResponse))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetReferenceUsageItem))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetType), TypeInfoPropertyName = "AssetType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(long?))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.DateTime?))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetType?), TypeInfoPropertyName = "NullableAssetType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] + internal sealed partial class AssetReferenceUsageSourceGenerationContextChunk0 : global::System.Text.Json.Serialization.JsonSerializerContext + { + } + /// + /// + /// + public sealed partial class AssetReferenceUsageSourceGenerationContext : global::System.Text.Json.Serialization.JsonSerializerContext + { + private static readonly global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver Resolver = new LazyChunkResolver(); + + [global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)] + internal static global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver TypeInfoResolver => Resolver; + + + private static readonly global::System.Text.Json.JsonSerializerOptions DefaultOptions = CreateDefaultOptions(); + + /// + /// + /// + public static AssetReferenceUsageSourceGenerationContext Default { get; } = new(DefaultOptions); + + private AssetReferenceUsageSourceGenerationContext(global::System.Text.Json.JsonSerializerOptions options) + : base(options) + { + } + + /// + protected override global::System.Text.Json.JsonSerializerOptions? GeneratedSerializerOptions => DefaultOptions; + + /// + public override global::System.Text.Json.Serialization.Metadata.JsonTypeInfo? GetTypeInfo(global::System.Type type) + { + return Resolver.GetTypeInfo(type, Options); + } + + /// + /// Adds this package's converters to . + /// + /// + /// A converter has to be on the options a chained resolver builds its JsonTypeInfo against, + /// and a context resolves types from every package below it. Each package contributes only + /// what it owns and calls down the chain for the rest, so the family's converter table is + /// written once rather than copied into all of them. + /// + [global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)] + public static void AddConverters(global::System.Text.Json.JsonSerializerOptions options) + { + options.Converters.Add(new global::Ideogram.JsonConverters.UnixTimestampJsonConverter()); + options.Converters.Add(new LazyEnumJsonConverterFactory()); + } + + private static global::System.Text.Json.JsonSerializerOptions CreateDefaultOptions() + { + var options = new global::System.Text.Json.JsonSerializerOptions + { + DefaultIgnoreCondition = global::System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull, + TypeInfoResolver = Resolver, + }; + AddConverters(options); + + return options; + } + + + private sealed class LazyEnumJsonConverterFactory : global::System.Text.Json.Serialization.JsonConverterFactory + { + public override bool CanConvert(global::System.Type typeToConvert) + { + return + typeToConvert == typeof(global::Ideogram.AssetType) + + || typeToConvert == typeof(global::Ideogram.AssetType?); + } + + public override global::System.Text.Json.Serialization.JsonConverter CreateConverter( + global::System.Type typeToConvert, + global::System.Text.Json.JsonSerializerOptions options) + { + if (typeToConvert == typeof(global::Ideogram.AssetType)) + { + return new global::Ideogram.JsonConverters.AssetTypeJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.AssetType?)) + { + return new global::Ideogram.JsonConverters.AssetTypeNullableJsonConverter(); + } + throw new global::System.NotSupportedException($"No generated enum converter is registered for '{typeToConvert}'."); + } + } + + private sealed class LazyChunkResolver : global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver + { + private readonly object _gate = new(); + private readonly global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver?[] _resolvers = new global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver?[1]; + + public global::System.Text.Json.Serialization.Metadata.JsonTypeInfo? GetTypeInfo( + global::System.Type type, + global::System.Text.Json.JsonSerializerOptions options) + { + for (var index = 0; index < _resolvers.Length; index++) + { + var typeInfo = GetResolver(index).GetTypeInfo(type, options); + if (typeInfo is not null) + { + return typeInfo; + } + } + + return null; + } + + private global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver GetResolver(int index) + { + var resolver = global::System.Threading.Volatile.Read(ref _resolvers[index]); + if (resolver is not null) + { + return resolver; + } + + lock (_gate) + { + return _resolvers[index] ??= CreateResolver(index); + } + } + + private static global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver CreateResolver(int index) + { + return index switch + { + 0 => new AssetReferenceUsageSourceGenerationContextChunk0(new global::System.Text.Json.JsonSerializerOptions()), + _ => throw new global::System.ArgumentOutOfRangeException(nameof(index)), + }; + } + } + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.Authorizations.Bearer.g.cs b/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.Authorizations.Bearer.g.cs new file mode 100644 index 00000000..d5eb8c46 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.Authorizations.Bearer.g.cs @@ -0,0 +1,35 @@ + +#nullable enable + +namespace Ideogram +{ + public sealed partial class AssetReferenceUsageClient + { + + /// + public void AuthorizeUsingBearer( + string apiKey) + { + apiKey = apiKey ?? throw new global::System.ArgumentNullException(nameof(apiKey)); + + for (var i = Authorizations.Count - 1; i >= 0; i--) + { + var __authorization = Authorizations[i]; + if (__authorization.Type == "Http" && + __authorization.Name == "Bearer") + { + Authorizations.RemoveAt(i); + } + } + + Authorizations.Add(new global::Ideogram.EndPointAuthorization + { + Type = "Http", + SchemeId = "HttpBearer", + Location = "Header", + Name = "Bearer", + Value = apiKey, + }); + } + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.Constructors.Bearer.g.cs b/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.Constructors.Bearer.g.cs new file mode 100644 index 00000000..de1178f5 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.Constructors.Bearer.g.cs @@ -0,0 +1,31 @@ + +#nullable enable + +namespace Ideogram +{ + public sealed partial class AssetReferenceUsageClient + { + /// + + public AssetReferenceUsageClient( + string apiKey, + global::System.Net.Http.HttpClient? httpClient = null, + global::System.Uri? baseUri = null, + global::System.Collections.Generic.List? authorizations = null, + bool disposeHttpClient = true) : this(httpClient, baseUri, authorizations, disposeHttpClient) + { + Authorizing(HttpClient, ref apiKey); + + AuthorizeUsingBearer(apiKey); + + Authorized(HttpClient); + } + + partial void Authorizing( + global::System.Net.Http.HttpClient client, + ref string apiKey); + partial void Authorized( + global::System.Net.Http.HttpClient client); + + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.GetAssetReferenceUsage.g.cs b/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.GetAssetReferenceUsage.g.cs new file mode 100644 index 00000000..d865cb68 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.GetAssetReferenceUsage.g.cs @@ -0,0 +1,545 @@ + +#nullable enable + +namespace Ideogram +{ + public partial class AssetReferenceUsageClient + { + + + private static readonly global::Ideogram.EndPointSecurityRequirement s_GetAssetReferenceUsageSecurityRequirement0 = + new global::Ideogram.EndPointSecurityRequirement + { + Authorizations = new global::Ideogram.EndPointAuthorizationRequirement[] + { new global::Ideogram.EndPointAuthorizationRequirement + { + Type = "Http", + SchemeId = "HttpBearer", + Location = "Header", + Name = "Bearer", + FriendlyName = "Bearer", + }, + }, + }; + private static readonly global::Ideogram.EndPointSecurityRequirement[] s_GetAssetReferenceUsageSecurityRequirements = + new global::Ideogram.EndPointSecurityRequirement[] + { s_GetAssetReferenceUsageSecurityRequirement0, + }; + partial void PrepareGetAssetReferenceUsageArguments( + global::System.Net.Http.HttpClient httpClient, + ref global::System.DateTime startDate, + ref global::System.DateTime endDate, + ref string? cursor); + partial void PrepareGetAssetReferenceUsageRequest( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpRequestMessage httpRequestMessage, + global::System.DateTime startDate, + global::System.DateTime endDate, + string? cursor); + partial void ProcessGetAssetReferenceUsageResponse( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpResponseMessage httpResponseMessage); + + partial void ProcessGetAssetReferenceUsageResponseContent( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpResponseMessage httpResponseMessage, + ref string content); + + /// + /// Rank edit reference assets used by organization requests
+ /// Counts completed requests made by the authenticated organization that used each existing asset as an edit input during the UTC date range. Direct file uploads without saved asset identifiers are excluded. Results are independent of current asset ownership, collection membership, and sharing. Returning an identifier does not grant access to its image. Tracking begins when enabled; earlier history is not included. Returns 50 assets per page. Rankings may change between pages when daily counts are updated; cursors do not pin a historical snapshot. + ///
+ /// + /// + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + public async global::System.Threading.Tasks.Task GetAssetReferenceUsageAsync( + global::System.DateTime startDate, + global::System.DateTime endDate, + string? cursor = default, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default) + { + var __response = await GetAssetReferenceUsageAsResponseAsync( + startDate: startDate, + endDate: endDate, + cursor: cursor, + requestOptions: requestOptions, + cancellationToken: cancellationToken + ).ConfigureAwait(false); + + return __response.Body; + } + /// + /// Rank edit reference assets used by organization requests
+ /// Counts completed requests made by the authenticated organization that used each existing asset as an edit input during the UTC date range. Direct file uploads without saved asset identifiers are excluded. Results are independent of current asset ownership, collection membership, and sharing. Returning an identifier does not grant access to its image. Tracking begins when enabled; earlier history is not included. Returns 50 assets per page. Rankings may change between pages when daily counts are updated; cursors do not pin a historical snapshot. + ///
+ /// + /// + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + public async global::System.Threading.Tasks.Task> GetAssetReferenceUsageAsResponseAsync( + global::System.DateTime startDate, + global::System.DateTime endDate, + string? cursor = default, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default) + { + PrepareArguments( + client: HttpClient); + PrepareGetAssetReferenceUsageArguments( + httpClient: HttpClient, + startDate: ref startDate, + endDate: ref endDate, + cursor: ref cursor); + + + var __authorizations = global::Ideogram.EndPointSecurityResolver.ResolveAuthorizations( + availableAuthorizations: Authorizations, + securityRequirements: s_GetAssetReferenceUsageSecurityRequirements, + operationName: "GetAssetReferenceUsageAsync"); + + using var __timeoutCancellationTokenSource = global::Ideogram.AutoSDKRequestOptionsSupport.CreateTimeoutCancellationTokenSource( + clientOptions: Options, + requestOptions: requestOptions, + cancellationToken: cancellationToken); + var __effectiveCancellationToken = __timeoutCancellationTokenSource?.Token ?? cancellationToken; + var __effectiveReadResponseAsString = global::Ideogram.AutoSDKRequestOptionsSupport.GetReadResponseAsString( + clientOptions: Options, + requestOptions: requestOptions, + fallbackValue: ReadResponseAsString); + var __maxAttempts = global::Ideogram.AutoSDKRequestOptionsSupport.GetMaxAttempts( + clientOptions: Options, + requestOptions: requestOptions, + supportsRetry: true); + + global::System.Net.Http.HttpRequestMessage __CreateHttpRequest() + { + + var __pathBuilder = new global::Ideogram.PathBuilder( + path: "/v2/assets/reference-usage", + baseUri: HttpClient.BaseAddress); + __pathBuilder + .AddRequiredParameter("start_date", startDate.ToString("yyyy-MM-dd")) + .AddRequiredParameter("end_date", endDate.ToString("yyyy-MM-dd")) + .AddOptionalParameter("cursor", cursor) + ; + var __path = __pathBuilder.ToString(); + __path = global::Ideogram.AutoSDKRequestOptionsSupport.AppendQueryParameters( + path: __path, + clientParameters: Options.QueryParameters, + requestParameters: requestOptions?.QueryParameters); + var __httpRequest = new global::System.Net.Http.HttpRequestMessage( + method: global::System.Net.Http.HttpMethod.Get, + requestUri: new global::System.Uri(__path, global::System.UriKind.RelativeOrAbsolute)); +#if NET6_0_OR_GREATER + __httpRequest.Version = global::System.Net.HttpVersion.Version11; + __httpRequest.VersionPolicy = global::System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher; +#endif + + foreach (var __authorization in __authorizations) + { + if (__authorization.Type == "Http" || + __authorization.Type == "OAuth2" || + __authorization.Type == "OpenIdConnect") + { + __httpRequest.Headers.Authorization = new global::System.Net.Http.Headers.AuthenticationHeaderValue( + scheme: __authorization.Name, + parameter: __authorization.Value); + } + else if (__authorization.Type == "ApiKey" && + __authorization.Location == "Header") + { + __httpRequest.Headers.Add(__authorization.Name, __authorization.Value); + } + } + global::Ideogram.AutoSDKRequestOptionsSupport.ApplyHeaders( + request: __httpRequest, + clientHeaders: Options.Headers, + requestHeaders: requestOptions?.Headers); + + PrepareRequest( + client: HttpClient, + request: __httpRequest); + PrepareGetAssetReferenceUsageRequest( + httpClient: HttpClient, + httpRequestMessage: __httpRequest, + startDate: startDate, + endDate: endDate, + cursor: cursor); + + return __httpRequest; + } + + global::System.Net.Http.HttpRequestMessage? __httpRequest = null; + global::System.Net.Http.HttpResponseMessage? __response = null; + var __attemptNumber = 0; + try + { + for (var __attempt = 1; __attempt <= __maxAttempts; __attempt++) + { + __attemptNumber = __attempt; + __httpRequest = __CreateHttpRequest(); + await global::Ideogram.AutoSDKRequestOptionsSupport.OnBeforeRequestAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "GetAssetReferenceUsage", + methodName: "GetAssetReferenceUsageAsync", + pathTemplate: "\"/v2/assets/reference-usage\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: null, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: false, + retryDelay: null, + retryReason: global::System.String.Empty, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + try + { + __response = await HttpClient.SendAsync( + request: __httpRequest, + completionOption: global::System.Net.Http.HttpCompletionOption.ResponseContentRead, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + } + catch (global::System.Net.Http.HttpRequestException __exception) + { + var __retryDelay = global::Ideogram.AutoSDKRequestOptionsSupport.GetRetryDelay( + clientOptions: Options, + requestOptions: requestOptions, + response: null, + attempt: __attempt); + var __willRetry = __attempt < __maxAttempts && !__effectiveCancellationToken.IsCancellationRequested; + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "GetAssetReferenceUsage", + methodName: "GetAssetReferenceUsageAsync", + pathTemplate: "\"/v2/assets/reference-usage\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: null, + exception: __exception, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: __willRetry, + retryDelay: __willRetry ? __retryDelay : (global::System.TimeSpan?)null, + retryReason: "exception", + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + if (!__willRetry) + { + throw; + } + + __httpRequest.Dispose(); + __httpRequest = null; + await global::Ideogram.AutoSDKRequestOptionsSupport.DelayBeforeRetryAsync( + retryDelay: __retryDelay, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + continue; + } + + if (__response != null && + __attempt < __maxAttempts && + global::Ideogram.AutoSDKRequestOptionsSupport.ShouldRetryStatusCode(__response.StatusCode)) + { + var __retryDelay = global::Ideogram.AutoSDKRequestOptionsSupport.GetRetryDelay( + clientOptions: Options, + requestOptions: requestOptions, + response: __response, + attempt: __attempt); + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "GetAssetReferenceUsage", + methodName: "GetAssetReferenceUsageAsync", + pathTemplate: "\"/v2/assets/reference-usage\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: true, + retryDelay: __retryDelay, + retryReason: "status:" + ((int)__response.StatusCode).ToString(global::System.Globalization.CultureInfo.InvariantCulture), + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + __response.Dispose(); + __response = null; + __httpRequest.Dispose(); + __httpRequest = null; + await global::Ideogram.AutoSDKRequestOptionsSupport.DelayBeforeRetryAsync( + retryDelay: __retryDelay, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + continue; + } + + break; + } + + if (__response == null) + { + throw new global::System.InvalidOperationException("No response received."); + } + + using (__response) + { + + ProcessResponse( + client: HttpClient, + response: __response); + ProcessGetAssetReferenceUsageResponse( + httpClient: HttpClient, + httpResponseMessage: __response); + if (__response.IsSuccessStatusCode) + { + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterSuccessAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "GetAssetReferenceUsage", + methodName: "GetAssetReferenceUsageAsync", + pathTemplate: "\"/v2/assets/reference-usage\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attemptNumber, + maxAttempts: __maxAttempts, + willRetry: false, + retryDelay: null, + retryReason: global::System.String.Empty, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + } + else + { + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "GetAssetReferenceUsage", + methodName: "GetAssetReferenceUsageAsync", + pathTemplate: "\"/v2/assets/reference-usage\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attemptNumber, + maxAttempts: __maxAttempts, + willRetry: false, + retryDelay: null, + retryReason: global::System.String.Empty, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + } + // + if ((int)__response.StatusCode == 400) + { + string? __content_400 = null; + global::System.Exception? __exception_400 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_400 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_400 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_400 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_400 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_400, + responseBody: __content_400, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // + if ((int)__response.StatusCode == 401) + { + string? __content_401 = null; + global::System.Exception? __exception_401 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_401 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_401 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_401 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_401 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_401, + responseBody: __content_401, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // + if ((int)__response.StatusCode == 503) + { + string? __content_503 = null; + global::System.Exception? __exception_503 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_503 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_503 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_503 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_503 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_503, + responseBody: __content_503, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + + if (__effectiveReadResponseAsString) + { + var __content = await __response.Content.ReadAsStringAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + + ProcessResponseContent( + client: HttpClient, + response: __response, + content: ref __content); + ProcessGetAssetReferenceUsageResponseContent( + httpClient: HttpClient, + httpResponseMessage: __response, + content: ref __content); + + try + { + __response.EnsureSuccessStatusCode(); + + var __value = global::Ideogram.AssetReferenceUsageResponse.FromJson(__content, JsonSerializerContext) ?? + throw new global::System.InvalidOperationException($"Response deserialization failed for \"{__content}\" "); + return new global::Ideogram.AutoSDKHttpResponse( + statusCode: __response.StatusCode, + headers: global::Ideogram.AutoSDKHttpResponse.CreateHeaders(__response), + requestUri: __response.RequestMessage?.RequestUri, + body: __value); + } + catch (global::System.Exception __ex) + { + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content ?? __response.ReasonPhrase ?? string.Empty, + innerException: __ex, + responseBody: __content, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + } + else + { + try + { + __response.EnsureSuccessStatusCode(); + using var __content = await __response.Content.ReadAsStreamAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + + var __value = await global::Ideogram.AssetReferenceUsageResponse.FromJsonStreamAsync(__content, JsonSerializerContext).ConfigureAwait(false) ?? + throw new global::System.InvalidOperationException("Response deserialization failed."); + return new global::Ideogram.AutoSDKHttpResponse( + statusCode: __response.StatusCode, + headers: global::Ideogram.AutoSDKHttpResponse.CreateHeaders(__response), + requestUri: __response.RequestMessage?.RequestUri, + body: __value); + } + catch (global::System.Exception __ex) + { + string? __content = null; + try + { + __content = await __response.Content.ReadAsStringAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + } + catch (global::System.Exception) + { + } + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content ?? __response.ReasonPhrase ?? string.Empty, + innerException: __ex, + responseBody: __content, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + } + + } + } + finally + { + __httpRequest?.Dispose(); + } + } + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.g.cs new file mode 100644 index 00000000..08e116db --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.AssetReferenceUsageClient.g.cs @@ -0,0 +1,143 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// If no httpClient is provided, a new one will be created.
+ /// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. + ///
+ public sealed partial class AssetReferenceUsageClient : global::Ideogram.IAssetReferenceUsageClient, global::System.IDisposable + { + /// + /// + /// + public const string DefaultBaseUrl = "https://api.ideogram.ai/"; + + private bool _disposeHttpClient = true; + + /// + public global::System.Net.Http.HttpClient HttpClient { get; } + + /// + public System.Uri? BaseUri => HttpClient.BaseAddress; + + /// + public global::System.Collections.Generic.List Authorizations { get; } + + /// + public bool ReadResponseAsString { get; set; } +#if DEBUG + = true; +#endif + + /// + public global::Ideogram.AutoSDKClientOptions Options { get; } + + internal global::System.Lazy JsonSerializerContextProvider { get; set; } = new(() => global::Ideogram.AssetReferenceUsageSourceGenerationContext.Default); + + /// + /// + /// + public global::System.Text.Json.Serialization.JsonSerializerContext JsonSerializerContext + { + get => JsonSerializerContextProvider.Value; + set => JsonSerializerContextProvider = new(() => value); + } + + + /// + /// Creates a new instance of the AssetReferenceUsageClient. + /// If no httpClient is provided, a new one will be created. + /// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. + /// + /// The HttpClient instance. If not provided, a new one will be created. + /// The base URL for the API. If not provided, the default baseUri from OpenAPI spec will be used. + /// The authorizations to use for the requests. + /// Dispose the HttpClient when the instance is disposed. True by default. + public AssetReferenceUsageClient( + global::System.Net.Http.HttpClient? httpClient = null, + global::System.Uri? baseUri = null, + global::System.Collections.Generic.List? authorizations = null, + bool disposeHttpClient = true) : this( + httpClient, + baseUri, + authorizations, + options: null, + disposeHttpClient: disposeHttpClient) + { + } + + /// + /// Creates a new instance of the AssetReferenceUsageClient with explicit options but no base URL override. + /// Skips passing baseUri so the default base URL from the OpenAPI spec applies. + /// + /// The HttpClient instance. If not provided, a new one will be created. + /// The authorizations to use for the requests. + /// Client-wide request defaults such as headers, query parameters, retries, and timeout. + /// Dispose the HttpClient when the instance is disposed. True by default. + public AssetReferenceUsageClient( + global::System.Net.Http.HttpClient? httpClient, + global::System.Collections.Generic.List? authorizations, + global::Ideogram.AutoSDKClientOptions? options, + bool disposeHttpClient = true) : this( + httpClient, + baseUri: null, + authorizations, + options, + disposeHttpClient: disposeHttpClient) + { + } + + /// + /// Creates a new instance of the AssetReferenceUsageClient. + /// If no httpClient is provided, a new one will be created. + /// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. + /// + /// The HttpClient instance. If not provided, a new one will be created. + /// The base URL for the API. If not provided, the default baseUri from OpenAPI spec will be used. + /// The authorizations to use for the requests. + /// Client-wide request defaults such as headers, query parameters, retries, and timeout. + /// Dispose the HttpClient when the instance is disposed. True by default. + public AssetReferenceUsageClient( + global::System.Net.Http.HttpClient? httpClient, + global::System.Uri? baseUri, + global::System.Collections.Generic.List? authorizations, + global::Ideogram.AutoSDKClientOptions? options, + bool disposeHttpClient = true) + { + + HttpClient = httpClient ?? new global::System.Net.Http.HttpClient(); + HttpClient.BaseAddress ??= baseUri ?? new global::System.Uri(DefaultBaseUrl); + Authorizations = authorizations ?? new global::System.Collections.Generic.List(); + Options = options ?? new global::Ideogram.AutoSDKClientOptions(); + _disposeHttpClient = disposeHttpClient; + + Initialized(HttpClient); + } + + /// + public void Dispose() + { + if (_disposeHttpClient) + { + HttpClient.Dispose(); + } + } + + partial void Initialized( + global::System.Net.Http.HttpClient client); + partial void PrepareArguments( + global::System.Net.Http.HttpClient client); + partial void PrepareRequest( + global::System.Net.Http.HttpClient client, + global::System.Net.Http.HttpRequestMessage request); + partial void ProcessResponse( + global::System.Net.Http.HttpClient client, + global::System.Net.Http.HttpResponseMessage response); + partial void ProcessResponseContent( + global::System.Net.Http.HttpClient client, + global::System.Net.Http.HttpResponseMessage response, + ref string content); + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.AutoModel.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.AutoModel.JsonSerializerContext.g.cs index 1f288ec9..07754253 100644 --- a/src/libs/Ideogram/Generated/Ideogram.AutoModel.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.AutoModel.JsonSerializerContext.g.cs @@ -19,10 +19,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(byte[]))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GeneratedImageObject))] diff --git a/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.PostGenerateImageV2Auto.g.cs b/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.PostGenerateImageV2Auto.g.cs index cc26a292..09016c19 100644 --- a/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.PostGenerateImageV2Auto.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.PostGenerateImageV2Auto.g.cs @@ -44,24 +44,12 @@ partial void ProcessPostGenerateImageV2AutoResponseContent( ref string content); /// - /// Generate or transform images, letting the server pick the best model
- /// Generate one or more images without choosing a model. The server
- /// selects the model best suited to the request and may route different
- /// requests to different models.
- /// Supplying source images turns the request into a transform: the server
- /// picks a model that can edit, and the prompt describes the change to
- /// apply. Provide the sources either as `image_asset_identifiers`
- /// references (images already stored with Ideogram) or as raw `images`
- /// bytes (multipart requests only) — if both are supplied, the references
- /// win and the bytes are ignored. `negative_prompt` and
- /// `style_reference_asset_identifiers` only apply without source images;
- /// combining them with sources is rejected with a 422 rather than
- /// silently ignored.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`. + /// Generate with automatic model selection
+ /// Generate images with the model Ideogram picks as best suited to each
+ /// request. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -88,24 +76,12 @@ partial void ProcessPostGenerateImageV2AutoResponseContent( return __response.Body; } /// - /// Generate or transform images, letting the server pick the best model
- /// Generate one or more images without choosing a model. The server
- /// selects the model best suited to the request and may route different
- /// requests to different models.
- /// Supplying source images turns the request into a transform: the server
- /// picks a model that can edit, and the prompt describes the change to
- /// apply. Provide the sources either as `image_asset_identifiers`
- /// references (images already stored with Ideogram) or as raw `images`
- /// bytes (multipart requests only) — if both are supplied, the references
- /// win and the bytes are ignored. `negative_prompt` and
- /// `style_reference_asset_identifiers` only apply without source images;
- /// combining them with sources is rejected with a 422 rather than
- /// silently ignored.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`. + /// Generate with automatic model selection
+ /// Generate images with the model Ideogram picks as best suited to each
+ /// request. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -873,52 +849,40 @@ partial void ProcessPostGenerateImageV2AutoResponseContent( } } /// - /// Generate or transform images, letting the server pick the best model
- /// Generate one or more images without choosing a model. The server
- /// selects the model best suited to the request and may route different
- /// requests to different models.
- /// Supplying source images turns the request into a transform: the server
- /// picks a model that can edit, and the prompt describes the change to
- /// apply. Provide the sources either as `image_asset_identifiers`
- /// references (images already stored with Ideogram) or as raw `images`
- /// bytes (multipart requests only) — if both are supplied, the references
- /// win and the bytes are ignored. `negative_prompt` and
- /// `style_reference_asset_identifiers` only apply without source images;
- /// combining them with sources is rejected with a 422 rather than
- /// silently ignored.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`. + /// Generate with automatic model selection
+ /// Generate images with the model Ideogram picks as best suited to each
+ /// request. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the instruction describing how to transform the source images when sources are supplied. + /// The prompt to generate images from or, when source images are supplied, the change to make to them. /// /// /// Existing upload or generated image assets to transform, by reference. Takes priority over `images` if both are supplied. Supplying sources turns the request into a transform. /// /// - /// The source images to transform (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. Not every model consults it. Cannot be combined with source images. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it. Cannot be combined with source images. /// /// /// Existing upload or generated image assets whose style should guide the generation, by reference. Cannot be combined with source images. /// /// - /// The output aspect ratio. `auto` (the default) picks the most suitable ratio from the request. Without source images the value must be one of the supported ratio buckets (for example "16x9" or "1x1"); with source images any "WIDTHxHEIGHT" shape hint is accepted and the selected model serves the closest shape it supports. Omit `resolution` when supplying a non-`auto` value.
+ /// The output aspect ratio. `auto` (the default) picks the most suitable ratio for the request. Without source images the value must be a supported ratio (for example "16x9" or "1x1"); with source images any "WIDTHxHEIGHT" value is accepted and the output uses the closest supported shape. Omit `resolution` when supplying a non-`auto` value.
/// Default Value: auto /// /// /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output is served at the closest resolution the selected model supports. Omit `aspect_ratio` (or leave it `auto`) when supplying a resolution. /// /// - /// The output resolution tier. Influences which model serves the request; not every model offers every tier. When omitted the server uses the selected model's default tier. + /// The output resolution tier. Affects which model serves the request, since not every model offers every tier. When omitted, the selected model's default tier is used. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -942,7 +906,7 @@ partial void ProcessPostGenerateImageV2AutoResponseContent( /// The internal generation category to attribute to the output, as a URL-safe base64 UUID without padding. Only applies when source images are supplied. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. diff --git a/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.PostToolRemix.g.cs b/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.PostToolRemix.g.cs index 74cb4c7d..2ad688bf 100644 --- a/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.PostToolRemix.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.PostToolRemix.g.cs @@ -44,34 +44,12 @@ partial void ProcessPostToolRemixResponseContent( ref string content); /// - /// Remix an existing image, letting the server pick the best model
- /// Transform an existing image with a server-selected model, guided by a
- /// text prompt. Supply the source as `image` bytes (multipart requests
- /// only). `image_weight` controls how closely the result follows the
- /// source; when omitted the selected model chooses its usual strength.
- /// The server chooses a model that supports the requested remix controls:
- /// style references (ad hoc or saved), a color palette, style codes, a
- /// style preset, and a non-`auto` style type each
- /// restrict the request to a compatible model and to the 1K tier;
- /// remixes without those controls use the default model. Omit
- /// `resolution` and `aspect_ratio` to keep the source image's shape.
- /// Supplying `image_weight` together with a `resolution` or
- /// `aspect_ratio` that changes the source's aspect ratio routes the
- /// request to a model that crops the source to the new shape; that
- /// combination is served only at the 1K tier and is rejected at 2K.
- /// (The model-pinned remix endpoints such as
- /// `/v2/image/remix/ideogram-4` reject the combination outright.)
- /// `seed` is honored only on the compatible model; the default model
- /// synthesizes an unseeded instruction prompt, so results are not
- /// reproducible there.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with automatic model selection
+ /// Remix an image guided by a text prompt, with Ideogram choosing the
+ /// model. Upload the source image as `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -98,34 +76,12 @@ partial void ProcessPostToolRemixResponseContent( return __response.Body; } /// - /// Remix an existing image, letting the server pick the best model
- /// Transform an existing image with a server-selected model, guided by a
- /// text prompt. Supply the source as `image` bytes (multipart requests
- /// only). `image_weight` controls how closely the result follows the
- /// source; when omitted the selected model chooses its usual strength.
- /// The server chooses a model that supports the requested remix controls:
- /// style references (ad hoc or saved), a color palette, style codes, a
- /// style preset, and a non-`auto` style type each
- /// restrict the request to a compatible model and to the 1K tier;
- /// remixes without those controls use the default model. Omit
- /// `resolution` and `aspect_ratio` to keep the source image's shape.
- /// Supplying `image_weight` together with a `resolution` or
- /// `aspect_ratio` that changes the source's aspect ratio routes the
- /// request to a model that crops the source to the new shape; that
- /// combination is served only at the 1K tier and is rejected at 2K.
- /// (The model-pinned remix endpoints such as
- /// `/v2/image/remix/ideogram-4` reject the combination outright.)
- /// `seed` is honored only on the compatible model; the default model
- /// synthesizes an unseeded instruction prompt, so results are not
- /// reproducible there.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with automatic model selection
+ /// Remix an image guided by a text prompt, with Ideogram choosing the
+ /// model. Upload the source image as `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -682,20 +638,24 @@ request.Imagename is null h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -704,11 +664,12 @@ request.Imagename is null } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -778,20 +739,24 @@ request.Imagename is null h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -800,11 +765,12 @@ request.Imagename is null } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -971,34 +937,12 @@ request.Imagename is null } } /// - /// Remix an existing image, letting the server pick the best model
- /// Transform an existing image with a server-selected model, guided by a
- /// text prompt. Supply the source as `image` bytes (multipart requests
- /// only). `image_weight` controls how closely the result follows the
- /// source; when omitted the selected model chooses its usual strength.
- /// The server chooses a model that supports the requested remix controls:
- /// style references (ad hoc or saved), a color palette, style codes, a
- /// style preset, and a non-`auto` style type each
- /// restrict the request to a compatible model and to the 1K tier;
- /// remixes without those controls use the default model. Omit
- /// `resolution` and `aspect_ratio` to keep the source image's shape.
- /// Supplying `image_weight` together with a `resolution` or
- /// `aspect_ratio` that changes the source's aspect ratio routes the
- /// request to a model that crops the source to the new shape; that
- /// combination is served only at the 1K tier and is rejected at 2K.
- /// (The model-pinned remix endpoints such as
- /// `/v2/image/remix/ideogram-4` reject the combination outright.)
- /// `seed` is honored only on the compatible model; the default model
- /// synthesizes an unseeded instruction prompt, so results are not
- /// reproducible there.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with automatic model selection
+ /// Remix an image guided by a text prompt, with Ideogram choosing the
+ /// model. Upload the source image as `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1010,65 +954,65 @@ request.Imagename is null /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are staged for this generation request and are not added to your account's image assets. + /// The image to remix (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. The image is used only for this request and is not saved to your account. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are staged for this generation request and are not added to your account's image assets. + /// The image to remix (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. The image is used only for this request and is not saved to your account. /// /// - /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the selected model chooses its usual strength. Combining a weight with a `resolution` or `aspect_ratio` that changes the source's aspect ratio requires the 1K tier. + /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the selected model chooses its usual strength. Combining a weight with a `resolution` or `aspect_ratio` that changes the source's aspect ratio crops the source to the new shape; this is only available at the 1K tier and is rejected at 2K. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. Not every model consults it. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it. /// /// - /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output is served at the closest resolution the selected model supports in the corresponding 1K or 2K tier. Omit `aspect_ratio` when supplying a resolution. If `resolution_tier` is also supplied, it must match the tier implied by these dimensions. Combining a shape-changing value with `image_weight` requires the 1K tier. + /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output uses the closest supported resolution in the matching 1K or 2K tier. Omit `aspect_ratio` when supplying a resolution. If `resolution_tier` is also supplied, it must match the tier these dimensions fall in. Combining a shape-changing value with `image_weight` requires the 1K tier. /// /// /// The requested output aspect ratio. Omit it to keep the source image's shape. `auto` also keeps the source shape. Omit `resolution` when supplying a concrete value. Combining a shape-changing value with `image_weight` requires the 1K tier. /// /// - /// The output resolution tier. Influences which model serves the request. When omitted, the tier is inferred from `resolution`, or defaults to 1k when no exact resolution is supplied. Inputs that restrict the server's model choice (style references, saved styles, a color palette, style codes, a style preset, or a non-`auto` style type) currently support only 1K AUTO remixes. + /// The output resolution tier. When omitted, the tier is inferred from `resolution`, or defaults to 1k. A color palette, style codes, style preset, or non-`auto` style type are only supported at 1k. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`. The selected model decides how to interpret it.
/// Default Value: auto /// /// - /// Optional. Honored when the server selects the model that supports deterministic remixes; the default model synthesizes its own prompt, so results are not reproducible there. The response reports the seed used.
+ /// Optional. Only honored when the request uses a model that supports reproducible remixes; results from the default model are not reproducible. The response reports the seed used.
/// Example: 12345 /// /// /// Existing upload or generated image assets whose style should guide the remix, by reference. Supplying style references restricts the server to a model that supports them and requires the 1K resolution tier. Ignored if `style_reference_collection_id` is also supplied. /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers`. Restricts the server to a model that supports style references and requires the 1K resolution tier. + /// A saved style to apply, by its URL-safe base64 collection id. Limits the request to a model that supports style references and requires the 1K resolution tier. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// /// - /// A predefined style preset to apply. Restricts the server to a model that supports it and requires the 1K resolution tier. Cannot be combined with style codes or style references. + /// A predefined style preset to apply. Limits the request to a model that supports it and requires the 1K resolution tier. Cannot be combined with style codes. /// /// - /// A color palette to apply. Restricts the server to a model that supports palettes and requires the 1K resolution tier. + /// A color palette to apply. Limits the request to a model that supports palettes and requires the 1K resolution tier. /// /// /// A list of 8-character hexadecimal codes representing the style of the image. Refer to each endpoint for supported combinations with style types, presets, and reference images.
/// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// The style type to generate with. A value other than `auto` restricts the server to a model that supports it and requires the 1K resolution tier. + /// The style type to generate with. A value other than `auto` limits the request to a model that supports it and requires the 1K resolution tier. /// /// /// The number of images to generate.
/// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.g.cs index 992b3cb5..b26d720d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.AutoModelClient.g.cs @@ -6,7 +6,7 @@ namespace Ideogram /// /// Model-agnostic endpoints where the server selects the model for each
/// request. Requests are JSON and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`.
+ /// polled via `GET /v2/generations/{generation_id}`.
/// If no httpClient is provided, a new one will be created.
/// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.Design.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.Design.JsonSerializerContext.g.cs index 2549ea3d..3a329295 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Design.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Design.JsonSerializerContext.g.cs @@ -26,6 +26,9 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DetectedTextBlock))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LayerizeDesignIdeogramV3Response))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LayerizedImageObject))] @@ -41,6 +44,8 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(bool?))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(float?))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponseDataInner?), TypeInfoPropertyName = "NullableGenerationResponseDataInner2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason?), TypeInfoPropertyName = "NullableGenerationRejectReason2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed?), TypeInfoPropertyName = "NullableGenerationErrorResponseTaskCompletionSpeed2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LayerizedImageObjectObjectType?), TypeInfoPropertyName = "NullableLayerizedImageObjectObjectType2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DetectedTextBlockAlignment?), TypeInfoPropertyName = "NullableDetectedTextBlockAlignment2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DetectedTextBlockFormattingItem?), TypeInfoPropertyName = "NullableDetectedTextBlockFormattingItem2")] @@ -121,7 +126,15 @@ private sealed class LazyEnumJsonConverterFactory : global::System.Text.Json.Ser public override bool CanConvert(global::System.Type typeToConvert) { return - typeToConvert == typeof(global::Ideogram.LayerizedImageObjectObjectType) + typeToConvert == typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed) + + || typeToConvert == typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed?) + + || typeToConvert == typeof(global::Ideogram.GenerationRejectReason) + + || typeToConvert == typeof(global::Ideogram.GenerationRejectReason?) + + || typeToConvert == typeof(global::Ideogram.LayerizedImageObjectObjectType) || typeToConvert == typeof(global::Ideogram.LayerizedImageObjectObjectType?) @@ -146,6 +159,26 @@ public override bool CanConvert(global::System.Type typeToConvert) global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options) { + if (typeToConvert == typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed)) + { + return new global::Ideogram.JsonConverters.GenerationErrorResponseTaskCompletionSpeedJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed?)) + { + return new global::Ideogram.JsonConverters.GenerationErrorResponseTaskCompletionSpeedNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.GenerationRejectReason)) + { + return new global::Ideogram.JsonConverters.GenerationRejectReasonJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.GenerationRejectReason?)) + { + return new global::Ideogram.JsonConverters.GenerationRejectReasonNullableJsonConverter(); + } + if (typeToConvert == typeof(global::Ideogram.LayerizedImageObjectObjectType)) { return new global::Ideogram.JsonConverters.LayerizedImageObjectObjectTypeJsonConverter(); diff --git a/src/libs/Ideogram/Generated/Ideogram.DesignClient.PostLayerizeDesignIdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.DesignClient.PostLayerizeDesignIdeogramV3.g.cs index 10fb22d7..055252de 100644 --- a/src/libs/Ideogram/Generated/Ideogram.DesignClient.PostLayerizeDesignIdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.DesignClient.PostLayerizeDesignIdeogramV3.g.cs @@ -44,25 +44,13 @@ partial void ProcessPostLayerizeDesignIdeogramV3ResponseContent( ref string content); /// - /// Layerize the text in an image
- /// Decompose a flat image into an editable design: the text in the image
- /// is detected, erased from the image, and returned as positioned text
- /// blocks with matched fonts, sizes, and colors, alongside a text-free
- /// base image.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// A `prompt` describing the image can guide text detection; when
- /// omitted, detection runs on the image alone.
- /// By default the request blocks until layerization is complete and
- /// returns the result in `data`. Set `async` to true to return
- /// immediately after the request is accepted, then poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Layerize text with Ideogram 3.0
+ /// Turn a flat image into an editable design: detected text is returned as
+ /// positioned text blocks with matched fonts, sizes, and colors, alongside
+ /// a text-free base image. Upload the image as `image` using
+ /// `multipart/form-data`. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -89,25 +77,13 @@ partial void ProcessPostLayerizeDesignIdeogramV3ResponseContent( return __response.Body; } /// - /// Layerize the text in an image
- /// Decompose a flat image into an editable design: the text in the image
- /// is detected, erased from the image, and returned as positioned text
- /// blocks with matched fonts, sizes, and colors, alongside a text-free
- /// base image.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// A `prompt` describing the image can guide text detection; when
- /// omitted, detection runs on the image alone.
- /// By default the request blocks until layerization is complete and
- /// returns the result in `data`. Set `async` to true to return
- /// immediately after the request is accepted, then poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Layerize text with Ideogram 3.0
+ /// Turn a flat image into an editable design: detected text is returned as
+ /// positioned text blocks with matched fonts, sizes, and colors, alongside
+ /// a text-free base image. Upload the image as `image` using
+ /// `multipart/form-data`. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -566,20 +542,24 @@ request.Imagename is null h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -588,11 +568,12 @@ request.Imagename is null } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -662,20 +643,24 @@ request.Imagename is null h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -684,11 +669,12 @@ request.Imagename is null } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -855,25 +841,13 @@ request.Imagename is null } } /// - /// Layerize the text in an image
- /// Decompose a flat image into an editable design: the text in the image
- /// is detected, erased from the image, and returned as positioned text
- /// blocks with matched fonts, sizes, and colors, alongside a text-free
- /// base image.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// A `prompt` describing the image can guide text detection; when
- /// omitted, detection runs on the image alone.
- /// By default the request blocks until layerization is complete and
- /// returns the result in `data`. Set `async` to true to return
- /// immediately after the request is accepted, then poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Layerize text with Ideogram 3.0
+ /// Turn a flat image into an editable design: detected text is returned as
+ /// positioned text blocks with matched fonts, sizes, and colors, alongside
+ /// a text-free base image. Upload the image as `image` using
+ /// `multipart/form-data`. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -883,10 +857,10 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to layerize (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// The source image to layerize (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// /// A description of the image, used to guide text detection. When omitted, detection runs on the image alone. @@ -899,7 +873,7 @@ request.Imagename is null /// Candidate font files to make available for text style matching. Supported formats .ttf, .otf, .woff, .woff2 (max 5MB each, maximum 5 files). Multipart requests only. /// /// - /// When false (the default), the request blocks until layerization is complete and returns the result in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until layerization is complete and returns the result in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflow.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflow.JsonSerializerContext.g.cs index d88e2bb5..5193c991 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflow.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflow.JsonSerializerContext.g.cs @@ -19,10 +19,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(byte[]))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ReplaceBackgroundResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ReplaceBackgroundRequest))] diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdLocalizer.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdLocalizer.g.cs index 213c65f5..6b8a18b2 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdLocalizer.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdLocalizer.g.cs @@ -44,25 +44,13 @@ partial void ProcessPostAdLocalizerResponseContent( ref string content); /// - /// Rebuild an advertisement in another language
- /// Rebuilds the source advertisement for one target language. Layout,
- /// logos, brand type, and the product are preserved; the visible marketing
- /// copy is what changes.
- /// Without `exact_copy` the copy is translated. Supply `exact_copy` to
- /// place wording that has already been approved, character for character,
- /// instead of translating it.
- /// The output keeps the source advertisement's own shape and is generated
- /// at a frame derived from it, so neither the shape nor the size is asked
- /// for.
- /// One request localizes into one language. Localize into several languages
- /// by submitting one request per language.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source advertisement as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Localizer
+ /// Rebuilds an ad in one target language, preserving its layout, logos,
+ /// brand type, and product so only the visible marketing copy changes.
+ /// Upload the source ad as `image` using `multipart/form-data`; the copy
+ /// is translated unless you supply `exact_copy`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -89,25 +77,13 @@ partial void ProcessPostAdLocalizerResponseContent( return __response.Body; } /// - /// Rebuild an advertisement in another language
- /// Rebuilds the source advertisement for one target language. Layout,
- /// logos, brand type, and the product are preserved; the visible marketing
- /// copy is what changes.
- /// Without `exact_copy` the copy is translated. Supply `exact_copy` to
- /// place wording that has already been approved, character for character,
- /// instead of translating it.
- /// The output keeps the source advertisement's own shape and is generated
- /// at a frame derived from it, so neither the shape nor the size is asked
- /// for.
- /// One request localizes into one language. Localize into several languages
- /// by submitting one request per language.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source advertisement as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Localizer
+ /// Rebuilds an ad in one target language, preserving its layout, logos,
+ /// brand type, and product so only the visible marketing copy changes.
+ /// Upload the source ad as `image` using `multipart/form-data`; the copy
+ /// is translated unless you supply `exact_copy`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -835,25 +811,13 @@ request.Imagename is null } } /// - /// Rebuild an advertisement in another language
- /// Rebuilds the source advertisement for one target language. Layout,
- /// logos, brand type, and the product are preserved; the visible marketing
- /// copy is what changes.
- /// Without `exact_copy` the copy is translated. Supply `exact_copy` to
- /// place wording that has already been approved, character for character,
- /// instead of translating it.
- /// The output keeps the source advertisement's own shape and is generated
- /// at a frame derived from it, so neither the shape nor the size is asked
- /// for.
- /// One request localizes into one language. Localize into several languages
- /// by submitting one request per language.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source advertisement as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Localizer
+ /// Rebuilds an ad in one target language, preserving its layout, logos,
+ /// brand type, and product so only the visible marketing copy changes.
+ /// Upload the source ad as `image` using `multipart/form-data`; the copy
+ /// is translated unless you supply `exact_copy`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -863,23 +827,25 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source advertisement to localize (max size 25MB), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Multipart requests
- /// only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source ad to localize (max size 25MB). Its layout, logos, brand
+ /// type, and product are preserved, and the output keeps its shape, so
+ /// no size or aspect ratio is needed. JPEG, PNG, and WEBP formats are
+ /// supported. Multipart requests only. /// /// - /// The source advertisement to localize (max size 25MB), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Multipart requests
- /// only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source ad to localize (max size 25MB). Its layout, logos, brand
+ /// type, and product are preserved, and the output keeps its shape, so
+ /// no size or aspect ratio is needed. JPEG, PNG, and WEBP formats are
+ /// supported. Multipart requests only. /// /// - /// The target language the copy is rebuilt in. Arabic is rendered right-to-left. + /// The target language for the copy. Arabic is rendered right-to-left. Each request covers one language; send one request per language. /// /// /// Pre-approved wording, one `original => replacement` mapping per line. Each mapping names the text element showing `original` and sets it to `replacement`, placed character for character rather than translated. Any text element not listed is left as it is in the source. When omitted, all visible marketing copy is translated. /// /// - /// Optional additional direction for the localization, for example "keep the badge in English". It takes priority over the preservation rules for anything it explicitly asks to change. + /// Optional additional direction for the localization, for example "keep the badge in English". Anything it explicitly asks to change takes priority over the preservation rules. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdResizer.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdResizer.g.cs index 260dcd21..ec6c96f7 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdResizer.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdResizer.g.cs @@ -44,39 +44,13 @@ partial void ProcessPostAdResizerResponseContent( ref string content); /// - /// Advertisement Resizer v2
- /// Reframes the source creative to the exact requested ad resolution,
- /// regenerating the layout so text and key elements stay legible at the
- /// target size.
- /// Supply `platform` to keep the whole advertisement clear of that
- /// platform's own interface. The advertisement is generated at the largest
- /// rectangle that fits inside the platform's published safe zone for the
- /// requested aspect ratio, placed at that rectangle's position, and the
- /// space around it is filled in so the returned image is still exactly the
- /// requested resolution. Omit `platform` and the advertisement fills the
- /// whole frame.
- /// Each platform accepts only the resolutions for which it publishes a
- /// safe zone:
- /// | Platform | Accepted resolutions |
- /// | --- | --- |
- /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `meta_stories` | `1080x1920`, `2160x3840` |
- /// | `meta_reels` | `1080x1920`, `2160x3840` |
- /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
- /// | `snapchat` | `1080x1920`, `2160x3840` |
- /// A `platform` combined with any other `resolution` is rejected with a
- /// 400. When `platform` is omitted, every resolution in the request schema
- /// is accepted.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Resizer
+ /// Reframes an ad creative to an exact ad resolution, regenerating the
+ /// layout so text and key elements stay legible at the new size. Upload
+ /// the source creative as `image` using `multipart/form-data`, and supply
+ /// `platform` to keep the ad inside that platform's safe zone.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -103,39 +77,13 @@ partial void ProcessPostAdResizerResponseContent( return __response.Body; } /// - /// Advertisement Resizer v2
- /// Reframes the source creative to the exact requested ad resolution,
- /// regenerating the layout so text and key elements stay legible at the
- /// target size.
- /// Supply `platform` to keep the whole advertisement clear of that
- /// platform's own interface. The advertisement is generated at the largest
- /// rectangle that fits inside the platform's published safe zone for the
- /// requested aspect ratio, placed at that rectangle's position, and the
- /// space around it is filled in so the returned image is still exactly the
- /// requested resolution. Omit `platform` and the advertisement fills the
- /// whole frame.
- /// Each platform accepts only the resolutions for which it publishes a
- /// safe zone:
- /// | Platform | Accepted resolutions |
- /// | --- | --- |
- /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `meta_stories` | `1080x1920`, `2160x3840` |
- /// | `meta_reels` | `1080x1920`, `2160x3840` |
- /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
- /// | `snapchat` | `1080x1920`, `2160x3840` |
- /// A `platform` combined with any other `resolution` is rejected with a
- /// 400. When `platform` is omitted, every resolution in the request schema
- /// is accepted.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Resizer
+ /// Reframes an ad creative to an exact ad resolution, regenerating the
+ /// layout so text and key elements stay legible at the new size. Upload
+ /// the source creative as `image` using `multipart/form-data`, and supply
+ /// `platform` to keep the ad inside that platform's safe zone.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -855,39 +803,13 @@ request.Imagename is null } } /// - /// Advertisement Resizer v2
- /// Reframes the source creative to the exact requested ad resolution,
- /// regenerating the layout so text and key elements stay legible at the
- /// target size.
- /// Supply `platform` to keep the whole advertisement clear of that
- /// platform's own interface. The advertisement is generated at the largest
- /// rectangle that fits inside the platform's published safe zone for the
- /// requested aspect ratio, placed at that rectangle's position, and the
- /// space around it is filled in so the returned image is still exactly the
- /// requested resolution. Omit `platform` and the advertisement fills the
- /// whole frame.
- /// Each platform accepts only the resolutions for which it publishes a
- /// safe zone:
- /// | Platform | Accepted resolutions |
- /// | --- | --- |
- /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `meta_stories` | `1080x1920`, `2160x3840` |
- /// | `meta_reels` | `1080x1920`, `2160x3840` |
- /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
- /// | `snapchat` | `1080x1920`, `2160x3840` |
- /// A `platform` combined with any other `resolution` is rejected with a
- /// 400. When `platform` is omitted, every resolution in the request schema
- /// is accepted.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Resizer
+ /// Reframes an ad creative to an exact ad resolution, regenerating the
+ /// layout so text and key elements stay legible at the new size. Upload
+ /// the source creative as `image` using `multipart/form-data`, and supply
+ /// `platform` to keep the ad inside that platform's safe zone.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -897,33 +819,40 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source creative to reframe (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to reframe (max size 25MB). JPEG, PNG, and
+ /// WEBP formats are supported. Multipart requests only. /// /// - /// The source creative to reframe (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to reframe (max size 25MB). JPEG, PNG, and
+ /// WEBP formats are supported. Multipart requests only. /// /// - /// Target ad resolution, formatted as `WIDTHxHEIGHT`. Must be one of
- /// the supported ad resolutions listed above; any other value is
- /// rejected with a 400. Each returned image has exactly these pixel
- /// dimensions, whether or not a `platform` was supplied. + /// Target ad resolution, formatted as `WIDTHxHEIGHT`. Any value not in
+ /// the list is rejected with a 400. Each output image has exactly these
+ /// pixel dimensions, with or without a `platform`. /// /// - /// The ad platform whose published safe zone the advertisement must
- /// stay inside. `google` covers YouTube and Google Ads placements;
- /// use `meta_stories` or `meta_reels` for the placement-specific Meta
- /// generation bounds. Reels uses the largest rectangle contained by
- /// its notched safe-zone polygon. The legacy `meta` value remains
- /// supported for existing callers with its conservative safe zone.
- /// When supplied, the advertisement is generated inside that
- /// platform's safe zone for the requested aspect ratio and the
- /// remaining space is filled in around it. When omitted, the
- /// advertisement fills the whole frame. Any other value is rejected
- /// with a 400. + /// The ad platform whose published safe zone the ad must stay inside.
+ /// The ad is generated inside the largest rectangle that fits the
+ /// platform's safe zone for the requested aspect ratio, and the space
+ /// around it is filled in so the output is still exactly the requested
+ /// `resolution`. `google` covers YouTube and Google Ads placements.
+ /// Use `meta_stories` or `meta_reels` for Meta placements; Reels uses
+ /// the largest rectangle inside its notched safe zone. The legacy
+ /// `meta` value is still supported and uses a more conservative safe
+ /// zone. When omitted, the ad fills the whole frame and every
+ /// supported `resolution` is accepted. Any other value is rejected
+ /// with a 400.
+ /// Each platform accepts only the resolutions for which it publishes a
+ /// safe zone; any other `resolution` is rejected with a 400:
+ /// | Platform | Accepted resolutions |
+ /// | --- | --- |
+ /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
+ /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
+ /// | `meta_stories` | `1080x1920`, `2160x3840` |
+ /// | `meta_reels` | `1080x1920`, `2160x3840` |
+ /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
+ /// | `snapchat` | `1080x1920`, `2160x3840` | /// /// /// Optional edit instruction to apply while reframing, for example "remove the logo" or "put the price bottom-right". diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdVariations.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdVariations.g.cs index c145ae78..e2601836 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdVariations.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostAdVariations.g.cs @@ -42,23 +42,13 @@ partial void ProcessPostAdVariationsResponseContent( ref string content); /// - /// Advertisement Variations
- /// Generates a brand-locked creative variation of the source ad along the
- /// requested variation axis: different people, a different setting, a
- /// different group size, or a different scene. Logos, brand colors, the
- /// product, and all on-image text are preserved; only the requested axis
- /// changes.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Each returned image is generated at the source creative's own aspect
- /// ratio (the long side to short side ratio is capped at 3:1).
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Variations
+ /// Creates on-brand variations of an ad along one axis, preserving logos,
+ /// brand colors, the product, and all on-image text. Upload the source
+ /// creative as `image` using `multipart/form-data` and choose a
+ /// `variation_type`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -80,23 +70,13 @@ partial void ProcessPostAdVariationsResponseContent( return __response.Body; } /// - /// Advertisement Variations
- /// Generates a brand-locked creative variation of the source ad along the
- /// requested variation axis: different people, a different setting, a
- /// different group size, or a different scene. Logos, brand colors, the
- /// product, and all on-image text are preserved; only the requested axis
- /// changes.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Each returned image is generated at the source creative's own aspect
- /// ratio (the long side to short side ratio is capped at 3:1).
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Variations
+ /// Creates on-brand variations of an ad along one axis, preserving logos,
+ /// brand colors, the product, and all on-image text. Upload the source
+ /// creative as `image` using `multipart/form-data` and choose a
+ /// `variation_type`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -791,47 +771,39 @@ request.Imagename is null } } /// - /// Advertisement Variations
- /// Generates a brand-locked creative variation of the source ad along the
- /// requested variation axis: different people, a different setting, a
- /// different group size, or a different scene. Logos, brand colors, the
- /// product, and all on-image text are preserved; only the requested axis
- /// changes.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Each returned image is generated at the source creative's own aspect
- /// ratio (the long side to short side ratio is capped at 3:1).
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Variations
+ /// Creates on-brand variations of an ad along one axis, preserving logos,
+ /// brand colors, the product, and all on-image text. Upload the source
+ /// creative as `image` using `multipart/form-data` and choose a
+ /// `variation_type`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source creative to vary (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to vary (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. Multipart requests only. Each output keeps
+ /// the source's aspect ratio, capped at 3:1 between the long and short
+ /// sides. /// /// - /// The source creative to vary (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to vary (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. Multipart requests only. Each output keeps
+ /// the source's aspect ratio, capped at 3:1 between the long and short
+ /// sides. /// /// - /// The axis to vary while everything else stays on-brand. `people`
+ /// The axis to vary. `people`
/// replaces the people in the ad with different talent. `setting`
/// moves the same subject and product to a different environment.
/// `group_size` changes how many people appear. `scene` shifts the
/// moment or occasion (time of day, season, or activity). /// /// - /// Optional direction to steer the variation, for example "set it on a beach" or "make the models older". Takes priority over the default preservation rules for anything it explicitly asks to change. + /// Optional direction to steer the variation, for example "set it on a beach" or "make the models older". Anything it explicitly asks to change takes priority over the default preservation rules. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostColorways.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostColorways.g.cs index a09644aa..313e63c8 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostColorways.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostColorways.g.cs @@ -44,23 +44,13 @@ partial void ProcessPostColorwaysResponseContent( ref string content); /// - /// Product Color Change
- /// Recolors the masked regions of the product photo, each to its own
- /// target color, while preserving the product's geometry, materials,
- /// prints, logos, and shading, and keeping every region outside the
- /// masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo as raw `image` bytes via
- /// `multipart/form-data`.
- /// Supply the masks marking the regions to recolor as raw `masks` bytes,
- /// paired by position with `colors` — up to 4 regions; a single-region
- /// edit is a one-item list. Every mask must have the same pixel
- /// dimensions as the product photo. White pixels mark the region to
- /// recolor; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to recolor and transparent
- /// pixels are preserved. + /// Colorways
+ /// Recolors masked regions of a product photo, each to its own target
+ /// color, preserving the product's geometry, materials, prints, logos, and
+ /// everything outside the masks. Upload the `image` and up to 4 `masks`
+ /// using `multipart/form-data`, with one entry in `colors` per mask.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -87,23 +77,13 @@ partial void ProcessPostColorwaysResponseContent( return __response.Body; } /// - /// Product Color Change
- /// Recolors the masked regions of the product photo, each to its own
- /// target color, while preserving the product's geometry, materials,
- /// prints, logos, and shading, and keeping every region outside the
- /// masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo as raw `image` bytes via
- /// `multipart/form-data`.
- /// Supply the masks marking the regions to recolor as raw `masks` bytes,
- /// paired by position with `colors` — up to 4 regions; a single-region
- /// edit is a one-item list. Every mask must have the same pixel
- /// dimensions as the product photo. White pixels mark the region to
- /// recolor; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to recolor and transparent
- /// pixels are preserved. + /// Colorways
+ /// Recolors masked regions of a product photo, each to its own target
+ /// color, preserving the product's geometry, materials, prints, logos, and
+ /// everything outside the masks. Upload the `image` and up to 4 `masks`
+ /// using `multipart/form-data`, with one entry in `colors` per mask.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -769,23 +749,13 @@ request.Imagename is null } } /// - /// Product Color Change
- /// Recolors the masked regions of the product photo, each to its own
- /// target color, while preserving the product's geometry, materials,
- /// prints, logos, and shading, and keeping every region outside the
- /// masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo as raw `image` bytes via
- /// `multipart/form-data`.
- /// Supply the masks marking the regions to recolor as raw `masks` bytes,
- /// paired by position with `colors` — up to 4 regions; a single-region
- /// edit is a one-item list. Every mask must have the same pixel
- /// dimensions as the product photo. White pixels mark the region to
- /// recolor; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to recolor and transparent
- /// pixels are preserved. + /// Colorways
+ /// Recolors masked regions of a product photo, each to its own target
+ /// color, preserving the product's geometry, materials, prints, logos, and
+ /// everything outside the masks. Upload the `image` and up to 4 `masks`
+ /// using `multipart/form-data`, with one entry in `colors` per mask.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -796,12 +766,12 @@ request.Imagename is null /// `image_asset_identifier` or `image`. /// /// - /// The product photo to recolor (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to recolor (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// - /// The product photo to recolor (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to recolor (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// /// The masks marking the regions of the product photo to recolor, by
@@ -813,13 +783,12 @@ request.Imagename is null /// exactly one of `mask_asset_identifiers` or `masks`. /// /// - /// The masks marking the regions of the product photo to recolor
- /// (max 4, max size 25MB each), as raw bytes, paired by position with
- /// `colors`; only JPEG, PNG, and WEBP formats are supported. Every
- /// mask must have the same pixel dimensions as the product photo.
- /// White pixels mark the region to recolor; black pixels are
- /// preserved. Alpha-only masks are also supported: opaque pixels
- /// mark the region to recolor and transparent pixels are preserved. + /// Masks marking the regions to recolor (max 4, max size 25MB each),
+ /// paired by position with `colors`. JPEG, PNG, and WEBP formats are
+ /// supported. Every mask must have the same pixel dimensions as the
+ /// product photo. White pixels mark the region to recolor and black
+ /// pixels are preserved; alpha-only masks also work (opaque =
+ /// recolor, transparent = preserve). /// /// /// One target color per mask in `masks`, as six-digit hex codes like
@@ -827,12 +796,11 @@ request.Imagename is null /// materials, prints, and logos are always preserved. /// /// - /// The aspect ratio of the generated image. Defaults to the aspect
- /// ratio of the product photo when omitted, which preserves the
- /// original framing exactly. When a different ratio is requested, the
- /// scene is extended to fill the new shape rather than cropped, so
- /// part of the frame is newly generated. Supported values are `1:1`,
- /// `3:4`, `4:3`, `16:9`, and `9:16`. + /// Output aspect ratio. Defaults to the product photo's aspect ratio,
+ /// which keeps the original framing. A different ratio extends the
+ /// scene to fill the new shape rather than cropping, so part of the
+ /// frame is newly generated. Supported values are `1:1`, `3:4`,
+ /// `4:3`, `16:9`, and `9:16`. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostGhostMannequin.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostGhostMannequin.g.cs index 67665ddc..fc271970 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostGhostMannequin.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostGhostMannequin.g.cs @@ -44,19 +44,14 @@ partial void ProcessPostGhostMannequinResponseContent( ref string content); /// - /// Create ghost-mannequin garment photography
- /// Transforms one or more photographs of the same garment into a polished
- /// ghost-mannequin product image on a clean white studio background. The
- /// garment keeps its identity and construction while the source person,
- /// mannequin, hanger, environment, and other clothing are removed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply one or more garment references. Use the directional fields when
- /// the camera direction is known; each direction accepts either an
- /// existing `AssetIdentifier` or one raw image, but not both. Additional
- /// unlabeled references can be supplied through exactly one transport:
- /// `garment_asset_identifiers`, or multipart `garment_images`. + /// Ghost Mannequin
+ /// Turns photos of one garment into a ghost-mannequin product image on a
+ /// clean white studio background, removing the person, mannequin, hanger,
+ /// and other clothing. Upload the photos using `multipart/form-data`, in
+ /// the directional fields (such as `front_image`) when the camera
+ /// direction is known and in `garment_images` otherwise.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -83,19 +78,14 @@ partial void ProcessPostGhostMannequinResponseContent( return __response.Body; } /// - /// Create ghost-mannequin garment photography
- /// Transforms one or more photographs of the same garment into a polished
- /// ghost-mannequin product image on a clean white studio background. The
- /// garment keeps its identity and construction while the source person,
- /// mannequin, hanger, environment, and other clothing are removed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply one or more garment references. Use the directional fields when
- /// the camera direction is known; each direction accepts either an
- /// existing `AssetIdentifier` or one raw image, but not both. Additional
- /// unlabeled references can be supplied through exactly one transport:
- /// `garment_asset_identifiers`, or multipart `garment_images`. + /// Ghost Mannequin
+ /// Turns photos of one garment into a ghost-mannequin product image on a
+ /// clean white studio background, removing the person, mannequin, hanger,
+ /// and other clothing. Upload the photos using `multipart/form-data`, in
+ /// the directional fields (such as `front_image`) when the camera
+ /// direction is known and in `garment_images` otherwise.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -1131,19 +1121,14 @@ request.BottomImagename is null } } /// - /// Create ghost-mannequin garment photography
- /// Transforms one or more photographs of the same garment into a polished
- /// ghost-mannequin product image on a clean white studio background. The
- /// garment keeps its identity and construction while the source person,
- /// mannequin, hanger, environment, and other clothing are removed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply one or more garment references. Use the directional fields when
- /// the camera direction is known; each direction accepts either an
- /// existing `AssetIdentifier` or one raw image, but not both. Additional
- /// unlabeled references can be supplied through exactly one transport:
- /// `garment_asset_identifiers`, or multipart `garment_images`. + /// Ghost Mannequin
+ /// Turns photos of one garment into a ghost-mannequin product image on a
+ /// clean white studio background, removing the person, mannequin, hanger,
+ /// and other clothing. Upload the photos using `multipart/form-data`, in
+ /// the directional fields (such as `front_image`) when the camera
+ /// direction is known and in `garment_images` otherwise.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -1155,98 +1140,95 @@ request.BottomImagename is null /// `garment_images`. /// /// - /// Raw images of the same garment, up to 50 MB each. JPEG, PNG, WEBP,
- /// HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart
- /// requests only. Mutually exclusive with
- /// `garment_asset_identifiers`. + /// Additional photos of the same garment, up to 50 MB each. JPEG,
+ /// PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported.
+ /// Multipart requests only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw front-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `front_asset_identifier`. + /// Optional front-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw front-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `front_asset_identifier`. + /// Optional front-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw back-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `back_asset_identifier`. + /// Optional back-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw back-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `back_asset_identifier`. + /// Optional back-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw left-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `left_asset_identifier`. + /// Optional left-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw left-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `left_asset_identifier`. + /// Optional left-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw right-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `right_asset_identifier`. + /// Optional right-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw right-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `right_asset_identifier`. + /// Optional right-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw top-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `top_asset_identifier`. + /// Optional top-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw top-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `top_asset_identifier`. + /// Optional top-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw bottom-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with
- /// `bottom_asset_identifier`. + /// Optional bottom-view garment photo, up to 50 MB. Multipart
+ /// requests only. /// /// - /// Optional raw bottom-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with
- /// `bottom_asset_identifier`. + /// Optional bottom-view garment photo, up to 50 MB. Multipart
+ /// requests only. /// /// /// Camera view for the output garment. /// /// /// Optional reconstruction guidance or identity-critical garment
- /// details for the analyzer to verify. The output always uses the
- /// workflow's clean white studio presentation. + /// details to check against the photos. The output always uses a clean
+ /// white studio background. /// /// /// Optional JSON object serialized as a string containing factual
/// product context, such as title, brand, category, color, material,
/// item code, and exact printed text. Metadata helps disambiguate the
- /// garment references but does not add unsupported visual features. + /// garment photos but does not add features they do not show. /// /// /// Output aspect ratio. Defaults to `1:1` when omitted. Supported
diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostLookbook.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostLookbook.g.cs index 907ea9b0..9186febf 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostLookbook.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostLookbook.g.cs @@ -47,7 +47,7 @@ partial void ProcessPostLookbookResponseContent( /// references and an aesthetic reference. Each generated shoot is returned
/// as four individual lookbook images.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. /// /// @@ -75,7 +75,7 @@ partial void ProcessPostLookbookResponseContent( /// references and an aesthetic reference. Each generated shoot is returned
/// as four individual lookbook images.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. /// /// @@ -619,7 +619,7 @@ partial void ProcessPostLookbookResponseContent( /// references and an aesthetic reference. Each generated shoot is returned
/// as four individual lookbook images.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostMaterialSwap.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostMaterialSwap.g.cs index d6c252e6..80544539 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostMaterialSwap.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostMaterialSwap.g.cs @@ -44,24 +44,13 @@ partial void ProcessPostMaterialSwapResponseContent( ref string content); /// - /// Product Material Change
- /// Re-renders the masked regions of the product photo in the materials
- /// shown by the reference images — matching each one's color, texture,
- /// pattern scale, and orientation — while preserving the product's
- /// silhouette, construction, seams, and shading, and keeping every region
- /// outside the masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo, the masks marking the regions to
- /// re-material, and the material reference images as raw bytes (`image`,
- /// `masks`, and `materials`) via `multipart/form-data` — up to 4 masks; a
- /// single-region edit is a one-item list. Every mask must have the same
- /// pixel dimensions as the product photo. White pixels mark the region to
- /// change; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to change and transparent
- /// pixels are preserved. Send either one material, which every mask
- /// takes, or exactly one material per mask, paired by position. + /// Material Swap
+ /// Re-renders masked regions of a product photo in the materials shown in
+ /// reference images, preserving the product's construction and everything
+ /// outside the masks. Upload the `image`, up to 4 `masks`, and the
+ /// `materials` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -88,24 +77,13 @@ partial void ProcessPostMaterialSwapResponseContent( return __response.Body; } /// - /// Product Material Change
- /// Re-renders the masked regions of the product photo in the materials
- /// shown by the reference images — matching each one's color, texture,
- /// pattern scale, and orientation — while preserving the product's
- /// silhouette, construction, seams, and shading, and keeping every region
- /// outside the masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo, the masks marking the regions to
- /// re-material, and the material reference images as raw bytes (`image`,
- /// `masks`, and `materials`) via `multipart/form-data` — up to 4 masks; a
- /// single-region edit is a one-item list. Every mask must have the same
- /// pixel dimensions as the product photo. White pixels mark the region to
- /// change; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to change and transparent
- /// pixels are preserved. Send either one material, which every mask
- /// takes, or exactly one material per mask, paired by position. + /// Material Swap
+ /// Re-renders masked regions of a product photo in the materials shown in
+ /// reference images, preserving the product's construction and everything
+ /// outside the masks. Upload the `image`, up to 4 `masks`, and the
+ /// `materials` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -793,24 +771,13 @@ request.Imagename is null } } /// - /// Product Material Change
- /// Re-renders the masked regions of the product photo in the materials
- /// shown by the reference images — matching each one's color, texture,
- /// pattern scale, and orientation — while preserving the product's
- /// silhouette, construction, seams, and shading, and keeping every region
- /// outside the masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo, the masks marking the regions to
- /// re-material, and the material reference images as raw bytes (`image`,
- /// `masks`, and `materials`) via `multipart/form-data` — up to 4 masks; a
- /// single-region edit is a one-item list. Every mask must have the same
- /// pixel dimensions as the product photo. White pixels mark the region to
- /// change; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to change and transparent
- /// pixels are preserved. Send either one material, which every mask
- /// takes, or exactly one material per mask, paired by position. + /// Material Swap
+ /// Re-renders masked regions of a product photo in the materials shown in
+ /// reference images, preserving the product's construction and everything
+ /// outside the masks. Upload the `image`, up to 4 `masks`, and the
+ /// `materials` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -821,12 +788,12 @@ request.Imagename is null /// `image_asset_identifier` or `image`. /// /// - /// The product photo to edit (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to edit (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// - /// The product photo to edit (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to edit (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// /// The masks marking the regions of the product photo to change, by
@@ -838,13 +805,11 @@ request.Imagename is null /// `masks`. /// /// - /// The masks marking the regions of the product photo to change (max
- /// 4, max size 25MB each), as raw bytes; only JPEG, PNG, and WEBP
- /// formats are supported. Every mask must have the same pixel
- /// dimensions as the product photo. White pixels mark the region to
- /// change; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to change and transparent
- /// pixels are preserved. + /// Masks marking the regions to change (max 4, max size 25MB each).
+ /// JPEG, PNG, and WEBP formats are supported. Every mask must have the
+ /// same pixel dimensions as the product photo. White pixels mark the
+ /// region to change and black pixels are preserved; alpha-only masks
+ /// also work (opaque = change, transparent = preserve). /// /// /// The material reference images, by reference. Only their material —
@@ -854,19 +819,18 @@ request.Imagename is null /// `material_asset_identifiers` or `materials`. /// /// - /// The material reference images (max size 25MB each), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Only their material
- /// — color, texture, pattern scale, and orientation — is applied to
- /// the masked regions. Send one material, which every mask takes, or
- /// exactly one per mask paired by position. + /// Material reference images (max size 25MB each). JPEG, PNG, and WEBP
+ /// formats are supported. Only their material (color, texture, pattern
+ /// scale, and orientation) is applied to the masked regions. Send one
+ /// material for every mask, or exactly one per mask, paired by
+ /// position. /// /// - /// The aspect ratio of the generated image. Defaults to the aspect
- /// ratio of the product photo when omitted, which preserves the
- /// original framing exactly. When a different ratio is requested, the
- /// scene is extended to fill the new shape rather than cropped, so
- /// part of the frame is newly generated. Supported values are `1:1`,
- /// `3:4`, `4:3`, `16:9`, and `9:16`. + /// Output aspect ratio. Defaults to the product photo's aspect ratio,
+ /// which keeps the original framing. A different ratio extends the
+ /// scene to fill the new shape rather than cropping, so part of the
+ /// frame is newly generated. Supported values are `1:1`, `3:4`,
+ /// `4:3`, `16:9`, and `9:16`. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostModelPoseVariants.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostModelPoseVariants.g.cs index 58a5a4bb..6a9d242c 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostModelPoseVariants.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostModelPoseVariants.g.cs @@ -42,18 +42,13 @@ partial void ProcessPostModelPoseVariantsResponseContent( ref string content); /// - /// Generate pose variants of a fashion image
- /// Changes the model's pose or camera presentation while preserving the
- /// source model, garment, styling, and scene. An optional pose-reference
- /// image supplies body pose and gaze only; it does not supply identity,
- /// clothing, or styling.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source as either an `AssetIdentifier` reference
- /// (`source_asset_identifier`) or raw image bytes (`source_image`,
- /// multipart requests only). Provide exactly one source form; supplying
- /// both, or neither, is rejected with a 400. + /// Model Pose Variants
+ /// Changes the model's pose or camera angle in a fashion image while
+ /// preserving the model, garment, styling, and scene. Upload the
+ /// `source_image` using `multipart/form-data` and describe the new pose in
+ /// `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -75,18 +70,13 @@ partial void ProcessPostModelPoseVariantsResponseContent( return __response.Body; } /// - /// Generate pose variants of a fashion image
- /// Changes the model's pose or camera presentation while preserving the
- /// source model, garment, styling, and scene. An optional pose-reference
- /// image supplies body pose and gaze only; it does not supply identity,
- /// clothing, or styling.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source as either an `AssetIdentifier` reference
- /// (`source_asset_identifier`) or raw image bytes (`source_image`,
- /// multipart requests only). Provide exactly one source form; supplying
- /// both, or neither, is rejected with a 400. + /// Model Pose Variants
+ /// Changes the model's pose or camera angle in a fashion image while
+ /// preserving the model, garment, styling, and scene. Upload the
+ /// `source_image` using `multipart/form-data` and describe the new pose in
+ /// `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -797,42 +787,35 @@ request.SourceImagename is null } } /// - /// Generate pose variants of a fashion image
- /// Changes the model's pose or camera presentation while preserving the
- /// source model, garment, styling, and scene. An optional pose-reference
- /// image supplies body pose and gaze only; it does not supply identity,
- /// clothing, or styling.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source as either an `AssetIdentifier` reference
- /// (`source_asset_identifier`) or raw image bytes (`source_image`,
- /// multipart requests only). Provide exactly one source form; supplying
- /// both, or neither, is rejected with a 400. + /// Model Pose Variants
+ /// Changes the model's pose or camera angle in a fashion image while
+ /// preserving the model, garment, styling, and scene. Upload the
+ /// `source_image` using `multipart/form-data` and describe the new pose in
+ /// `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Fashion image to edit (max size 50MB), as raw bytes. JPEG, PNG,
- /// WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported.
- /// Multipart requests only. Provide exactly one of
- /// `source_asset_identifier` or `source_image`. + /// Fashion image to edit (max size 50MB). JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart
+ /// requests only. /// /// - /// Fashion image to edit (max size 50MB), as raw bytes. JPEG, PNG,
- /// WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported.
- /// Multipart requests only. Provide exactly one of
- /// `source_asset_identifier` or `source_image`. + /// Fashion image to edit (max size 50MB). JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart
+ /// requests only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Required plain-language pose or camera direction, such as a
- /// front-facing catalog stance or right-facing walking profile. + /// Plain-language pose or camera direction, such as a front-facing
+ /// catalog stance or right-facing walking profile. /// /// /// Output aspect ratio. When omitted, the nearest supported ratio is
diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostModelSwap.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostModelSwap.g.cs index a04c41cc..a13c3519 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostModelSwap.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostModelSwap.g.cs @@ -42,16 +42,13 @@ partial void ProcessPostModelSwapResponseContent( ref string content); /// - /// Replace the model in a commerce image
- /// Re-casts a fashion commerce image with the identity shown in one or
- /// more ordered target-model references. The workflow uses the working
- /// image for the product, pose, scene, lighting, framing, and camera, and
- /// uses the target references only for identity, hair, skin tone, and body
- /// proportions. Results are full-frame edits; exact pixel preservation is
- /// not guaranteed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. + /// Model Swap
+ /// Replaces the model in a fashion image with the person shown in one to
+ /// four target-model references, keeping the product, pose, scene,
+ /// lighting, and framing. Upload the working image as `source_image` using
+ /// `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -73,16 +70,13 @@ partial void ProcessPostModelSwapResponseContent( return __response.Body; } /// - /// Replace the model in a commerce image
- /// Re-casts a fashion commerce image with the identity shown in one or
- /// more ordered target-model references. The workflow uses the working
- /// image for the product, pose, scene, lighting, framing, and camera, and
- /// uses the target references only for identity, hair, skin tone, and body
- /// proportions. Results are full-frame edits; exact pixel preservation is
- /// not guaranteed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. + /// Model Swap
+ /// Replaces the model in a fashion image with the person shown in one to
+ /// four target-model references, keeping the product, pose, scene,
+ /// lighting, and framing. Upload the working image as `source_image` using
+ /// `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -793,26 +787,23 @@ request.SourceImagename is null } } /// - /// Replace the model in a commerce image
- /// Re-casts a fashion commerce image with the identity shown in one or
- /// more ordered target-model references. The workflow uses the working
- /// image for the product, pose, scene, lighting, framing, and camera, and
- /// uses the target references only for identity, hair, skin tone, and body
- /// proportions. Results are full-frame edits; exact pixel preservation is
- /// not guaranteed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. + /// Model Swap
+ /// Replaces the model in a fashion image with the person shown in one to
+ /// four target-model references, keeping the product, pose, scene,
+ /// lighting, and framing. Upload the working image as `source_image` using
+ /// `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw working-image bytes. Supported formats and the 50 MB limit match the image upload API. Available only with `multipart/form-data`. + /// The working image whose product, pose, scene, lighting, framing, and camera are preserved. Supported formats and the 50 MB limit match the image upload API. Multipart requests only. /// /// - /// Raw working-image bytes. Supported formats and the 50 MB limit match the image upload API. Available only with `multipart/form-data`. + /// The working image whose product, pose, scene, lighting, framing, and camera are preserved. Supported formats and the 50 MB limit match the image upload API. Multipart requests only. /// /// /// Ordered target-model identity and angle references. These images supply only identity, hair, skin tone, and body proportions. diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostPackshots.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostPackshots.g.cs index f83a6868..e2fd2fce 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostPackshots.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostPackshots.g.cs @@ -42,12 +42,12 @@ partial void ProcessPostPackshotsResponseContent( ref string content); /// - /// Create marketplace-ready product packshots
+ /// Packshots
/// Creates one polished product photograph from one or more ordered product
/// references. An optional style reference may guide framing, crop,
/// background, and lighting without changing the product's identity.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. Product fidelity is
/// best-effort and details absent from every reference may be reconstructed. ///
@@ -71,12 +71,12 @@ partial void ProcessPostPackshotsResponseContent( return __response.Body; } /// - /// Create marketplace-ready product packshots
+ /// Packshots
/// Creates one polished product photograph from one or more ordered product
/// references. An optional style reference may guide framing, crop,
/// background, and lighting without changing the product's identity.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. Product fidelity is
/// best-effort and details absent from every reference may be reconstructed. ///
@@ -616,12 +616,12 @@ partial void ProcessPostPackshotsResponseContent( } } /// - /// Create marketplace-ready product packshots
+ /// Packshots
/// Creates one polished product photograph from one or more ordered product
/// references. An optional style reference may guide framing, crop,
/// background, and lighting without changing the product's identity.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. Product fidelity is
/// best-effort and details absent from every reference may be reconstructed. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostPreciseMaskedEdit.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostPreciseMaskedEdit.g.cs index fe61d36c..666d491c 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostPreciseMaskedEdit.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostPreciseMaskedEdit.g.cs @@ -49,7 +49,7 @@ partial void ProcessPostPreciseMaskedEditResponseContent( /// `preserve_unmasked_pixels` to keep decoded pixels outside a supplied mask
/// unchanged in the final image.
/// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. /// /// @@ -79,7 +79,7 @@ partial void ProcessPostPreciseMaskedEditResponseContent( /// `preserve_unmasked_pixels` to keep decoded pixels outside a supplied mask
/// unchanged in the final image.
/// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. /// /// @@ -822,7 +822,7 @@ request.SourceImagename is null /// `preserve_unmasked_pixels` to keep decoded pixels outside a supplied mask
/// unchanged in the final image.
/// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSkechersStyleEdit.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSkechersStyleEdit.g.cs index 16f456cf..1a13b232 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSkechersStyleEdit.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSkechersStyleEdit.g.cs @@ -47,7 +47,7 @@ partial void ProcessPostSkechersStyleEditResponseContent( /// change. Image 1 is the base; reference images are numbered from image 2
/// in the supplied order. Resolve image mentions to these numbers before
/// submitting. Descriptions identify the selected view or reference.
- /// Poll GET /v1/generations/{generation_id} with the returned generation_id
+ /// Poll GET /v2/generations/{generation_id} with the returned generation_id
/// until the workflow completes or fails. /// /// @@ -75,7 +75,7 @@ partial void ProcessPostSkechersStyleEditResponseContent( /// change. Image 1 is the base; reference images are numbered from image 2
/// in the supplied order. Resolve image mentions to these numbers before
/// submitting. Descriptions identify the selected view or reference.
- /// Poll GET /v1/generations/{generation_id} with the returned generation_id
+ /// Poll GET /v2/generations/{generation_id} with the returned generation_id
/// until the workflow completes or fails. /// /// @@ -411,20 +411,24 @@ partial void ProcessPostSkechersStyleEditResponseContent( h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -433,11 +437,12 @@ partial void ProcessPostSkechersStyleEditResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -539,20 +544,24 @@ partial void ProcessPostSkechersStyleEditResponseContent( h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -561,11 +570,12 @@ partial void ProcessPostSkechersStyleEditResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -673,7 +683,7 @@ partial void ProcessPostSkechersStyleEditResponseContent( /// change. Image 1 is the base; reference images are numbered from image 2
/// in the supplied order. Resolve image mentions to these numbers before
/// submitting. Descriptions identify the selected view or reference.
- /// Poll GET /v1/generations/{generation_id} with the returned generation_id
+ /// Poll GET /v2/generations/{generation_id} with the returned generation_id
/// until the workflow completes or fails. /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSketchToRender.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSketchToRender.g.cs index 014e21df..c1d86dde 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSketchToRender.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSketchToRender.g.cs @@ -42,16 +42,13 @@ partial void ProcessPostSketchToRenderResponseContent( ref string content); /// - /// Render a fashion sketch as product photography
- /// Converts one fashion sketch into photorealistic garment or product
- /// imagery while preserving its silhouette, construction, colors, and
- /// visible design details.
- /// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one sketch transport: an existing `AssetIdentifier` in
- /// `sketch_asset_identifier`, or raw `sketch_image` bytes in a multipart
- /// request. Supplying both or neither is rejected with a 400. + /// Sketch to Render
+ /// Turns a fashion sketch into photorealistic garment or product imagery,
+ /// preserving its silhouette, construction, colors, and design details.
+ /// Upload the `sketch_image` using `multipart/form-data` and describe
+ /// materials and rendering in `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -73,16 +70,13 @@ partial void ProcessPostSketchToRenderResponseContent( return __response.Body; } /// - /// Render a fashion sketch as product photography
- /// Converts one fashion sketch into photorealistic garment or product
- /// imagery while preserving its silhouette, construction, colors, and
- /// visible design details.
- /// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one sketch transport: an existing `AssetIdentifier` in
- /// `sketch_asset_identifier`, or raw `sketch_image` bytes in a multipart
- /// request. Supplying both or neither is rejected with a 400. + /// Sketch to Render
+ /// Turns a fashion sketch into photorealistic garment or product imagery,
+ /// preserving its silhouette, construction, colors, and design details.
+ /// Upload the `sketch_image` using `multipart/form-data` and describe
+ /// materials and rendering in `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -785,34 +779,31 @@ request.SketchImagename is null } } /// - /// Render a fashion sketch as product photography
- /// Converts one fashion sketch into photorealistic garment or product
- /// imagery while preserving its silhouette, construction, colors, and
- /// visible design details.
- /// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one sketch transport: an existing `AssetIdentifier` in
- /// `sketch_asset_identifier`, or raw `sketch_image` bytes in a multipart
- /// request. Supplying both or neither is rejected with a 400. + /// Sketch to Render
+ /// Turns a fashion sketch into photorealistic garment or product imagery,
+ /// preserving its silhouette, construction, colors, and design details.
+ /// Upload the `sketch_image` using `multipart/form-data` and describe
+ /// materials and rendering in `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw fashion-sketch bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only.
- /// Mutually exclusive with `sketch_asset_identifier`. + /// The fashion sketch to render, up to 50 MB. JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart requests
+ /// only. /// /// - /// Raw fashion-sketch bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only.
- /// Mutually exclusive with `sketch_asset_identifier`. + /// The fashion sketch to render, up to 50 MB. JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart requests
+ /// only. /// /// - /// Required material and rendering direction, plus any construction
- /// or design details that are not legible in the sketch. + /// Material and rendering direction, plus any construction or design
+ /// details that are not legible in the sketch. /// /// /// Aspect ratio of each output image. Defaults to `1:1` when omitted. diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSoleSwap.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSoleSwap.g.cs index 7317b99f..ef37d52c 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSoleSwap.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSoleSwap.g.cs @@ -42,11 +42,11 @@ partial void ProcessPostSoleSwapResponseContent( ref string content); /// - /// Transfer a shoe upper onto a preserved sole
+ /// Sole Swap
/// Uses the sole-donor shoe as the output canvas, preserving its sole, camera,
/// background, and lighting while transferring the upper from ordered references.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned
+ /// `GET /v2/generations/{generation_id}` with the returned
/// `generation_id` until the generation is completed or failed. ///
/// @@ -69,11 +69,11 @@ partial void ProcessPostSoleSwapResponseContent( return __response.Body; } /// - /// Transfer a shoe upper onto a preserved sole
+ /// Sole Swap
/// Uses the sole-donor shoe as the output canvas, preserving its sole, camera,
/// background, and lighting while transferring the upper from ordered references.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned
+ /// `GET /v2/generations/{generation_id}` with the returned
/// `generation_id` until the generation is completed or failed. ///
/// @@ -676,11 +676,11 @@ partial void ProcessPostSoleSwapResponseContent( } } /// - /// Transfer a shoe upper onto a preserved sole
+ /// Sole Swap
/// Uses the sole-donor shoe as the output canvas, preserving its sole, camera,
/// background, and lighting while transferring the upper from ordered references.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned
+ /// `GET /v2/generations/{generation_id}` with the returned
/// `generation_id` until the generation is completed or failed. ///
/// diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwanSLogoDesign.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwanSLogoDesign.g.cs index 7c4deb3f..655f8bba 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwanSLogoDesign.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwanSLogoDesign.g.cs @@ -43,7 +43,7 @@ partial void ProcessPostSwanSLogoDesignResponseContent( /// /// Design one Swan S logo candidate
- /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -66,7 +66,7 @@ partial void ProcessPostSwanSLogoDesignResponseContent( } /// /// Design one Swan S logo candidate
- /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -465,20 +465,24 @@ partial void ProcessPostSwanSLogoDesignResponseContent( h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -487,30 +491,35 @@ partial void ProcessPostSwanSLogoDesignResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -519,11 +528,12 @@ partial void ProcessPostSwanSLogoDesignResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -627,7 +637,7 @@ partial void ProcessPostSwanSLogoDesignResponseContent( } /// /// Design one Swan S logo candidate
- /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwanSLogoInstall.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwanSLogoInstall.g.cs index d32ac4b8..adc058fc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwanSLogoInstall.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwanSLogoInstall.g.cs @@ -43,7 +43,7 @@ partial void ProcessPostSwanSLogoInstallResponseContent( /// /// Install a Swan S logo on a shoe
- /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -66,7 +66,7 @@ partial void ProcessPostSwanSLogoInstallResponseContent( } /// /// Install a Swan S logo on a shoe
- /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -465,20 +465,24 @@ partial void ProcessPostSwanSLogoInstallResponseContent( h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -487,30 +491,35 @@ partial void ProcessPostSwanSLogoInstallResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -519,11 +528,12 @@ partial void ProcessPostSwanSLogoInstallResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -627,7 +637,7 @@ partial void ProcessPostSwanSLogoInstallResponseContent( } /// /// Install a Swan S logo on a shoe
- /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwapProduct.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwapProduct.g.cs index 8f01d3a5..35dd8695 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwapProduct.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostSwapProduct.g.cs @@ -42,9 +42,9 @@ partial void ProcessPostSwapProductResponseContent( ref string content); /// - /// Replace or recolor footwear in an advertisement
+ /// Swap Product
/// Edits the footwear in a source advertisement using ordered product references.
- /// Poll `GET /v1/generations/{generation_id}` for status and image results. + /// Poll `GET /v2/generations/{generation_id}` for status and image results. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -66,9 +66,9 @@ partial void ProcessPostSwapProductResponseContent( return __response.Body; } /// - /// Replace or recolor footwear in an advertisement
+ /// Swap Product
/// Edits the footwear in a source advertisement using ordered product references.
- /// Poll `GET /v1/generations/{generation_id}` for status and image results. + /// Poll `GET /v2/generations/{generation_id}` for status and image results. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -499,20 +499,24 @@ partial void ProcessPostSwapProductResponseContent( h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -521,30 +525,35 @@ partial void ProcessPostSwapProductResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -553,11 +562,12 @@ partial void ProcessPostSwapProductResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -660,9 +670,9 @@ partial void ProcessPostSwapProductResponseContent( } } /// - /// Replace or recolor footwear in an advertisement
+ /// Swap Product
/// Edits the footwear in a source advertisement using ordered product references.
- /// Poll `GET /v1/generations/{generation_id}` for status and image results. + /// Poll `GET /v2/generations/{generation_id}` for status and image results. ///
/// /// An identifier for an ideogram asset.
diff --git a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostVirtualTryOn.g.cs b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostVirtualTryOn.g.cs index a494f01e..83d07d19 100644 --- a/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostVirtualTryOn.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.EditWorkflowClient.PostVirtualTryOn.g.cs @@ -47,7 +47,7 @@ partial void ProcessPostVirtualTryOnResponseContent( /// wearing the supplied garments, preserving their face, body, and
/// background.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed.
/// Supply the person as either an `AssetIdentifier` reference
/// (`person_asset_identifier`) or the raw image bytes directly
@@ -81,7 +81,7 @@ partial void ProcessPostVirtualTryOnResponseContent( /// wearing the supplied garments, preserving their face, body, and
/// background.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed.
/// Supply the person as either an `AssetIdentifier` reference
/// (`person_asset_identifier`) or the raw image bytes directly
@@ -738,7 +738,7 @@ request.PersonImagename is null /// wearing the supplied garments, preserving their face, body, and
/// background.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed.
/// Supply the person as either an `AssetIdentifier` reference
/// (`person_asset_identifier`) or the raw image bytes directly
diff --git a/src/libs/Ideogram/Generated/Ideogram.Generations.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.Generations.JsonSerializerContext.g.cs new file mode 100644 index 00000000..ffebcf43 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.Generations.JsonSerializerContext.g.cs @@ -0,0 +1,327 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// + /// + [global::System.Text.Json.Serialization.JsonSourceGenerationOptions( + DefaultIgnoreCondition = global::System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull + )] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.Dictionary))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.Dictionary))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List), TypeInfoPropertyName = "SystemCollectionsGeneric_ObjectList")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Text.Json.JsonElement?))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(string))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(int))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(long))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(bool))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.DateTime))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(float))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponse))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponseStatus), TypeInfoPropertyName = "GenerationResponseStatus2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponseResponseType), TypeInfoPropertyName = "GenerationResponseResponseType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponseDataInner), TypeInfoPropertyName = "GenerationResponseDataInner2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ImageObjectWithoutPromptOrSeed))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ImageObjectWithoutPromptOrSeedObjectType), TypeInfoPropertyName = "ImageObjectWithoutPromptOrSeedObjectType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ImageGenerationObject))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ImageGenerationObjectObjectType), TypeInfoPropertyName = "ImageGenerationObjectObjectType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DetectedTextBlock))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LayerizedImageObject))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LayerizedImageObjectObjectType), TypeInfoPropertyName = "LayerizedImageObjectObjectType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.VideoObject))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.VideoObjectObjectType), TypeInfoPropertyName = "VideoObjectObjectType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DetectedTextBlockAlignment), TypeInfoPropertyName = "DetectedTextBlockAlignment2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DetectedTextBlockFormattingItem), TypeInfoPropertyName = "DetectedTextBlockFormattingItem2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DetectedTextBlockRole), TypeInfoPropertyName = "DetectedTextBlockRole2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponseDataInnerDiscriminator))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponseDataInnerDiscriminatorObjectType), TypeInfoPropertyName = "GenerationResponseDataInnerDiscriminatorObjectType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(int?))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(long?))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(bool?))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.DateTime?))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(float?))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponseStatus?), TypeInfoPropertyName = "NullableGenerationResponseStatus2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponseResponseType?), TypeInfoPropertyName = "NullableGenerationResponseResponseType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponseDataInner?), TypeInfoPropertyName = "NullableGenerationResponseDataInner2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ImageObjectWithoutPromptOrSeedObjectType?), TypeInfoPropertyName = "NullableImageObjectWithoutPromptOrSeedObjectType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ImageGenerationObjectObjectType?), TypeInfoPropertyName = "NullableImageGenerationObjectObjectType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LayerizedImageObjectObjectType?), TypeInfoPropertyName = "NullableLayerizedImageObjectObjectType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.VideoObjectObjectType?), TypeInfoPropertyName = "NullableVideoObjectObjectType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DetectedTextBlockAlignment?), TypeInfoPropertyName = "NullableDetectedTextBlockAlignment2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DetectedTextBlockFormattingItem?), TypeInfoPropertyName = "NullableDetectedTextBlockFormattingItem2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DetectedTextBlockRole?), TypeInfoPropertyName = "NullableDetectedTextBlockRole2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationResponseDataInnerDiscriminatorObjectType?), TypeInfoPropertyName = "NullableGenerationResponseDataInnerDiscriminatorObjectType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] + internal sealed partial class GenerationsSourceGenerationContextChunk0 : global::System.Text.Json.Serialization.JsonSerializerContext + { + } + /// + /// + /// + public sealed partial class GenerationsSourceGenerationContext : global::System.Text.Json.Serialization.JsonSerializerContext + { + private static readonly global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver Resolver = new LazyChunkResolver(); + + [global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)] + internal static global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver TypeInfoResolver => Resolver; + + + private static readonly global::System.Text.Json.JsonSerializerOptions DefaultOptions = CreateDefaultOptions(); + + /// + /// + /// + public static GenerationsSourceGenerationContext Default { get; } = new(DefaultOptions); + + private GenerationsSourceGenerationContext(global::System.Text.Json.JsonSerializerOptions options) + : base(options) + { + } + + /// + protected override global::System.Text.Json.JsonSerializerOptions? GeneratedSerializerOptions => DefaultOptions; + + /// + public override global::System.Text.Json.Serialization.Metadata.JsonTypeInfo? GetTypeInfo(global::System.Type type) + { + return Resolver.GetTypeInfo(type, Options); + } + + /// + /// Adds this package's converters to . + /// + /// + /// A converter has to be on the options a chained resolver builds its JsonTypeInfo against, + /// and a context resolves types from every package below it. Each package contributes only + /// what it owns and calls down the chain for the rest, so the family's converter table is + /// written once rather than copied into all of them. + /// + [global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)] + public static void AddConverters(global::System.Text.Json.JsonSerializerOptions options) + { + options.Converters.Add(new global::Ideogram.JsonConverters.GenerationResponseDataInnerJsonConverter()); + options.Converters.Add(new global::Ideogram.JsonConverters.UnixTimestampJsonConverter()); + options.Converters.Add(new LazyEnumJsonConverterFactory()); + } + + private static global::System.Text.Json.JsonSerializerOptions CreateDefaultOptions() + { + var options = new global::System.Text.Json.JsonSerializerOptions + { + DefaultIgnoreCondition = global::System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull, + TypeInfoResolver = Resolver, + }; + AddConverters(options); + + return options; + } + + + private sealed class LazyEnumJsonConverterFactory : global::System.Text.Json.Serialization.JsonConverterFactory + { + public override bool CanConvert(global::System.Type typeToConvert) + { + return + typeToConvert == typeof(global::Ideogram.GenerationResponseStatus) + + || typeToConvert == typeof(global::Ideogram.GenerationResponseStatus?) + + || typeToConvert == typeof(global::Ideogram.GenerationResponseResponseType) + + || typeToConvert == typeof(global::Ideogram.GenerationResponseResponseType?) + + || typeToConvert == typeof(global::Ideogram.ImageObjectWithoutPromptOrSeedObjectType) + + || typeToConvert == typeof(global::Ideogram.ImageObjectWithoutPromptOrSeedObjectType?) + + || typeToConvert == typeof(global::Ideogram.ImageGenerationObjectObjectType) + + || typeToConvert == typeof(global::Ideogram.ImageGenerationObjectObjectType?) + + || typeToConvert == typeof(global::Ideogram.LayerizedImageObjectObjectType) + + || typeToConvert == typeof(global::Ideogram.LayerizedImageObjectObjectType?) + + || typeToConvert == typeof(global::Ideogram.VideoObjectObjectType) + + || typeToConvert == typeof(global::Ideogram.VideoObjectObjectType?) + + || typeToConvert == typeof(global::Ideogram.DetectedTextBlockAlignment) + + || typeToConvert == typeof(global::Ideogram.DetectedTextBlockAlignment?) + + || typeToConvert == typeof(global::Ideogram.DetectedTextBlockFormattingItem) + + || typeToConvert == typeof(global::Ideogram.DetectedTextBlockFormattingItem?) + + || typeToConvert == typeof(global::Ideogram.DetectedTextBlockRole) + + || typeToConvert == typeof(global::Ideogram.DetectedTextBlockRole?) + + || typeToConvert == typeof(global::Ideogram.GenerationResponseDataInnerDiscriminatorObjectType) + + || typeToConvert == typeof(global::Ideogram.GenerationResponseDataInnerDiscriminatorObjectType?); + } + + public override global::System.Text.Json.Serialization.JsonConverter CreateConverter( + global::System.Type typeToConvert, + global::System.Text.Json.JsonSerializerOptions options) + { + if (typeToConvert == typeof(global::Ideogram.GenerationResponseStatus)) + { + return new global::Ideogram.JsonConverters.GenerationResponseStatusJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.GenerationResponseStatus?)) + { + return new global::Ideogram.JsonConverters.GenerationResponseStatusNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.GenerationResponseResponseType)) + { + return new global::Ideogram.JsonConverters.GenerationResponseResponseTypeJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.GenerationResponseResponseType?)) + { + return new global::Ideogram.JsonConverters.GenerationResponseResponseTypeNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.ImageObjectWithoutPromptOrSeedObjectType)) + { + return new global::Ideogram.JsonConverters.ImageObjectWithoutPromptOrSeedObjectTypeJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.ImageObjectWithoutPromptOrSeedObjectType?)) + { + return new global::Ideogram.JsonConverters.ImageObjectWithoutPromptOrSeedObjectTypeNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.ImageGenerationObjectObjectType)) + { + return new global::Ideogram.JsonConverters.ImageGenerationObjectObjectTypeJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.ImageGenerationObjectObjectType?)) + { + return new global::Ideogram.JsonConverters.ImageGenerationObjectObjectTypeNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.LayerizedImageObjectObjectType)) + { + return new global::Ideogram.JsonConverters.LayerizedImageObjectObjectTypeJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.LayerizedImageObjectObjectType?)) + { + return new global::Ideogram.JsonConverters.LayerizedImageObjectObjectTypeNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.VideoObjectObjectType)) + { + return new global::Ideogram.JsonConverters.VideoObjectObjectTypeJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.VideoObjectObjectType?)) + { + return new global::Ideogram.JsonConverters.VideoObjectObjectTypeNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.DetectedTextBlockAlignment)) + { + return new global::Ideogram.JsonConverters.DetectedTextBlockAlignmentJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.DetectedTextBlockAlignment?)) + { + return new global::Ideogram.JsonConverters.DetectedTextBlockAlignmentNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.DetectedTextBlockFormattingItem)) + { + return new global::Ideogram.JsonConverters.DetectedTextBlockFormattingItemJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.DetectedTextBlockFormattingItem?)) + { + return new global::Ideogram.JsonConverters.DetectedTextBlockFormattingItemNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.DetectedTextBlockRole)) + { + return new global::Ideogram.JsonConverters.DetectedTextBlockRoleJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.DetectedTextBlockRole?)) + { + return new global::Ideogram.JsonConverters.DetectedTextBlockRoleNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.GenerationResponseDataInnerDiscriminatorObjectType)) + { + return new global::Ideogram.JsonConverters.GenerationResponseDataInnerDiscriminatorObjectTypeJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.GenerationResponseDataInnerDiscriminatorObjectType?)) + { + return new global::Ideogram.JsonConverters.GenerationResponseDataInnerDiscriminatorObjectTypeNullableJsonConverter(); + } + throw new global::System.NotSupportedException($"No generated enum converter is registered for '{typeToConvert}'."); + } + } + + private sealed class LazyChunkResolver : global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver + { + private readonly object _gate = new(); + private readonly global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver?[] _resolvers = new global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver?[1]; + + public global::System.Text.Json.Serialization.Metadata.JsonTypeInfo? GetTypeInfo( + global::System.Type type, + global::System.Text.Json.JsonSerializerOptions options) + { + for (var index = 0; index < _resolvers.Length; index++) + { + var typeInfo = GetResolver(index).GetTypeInfo(type, options); + if (typeInfo is not null) + { + return typeInfo; + } + } + + return null; + } + + private global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver GetResolver(int index) + { + var resolver = global::System.Threading.Volatile.Read(ref _resolvers[index]); + if (resolver is not null) + { + return resolver; + } + + lock (_gate) + { + return _resolvers[index] ??= CreateResolver(index); + } + } + + private static global::System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver CreateResolver(int index) + { + return index switch + { + 0 => new GenerationsSourceGenerationContextChunk0(new global::System.Text.Json.JsonSerializerOptions()), + _ => throw new global::System.ArgumentOutOfRangeException(nameof(index)), + }; + } + } + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.Authorizations.Bearer.g.cs b/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.Authorizations.Bearer.g.cs new file mode 100644 index 00000000..2ddde638 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.Authorizations.Bearer.g.cs @@ -0,0 +1,35 @@ + +#nullable enable + +namespace Ideogram +{ + public sealed partial class GenerationsClient + { + + /// + public void AuthorizeUsingBearer( + string apiKey) + { + apiKey = apiKey ?? throw new global::System.ArgumentNullException(nameof(apiKey)); + + for (var i = Authorizations.Count - 1; i >= 0; i--) + { + var __authorization = Authorizations[i]; + if (__authorization.Type == "Http" && + __authorization.Name == "Bearer") + { + Authorizations.RemoveAt(i); + } + } + + Authorizations.Add(new global::Ideogram.EndPointAuthorization + { + Type = "Http", + SchemeId = "HttpBearer", + Location = "Header", + Name = "Bearer", + Value = apiKey, + }); + } + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.Constructors.Bearer.g.cs b/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.Constructors.Bearer.g.cs new file mode 100644 index 00000000..afb1c6d6 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.Constructors.Bearer.g.cs @@ -0,0 +1,31 @@ + +#nullable enable + +namespace Ideogram +{ + public sealed partial class GenerationsClient + { + /// + + public GenerationsClient( + string apiKey, + global::System.Net.Http.HttpClient? httpClient = null, + global::System.Uri? baseUri = null, + global::System.Collections.Generic.List? authorizations = null, + bool disposeHttpClient = true) : this(httpClient, baseUri, authorizations, disposeHttpClient) + { + Authorizing(HttpClient, ref apiKey); + + AuthorizeUsingBearer(apiKey); + + Authorized(HttpClient); + } + + partial void Authorizing( + global::System.Net.Http.HttpClient client, + ref string apiKey); + partial void Authorized( + global::System.Net.Http.HttpClient client); + + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.GetGenerationV2.g.cs b/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.GetGenerationV2.g.cs new file mode 100644 index 00000000..4dc5fec1 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.GetGenerationV2.g.cs @@ -0,0 +1,578 @@ + +#nullable enable + +namespace Ideogram +{ + public partial class GenerationsClient + { + + + private static readonly global::Ideogram.EndPointSecurityRequirement s_GetGenerationV2SecurityRequirement0 = + new global::Ideogram.EndPointSecurityRequirement + { + Authorizations = new global::Ideogram.EndPointAuthorizationRequirement[] + { new global::Ideogram.EndPointAuthorizationRequirement + { + Type = "Http", + SchemeId = "HttpBearer", + Location = "Header", + Name = "Bearer", + FriendlyName = "Bearer", + }, + }, + }; + private static readonly global::Ideogram.EndPointSecurityRequirement[] s_GetGenerationV2SecurityRequirements = + new global::Ideogram.EndPointSecurityRequirement[] + { s_GetGenerationV2SecurityRequirement0, + }; + partial void PrepareGetGenerationV2Arguments( + global::System.Net.Http.HttpClient httpClient, + ref string generationId); + partial void PrepareGetGenerationV2Request( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpRequestMessage httpRequestMessage, + string generationId); + partial void ProcessGetGenerationV2Response( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpResponseMessage httpResponseMessage); + + partial void ProcessGetGenerationV2ResponseContent( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpResponseMessage httpResponseMessage, + ref string content); + + /// + /// Poll a generation
+ /// Retrieves the current status of an asynchronous generation, and its
+ /// results once complete. Use the `generation_id` returned by any `/v2`
+ /// endpoint that runs asynchronously: every video and tool endpoint, and
+ /// any image endpoint called with `async` or a `webhook_url`.
+ /// While the generation is `pending` or has `failed`, the response
+ /// contains only `generation_id`, `status`, and `created` (plus
+ /// `failure_reason` once failed). Once `status` is `completed`, the
+ /// response includes `response_type` and `data`. Each `data` item carries
+ /// an `object_type` that identifies its shape, so image and video results
+ /// can be told apart. `usage_cost_usd_micros` reports the amount billed
+ /// when the request uses variable usage-based pricing.
+ /// Polling is rate limited per organization; a 429 response carries a
+ /// `Retry-After` header with the number of seconds to wait. + ///
+ /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + public async global::System.Threading.Tasks.Task GetGenerationV2Async( + string generationId, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default) + { + var __response = await GetGenerationV2AsResponseAsync( + generationId: generationId, + requestOptions: requestOptions, + cancellationToken: cancellationToken + ).ConfigureAwait(false); + + return __response.Body; + } + /// + /// Poll a generation
+ /// Retrieves the current status of an asynchronous generation, and its
+ /// results once complete. Use the `generation_id` returned by any `/v2`
+ /// endpoint that runs asynchronously: every video and tool endpoint, and
+ /// any image endpoint called with `async` or a `webhook_url`.
+ /// While the generation is `pending` or has `failed`, the response
+ /// contains only `generation_id`, `status`, and `created` (plus
+ /// `failure_reason` once failed). Once `status` is `completed`, the
+ /// response includes `response_type` and `data`. Each `data` item carries
+ /// an `object_type` that identifies its shape, so image and video results
+ /// can be told apart. `usage_cost_usd_micros` reports the amount billed
+ /// when the request uses variable usage-based pricing.
+ /// Polling is rate limited per organization; a 429 response carries a
+ /// `Retry-After` header with the number of seconds to wait. + ///
+ /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + public async global::System.Threading.Tasks.Task> GetGenerationV2AsResponseAsync( + string generationId, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default) + { + PrepareArguments( + client: HttpClient); + PrepareGetGenerationV2Arguments( + httpClient: HttpClient, + generationId: ref generationId); + + + var __authorizations = global::Ideogram.EndPointSecurityResolver.ResolveAuthorizations( + availableAuthorizations: Authorizations, + securityRequirements: s_GetGenerationV2SecurityRequirements, + operationName: "GetGenerationV2Async"); + + using var __timeoutCancellationTokenSource = global::Ideogram.AutoSDKRequestOptionsSupport.CreateTimeoutCancellationTokenSource( + clientOptions: Options, + requestOptions: requestOptions, + cancellationToken: cancellationToken); + var __effectiveCancellationToken = __timeoutCancellationTokenSource?.Token ?? cancellationToken; + var __effectiveReadResponseAsString = global::Ideogram.AutoSDKRequestOptionsSupport.GetReadResponseAsString( + clientOptions: Options, + requestOptions: requestOptions, + fallbackValue: ReadResponseAsString); + var __maxAttempts = global::Ideogram.AutoSDKRequestOptionsSupport.GetMaxAttempts( + clientOptions: Options, + requestOptions: requestOptions, + supportsRetry: true); + + global::System.Net.Http.HttpRequestMessage __CreateHttpRequest() + { + + var __pathBuilder = new global::Ideogram.PathBuilder( + path: $"/v2/generations/{generationId}", + baseUri: HttpClient.BaseAddress); + var __path = __pathBuilder.ToString(); + __path = global::Ideogram.AutoSDKRequestOptionsSupport.AppendQueryParameters( + path: __path, + clientParameters: Options.QueryParameters, + requestParameters: requestOptions?.QueryParameters); + var __httpRequest = new global::System.Net.Http.HttpRequestMessage( + method: global::System.Net.Http.HttpMethod.Get, + requestUri: new global::System.Uri(__path, global::System.UriKind.RelativeOrAbsolute)); +#if NET6_0_OR_GREATER + __httpRequest.Version = global::System.Net.HttpVersion.Version11; + __httpRequest.VersionPolicy = global::System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher; +#endif + + foreach (var __authorization in __authorizations) + { + if (__authorization.Type == "Http" || + __authorization.Type == "OAuth2" || + __authorization.Type == "OpenIdConnect") + { + __httpRequest.Headers.Authorization = new global::System.Net.Http.Headers.AuthenticationHeaderValue( + scheme: __authorization.Name, + parameter: __authorization.Value); + } + else if (__authorization.Type == "ApiKey" && + __authorization.Location == "Header") + { + __httpRequest.Headers.Add(__authorization.Name, __authorization.Value); + } + } + global::Ideogram.AutoSDKRequestOptionsSupport.ApplyHeaders( + request: __httpRequest, + clientHeaders: Options.Headers, + requestHeaders: requestOptions?.Headers); + + PrepareRequest( + client: HttpClient, + request: __httpRequest); + PrepareGetGenerationV2Request( + httpClient: HttpClient, + httpRequestMessage: __httpRequest, + generationId: generationId); + + return __httpRequest; + } + + global::System.Net.Http.HttpRequestMessage? __httpRequest = null; + global::System.Net.Http.HttpResponseMessage? __response = null; + var __attemptNumber = 0; + try + { + for (var __attempt = 1; __attempt <= __maxAttempts; __attempt++) + { + __attemptNumber = __attempt; + __httpRequest = __CreateHttpRequest(); + await global::Ideogram.AutoSDKRequestOptionsSupport.OnBeforeRequestAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "GetGenerationV2", + methodName: "GetGenerationV2Async", + pathTemplate: "$\"/v2/generations/{generationId}\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: null, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: false, + retryDelay: null, + retryReason: global::System.String.Empty, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + try + { + __response = await HttpClient.SendAsync( + request: __httpRequest, + completionOption: global::System.Net.Http.HttpCompletionOption.ResponseContentRead, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + } + catch (global::System.Net.Http.HttpRequestException __exception) + { + var __retryDelay = global::Ideogram.AutoSDKRequestOptionsSupport.GetRetryDelay( + clientOptions: Options, + requestOptions: requestOptions, + response: null, + attempt: __attempt); + var __willRetry = __attempt < __maxAttempts && !__effectiveCancellationToken.IsCancellationRequested; + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "GetGenerationV2", + methodName: "GetGenerationV2Async", + pathTemplate: "$\"/v2/generations/{generationId}\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: null, + exception: __exception, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: __willRetry, + retryDelay: __willRetry ? __retryDelay : (global::System.TimeSpan?)null, + retryReason: "exception", + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + if (!__willRetry) + { + throw; + } + + __httpRequest.Dispose(); + __httpRequest = null; + await global::Ideogram.AutoSDKRequestOptionsSupport.DelayBeforeRetryAsync( + retryDelay: __retryDelay, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + continue; + } + + if (__response != null && + __attempt < __maxAttempts && + global::Ideogram.AutoSDKRequestOptionsSupport.ShouldRetryStatusCode(__response.StatusCode)) + { + var __retryDelay = global::Ideogram.AutoSDKRequestOptionsSupport.GetRetryDelay( + clientOptions: Options, + requestOptions: requestOptions, + response: __response, + attempt: __attempt); + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "GetGenerationV2", + methodName: "GetGenerationV2Async", + pathTemplate: "$\"/v2/generations/{generationId}\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: true, + retryDelay: __retryDelay, + retryReason: "status:" + ((int)__response.StatusCode).ToString(global::System.Globalization.CultureInfo.InvariantCulture), + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + __response.Dispose(); + __response = null; + __httpRequest.Dispose(); + __httpRequest = null; + await global::Ideogram.AutoSDKRequestOptionsSupport.DelayBeforeRetryAsync( + retryDelay: __retryDelay, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + continue; + } + + break; + } + + if (__response == null) + { + throw new global::System.InvalidOperationException("No response received."); + } + + using (__response) + { + + ProcessResponse( + client: HttpClient, + response: __response); + ProcessGetGenerationV2Response( + httpClient: HttpClient, + httpResponseMessage: __response); + if (__response.IsSuccessStatusCode) + { + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterSuccessAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "GetGenerationV2", + methodName: "GetGenerationV2Async", + pathTemplate: "$\"/v2/generations/{generationId}\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attemptNumber, + maxAttempts: __maxAttempts, + willRetry: false, + retryDelay: null, + retryReason: global::System.String.Empty, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + } + else + { + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "GetGenerationV2", + methodName: "GetGenerationV2Async", + pathTemplate: "$\"/v2/generations/{generationId}\"", + httpMethod: "GET", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attemptNumber, + maxAttempts: __maxAttempts, + willRetry: false, + retryDelay: null, + retryReason: global::System.String.Empty, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + } + // + if ((int)__response.StatusCode == 400) + { + string? __content_400 = null; + global::System.Exception? __exception_400 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_400 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_400 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_400 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_400 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_400, + responseBody: __content_400, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // + if ((int)__response.StatusCode == 401) + { + string? __content_401 = null; + global::System.Exception? __exception_401 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_401 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_401 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_401 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_401 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_401, + responseBody: __content_401, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // + if ((int)__response.StatusCode == 404) + { + string? __content_404 = null; + global::System.Exception? __exception_404 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_404 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_404 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_404 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_404 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_404, + responseBody: __content_404, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // + if ((int)__response.StatusCode == 429) + { + string? __content_429 = null; + global::System.Exception? __exception_429 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_429 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_429, + responseBody: __content_429, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + + if (__effectiveReadResponseAsString) + { + var __content = await __response.Content.ReadAsStringAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + + ProcessResponseContent( + client: HttpClient, + response: __response, + content: ref __content); + ProcessGetGenerationV2ResponseContent( + httpClient: HttpClient, + httpResponseMessage: __response, + content: ref __content); + + try + { + __response.EnsureSuccessStatusCode(); + + var __value = global::Ideogram.GenerationResponse.FromJson(__content, JsonSerializerContext) ?? + throw new global::System.InvalidOperationException($"Response deserialization failed for \"{__content}\" "); + return new global::Ideogram.AutoSDKHttpResponse( + statusCode: __response.StatusCode, + headers: global::Ideogram.AutoSDKHttpResponse.CreateHeaders(__response), + requestUri: __response.RequestMessage?.RequestUri, + body: __value); + } + catch (global::System.Exception __ex) + { + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content ?? __response.ReasonPhrase ?? string.Empty, + innerException: __ex, + responseBody: __content, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + } + else + { + try + { + __response.EnsureSuccessStatusCode(); + using var __content = await __response.Content.ReadAsStreamAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + + var __value = await global::Ideogram.GenerationResponse.FromJsonStreamAsync(__content, JsonSerializerContext).ConfigureAwait(false) ?? + throw new global::System.InvalidOperationException("Response deserialization failed."); + return new global::Ideogram.AutoSDKHttpResponse( + statusCode: __response.StatusCode, + headers: global::Ideogram.AutoSDKHttpResponse.CreateHeaders(__response), + requestUri: __response.RequestMessage?.RequestUri, + body: __value); + } + catch (global::System.Exception __ex) + { + string? __content = null; + try + { + __content = await __response.Content.ReadAsStringAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + } + catch (global::System.Exception) + { + } + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content ?? __response.ReasonPhrase ?? string.Empty, + innerException: __ex, + responseBody: __content, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + } + + } + } + finally + { + __httpRequest?.Dispose(); + } + } + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.g.cs new file mode 100644 index 00000000..6113178e --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.GenerationsClient.g.cs @@ -0,0 +1,143 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// If no httpClient is provided, a new one will be created.
+ /// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. + ///
+ public sealed partial class GenerationsClient : global::Ideogram.IGenerationsClient, global::System.IDisposable + { + /// + /// + /// + public const string DefaultBaseUrl = "https://api.ideogram.ai/"; + + private bool _disposeHttpClient = true; + + /// + public global::System.Net.Http.HttpClient HttpClient { get; } + + /// + public System.Uri? BaseUri => HttpClient.BaseAddress; + + /// + public global::System.Collections.Generic.List Authorizations { get; } + + /// + public bool ReadResponseAsString { get; set; } +#if DEBUG + = true; +#endif + + /// + public global::Ideogram.AutoSDKClientOptions Options { get; } + + internal global::System.Lazy JsonSerializerContextProvider { get; set; } = new(() => global::Ideogram.GenerationsSourceGenerationContext.Default); + + /// + /// + /// + public global::System.Text.Json.Serialization.JsonSerializerContext JsonSerializerContext + { + get => JsonSerializerContextProvider.Value; + set => JsonSerializerContextProvider = new(() => value); + } + + + /// + /// Creates a new instance of the GenerationsClient. + /// If no httpClient is provided, a new one will be created. + /// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. + /// + /// The HttpClient instance. If not provided, a new one will be created. + /// The base URL for the API. If not provided, the default baseUri from OpenAPI spec will be used. + /// The authorizations to use for the requests. + /// Dispose the HttpClient when the instance is disposed. True by default. + public GenerationsClient( + global::System.Net.Http.HttpClient? httpClient = null, + global::System.Uri? baseUri = null, + global::System.Collections.Generic.List? authorizations = null, + bool disposeHttpClient = true) : this( + httpClient, + baseUri, + authorizations, + options: null, + disposeHttpClient: disposeHttpClient) + { + } + + /// + /// Creates a new instance of the GenerationsClient with explicit options but no base URL override. + /// Skips passing baseUri so the default base URL from the OpenAPI spec applies. + /// + /// The HttpClient instance. If not provided, a new one will be created. + /// The authorizations to use for the requests. + /// Client-wide request defaults such as headers, query parameters, retries, and timeout. + /// Dispose the HttpClient when the instance is disposed. True by default. + public GenerationsClient( + global::System.Net.Http.HttpClient? httpClient, + global::System.Collections.Generic.List? authorizations, + global::Ideogram.AutoSDKClientOptions? options, + bool disposeHttpClient = true) : this( + httpClient, + baseUri: null, + authorizations, + options, + disposeHttpClient: disposeHttpClient) + { + } + + /// + /// Creates a new instance of the GenerationsClient. + /// If no httpClient is provided, a new one will be created. + /// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. + /// + /// The HttpClient instance. If not provided, a new one will be created. + /// The base URL for the API. If not provided, the default baseUri from OpenAPI spec will be used. + /// The authorizations to use for the requests. + /// Client-wide request defaults such as headers, query parameters, retries, and timeout. + /// Dispose the HttpClient when the instance is disposed. True by default. + public GenerationsClient( + global::System.Net.Http.HttpClient? httpClient, + global::System.Uri? baseUri, + global::System.Collections.Generic.List? authorizations, + global::Ideogram.AutoSDKClientOptions? options, + bool disposeHttpClient = true) + { + + HttpClient = httpClient ?? new global::System.Net.Http.HttpClient(); + HttpClient.BaseAddress ??= baseUri ?? new global::System.Uri(DefaultBaseUrl); + Authorizations = authorizations ?? new global::System.Collections.Generic.List(); + Options = options ?? new global::Ideogram.AutoSDKClientOptions(); + _disposeHttpClient = disposeHttpClient; + + Initialized(HttpClient); + } + + /// + public void Dispose() + { + if (_disposeHttpClient) + { + HttpClient.Dispose(); + } + } + + partial void Initialized( + global::System.Net.Http.HttpClient client); + partial void PrepareArguments( + global::System.Net.Http.HttpClient client); + partial void PrepareRequest( + global::System.Net.Http.HttpClient client, + global::System.Net.Http.HttpRequestMessage request); + partial void ProcessResponse( + global::System.Net.Http.HttpClient client, + global::System.Net.Http.HttpResponseMessage response); + partial void ProcessResponseContent( + global::System.Net.Http.HttpClient client, + global::System.Net.Http.HttpResponseMessage response, + ref string content); + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountApiKeys.g.cs b/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountApiKeys.g.cs index 7910ec85..ca764c21 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountApiKeys.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountApiKeys.g.cs @@ -5,7 +5,7 @@ namespace Ideogram public partial interface IAccountClient { /// - /// List your organization's API keys
+ /// List API keys
/// Lists the API keys in your organization. Key material is redacted —
/// the full key is only shown once, when it is created. Disabled and
/// archived keys are included (see each key's `status`) so historical
@@ -20,7 +20,7 @@ public partial interface IAccountClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// List your organization's API keys
+ /// List API keys
/// Lists the API keys in your organization. Key material is redacted —
/// the full key is only shown once, when it is created. Disabled and
/// archived keys are included (see each key's `status`) so historical
diff --git a/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountInvoices.g.cs b/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountInvoices.g.cs index 2b2bdc63..158d2471 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountInvoices.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountInvoices.g.cs @@ -5,7 +5,7 @@ namespace Ideogram public partial interface IAccountClient { /// - /// List your organization's invoices
+ /// List invoices
/// Returns your organization's invoices with their line items — the
/// billing record your usage reports reconcile against. Amounts are
/// decimal strings in the invoice's currency.
@@ -19,7 +19,7 @@ public partial interface IAccountClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// List your organization's invoices
+ /// List invoices
/// Returns your organization's invoices with their line items — the
/// billing record your usage reports reconcile against. Amounts are
/// decimal strings in the invoice's currency.
diff --git a/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountUsage.g.cs b/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountUsage.g.cs index be482ea0..3f1b9b8b 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountUsage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IAccountClient.GetAccountUsage.g.cs @@ -5,7 +5,7 @@ namespace Ideogram public partial interface IAccountClient { /// - /// Retrieve your organization's API usage and spend over time
+ /// Get usage and spend
/// Returns your organization's billed API usage as dense time buckets of
/// line items. Every line item carries the billed dollar amount; products
/// billed per item also carry `billed_units` (unit, quantity, and unit
@@ -44,7 +44,7 @@ public partial interface IAccountClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Retrieve your organization's API usage and spend over time
+ /// Get usage and spend
/// Returns your organization's billed API usage as dense time buckets of
/// line items. Every line item carries the billed dollar amount; products
/// billed per item also carry `billed_units` (unit, quantity, and unit
diff --git a/src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.Authorizations.Bearer.g.cs b/src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.Authorizations.Bearer.g.cs new file mode 100644 index 00000000..7f523c4b --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.Authorizations.Bearer.g.cs @@ -0,0 +1,16 @@ + +#nullable enable + +namespace Ideogram +{ + public partial interface IAssetReferenceUsageClient + { + /// + /// Authorize using bearer authentication. + /// + /// + + public void AuthorizeUsingBearer( + string apiKey); + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.GetAssetReferenceUsage.g.cs b/src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.GetAssetReferenceUsage.g.cs new file mode 100644 index 00000000..4eb3330a --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.GetAssetReferenceUsage.g.cs @@ -0,0 +1,40 @@ +#nullable enable + +namespace Ideogram +{ + public partial interface IAssetReferenceUsageClient + { + /// + /// Rank edit reference assets used by organization requests
+ /// Counts completed requests made by the authenticated organization that used each existing asset as an edit input during the UTC date range. Direct file uploads without saved asset identifiers are excluded. Results are independent of current asset ownership, collection membership, and sharing. Returning an identifier does not grant access to its image. Tracking begins when enabled; earlier history is not included. Returns 50 assets per page. Rankings may change between pages when daily counts are updated; cursors do not pin a historical snapshot. + ///
+ /// + /// + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + global::System.Threading.Tasks.Task GetAssetReferenceUsageAsync( + global::System.DateTime startDate, + global::System.DateTime endDate, + string? cursor = default, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default); + /// + /// Rank edit reference assets used by organization requests
+ /// Counts completed requests made by the authenticated organization that used each existing asset as an edit input during the UTC date range. Direct file uploads without saved asset identifiers are excluded. Results are independent of current asset ownership, collection membership, and sharing. Returning an identifier does not grant access to its image. Tracking begins when enabled; earlier history is not included. Returns 50 assets per page. Rankings may change between pages when daily counts are updated; cursors do not pin a historical snapshot. + ///
+ /// + /// + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + global::System.Threading.Tasks.Task> GetAssetReferenceUsageAsResponseAsync( + global::System.DateTime startDate, + global::System.DateTime endDate, + string? cursor = default, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default); + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.g.cs new file mode 100644 index 00000000..2974d7fb --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.IAssetReferenceUsageClient.g.cs @@ -0,0 +1,48 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// If no httpClient is provided, a new one will be created.
+ /// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. + ///
+ public partial interface IAssetReferenceUsageClient : global::System.IDisposable + { + /// + /// The HttpClient instance. + /// + public global::System.Net.Http.HttpClient HttpClient { get; } + + /// + /// The base URL for the API. + /// + public System.Uri? BaseUri { get; } + + /// + /// The authorizations to use for the requests. + /// + public global::System.Collections.Generic.List Authorizations { get; } + + /// + /// Gets or sets a value indicating whether the response content should be read as a string. + /// True by default in debug builds, false otherwise. + /// When false, successful responses are deserialized directly from the response stream for better performance. + /// Error responses are always read as strings regardless of this setting, + /// ensuring is populated. + /// + public bool ReadResponseAsString { get; set; } + /// + /// Client-wide request defaults such as headers, query parameters, retries, and timeout. + /// + public global::Ideogram.AutoSDKClientOptions Options { get; } + + + /// + /// + /// + global::System.Text.Json.Serialization.JsonSerializerContext JsonSerializerContext { get; set; } + + + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.PostGenerateImageV2Auto.g.cs b/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.PostGenerateImageV2Auto.g.cs index 144b2dc8..50a02ffb 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.PostGenerateImageV2Auto.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.PostGenerateImageV2Auto.g.cs @@ -5,24 +5,12 @@ namespace Ideogram public partial interface IAutoModelClient { /// - /// Generate or transform images, letting the server pick the best model
- /// Generate one or more images without choosing a model. The server
- /// selects the model best suited to the request and may route different
- /// requests to different models.
- /// Supplying source images turns the request into a transform: the server
- /// picks a model that can edit, and the prompt describes the change to
- /// apply. Provide the sources either as `image_asset_identifiers`
- /// references (images already stored with Ideogram) or as raw `images`
- /// bytes (multipart requests only) — if both are supplied, the references
- /// win and the bytes are ignored. `negative_prompt` and
- /// `style_reference_asset_identifiers` only apply without source images;
- /// combining them with sources is rejected with a 422 rather than
- /// silently ignored.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`. + /// Generate with automatic model selection
+ /// Generate images with the model Ideogram picks as best suited to each
+ /// request. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -38,24 +26,12 @@ public partial interface IAutoModelClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate or transform images, letting the server pick the best model
- /// Generate one or more images without choosing a model. The server
- /// selects the model best suited to the request and may route different
- /// requests to different models.
- /// Supplying source images turns the request into a transform: the server
- /// picks a model that can edit, and the prompt describes the change to
- /// apply. Provide the sources either as `image_asset_identifiers`
- /// references (images already stored with Ideogram) or as raw `images`
- /// bytes (multipart requests only) — if both are supplied, the references
- /// win and the bytes are ignored. `negative_prompt` and
- /// `style_reference_asset_identifiers` only apply without source images;
- /// combining them with sources is rejected with a 422 rather than
- /// silently ignored.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`. + /// Generate with automatic model selection
+ /// Generate images with the model Ideogram picks as best suited to each
+ /// request. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -71,52 +47,40 @@ public partial interface IAutoModelClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate or transform images, letting the server pick the best model
- /// Generate one or more images without choosing a model. The server
- /// selects the model best suited to the request and may route different
- /// requests to different models.
- /// Supplying source images turns the request into a transform: the server
- /// picks a model that can edit, and the prompt describes the change to
- /// apply. Provide the sources either as `image_asset_identifiers`
- /// references (images already stored with Ideogram) or as raw `images`
- /// bytes (multipart requests only) — if both are supplied, the references
- /// win and the bytes are ignored. `negative_prompt` and
- /// `style_reference_asset_identifiers` only apply without source images;
- /// combining them with sources is rejected with a 422 rather than
- /// silently ignored.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`. + /// Generate with automatic model selection
+ /// Generate images with the model Ideogram picks as best suited to each
+ /// request. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the instruction describing how to transform the source images when sources are supplied. + /// The prompt to generate images from or, when source images are supplied, the change to make to them. /// /// /// Existing upload or generated image assets to transform, by reference. Takes priority over `images` if both are supplied. Supplying sources turns the request into a transform. /// /// - /// The source images to transform (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. Not every model consults it. Cannot be combined with source images. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it. Cannot be combined with source images. /// /// /// Existing upload or generated image assets whose style should guide the generation, by reference. Cannot be combined with source images. /// /// - /// The output aspect ratio. `auto` (the default) picks the most suitable ratio from the request. Without source images the value must be one of the supported ratio buckets (for example "16x9" or "1x1"); with source images any "WIDTHxHEIGHT" shape hint is accepted and the selected model serves the closest shape it supports. Omit `resolution` when supplying a non-`auto` value.
+ /// The output aspect ratio. `auto` (the default) picks the most suitable ratio for the request. Without source images the value must be a supported ratio (for example "16x9" or "1x1"); with source images any "WIDTHxHEIGHT" value is accepted and the output uses the closest supported shape. Omit `resolution` when supplying a non-`auto` value.
/// Default Value: auto /// /// /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output is served at the closest resolution the selected model supports. Omit `aspect_ratio` (or leave it `auto`) when supplying a resolution. /// /// - /// The output resolution tier. Influences which model serves the request; not every model offers every tier. When omitted the server uses the selected model's default tier. + /// The output resolution tier. Affects which model serves the request, since not every model offers every tier. When omitted, the selected model's default tier is used. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -140,7 +104,7 @@ public partial interface IAutoModelClient /// The internal generation category to attribute to the output, as a URL-safe base64 UUID without padding. Only applies when source images are supplied. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. diff --git a/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.PostToolRemix.g.cs b/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.PostToolRemix.g.cs index f0b0ebac..202bcc44 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.PostToolRemix.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.PostToolRemix.g.cs @@ -5,34 +5,12 @@ namespace Ideogram public partial interface IAutoModelClient { /// - /// Remix an existing image, letting the server pick the best model
- /// Transform an existing image with a server-selected model, guided by a
- /// text prompt. Supply the source as `image` bytes (multipart requests
- /// only). `image_weight` controls how closely the result follows the
- /// source; when omitted the selected model chooses its usual strength.
- /// The server chooses a model that supports the requested remix controls:
- /// style references (ad hoc or saved), a color palette, style codes, a
- /// style preset, and a non-`auto` style type each
- /// restrict the request to a compatible model and to the 1K tier;
- /// remixes without those controls use the default model. Omit
- /// `resolution` and `aspect_ratio` to keep the source image's shape.
- /// Supplying `image_weight` together with a `resolution` or
- /// `aspect_ratio` that changes the source's aspect ratio routes the
- /// request to a model that crops the source to the new shape; that
- /// combination is served only at the 1K tier and is rejected at 2K.
- /// (The model-pinned remix endpoints such as
- /// `/v2/image/remix/ideogram-4` reject the combination outright.)
- /// `seed` is honored only on the compatible model; the default model
- /// synthesizes an unseeded instruction prompt, so results are not
- /// reproducible there.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with automatic model selection
+ /// Remix an image guided by a text prompt, with Ideogram choosing the
+ /// model. Upload the source image as `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -48,34 +26,12 @@ public partial interface IAutoModelClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix an existing image, letting the server pick the best model
- /// Transform an existing image with a server-selected model, guided by a
- /// text prompt. Supply the source as `image` bytes (multipart requests
- /// only). `image_weight` controls how closely the result follows the
- /// source; when omitted the selected model chooses its usual strength.
- /// The server chooses a model that supports the requested remix controls:
- /// style references (ad hoc or saved), a color palette, style codes, a
- /// style preset, and a non-`auto` style type each
- /// restrict the request to a compatible model and to the 1K tier;
- /// remixes without those controls use the default model. Omit
- /// `resolution` and `aspect_ratio` to keep the source image's shape.
- /// Supplying `image_weight` together with a `resolution` or
- /// `aspect_ratio` that changes the source's aspect ratio routes the
- /// request to a model that crops the source to the new shape; that
- /// combination is served only at the 1K tier and is rejected at 2K.
- /// (The model-pinned remix endpoints such as
- /// `/v2/image/remix/ideogram-4` reject the combination outright.)
- /// `seed` is honored only on the compatible model; the default model
- /// synthesizes an unseeded instruction prompt, so results are not
- /// reproducible there.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with automatic model selection
+ /// Remix an image guided by a text prompt, with Ideogram choosing the
+ /// model. Upload the source image as `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -91,34 +47,12 @@ public partial interface IAutoModelClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix an existing image, letting the server pick the best model
- /// Transform an existing image with a server-selected model, guided by a
- /// text prompt. Supply the source as `image` bytes (multipart requests
- /// only). `image_weight` controls how closely the result follows the
- /// source; when omitted the selected model chooses its usual strength.
- /// The server chooses a model that supports the requested remix controls:
- /// style references (ad hoc or saved), a color palette, style codes, a
- /// style preset, and a non-`auto` style type each
- /// restrict the request to a compatible model and to the 1K tier;
- /// remixes without those controls use the default model. Omit
- /// `resolution` and `aspect_ratio` to keep the source image's shape.
- /// Supplying `image_weight` together with a `resolution` or
- /// `aspect_ratio` that changes the source's aspect ratio routes the
- /// request to a model that crops the source to the new shape; that
- /// combination is served only at the 1K tier and is rejected at 2K.
- /// (The model-pinned remix endpoints such as
- /// `/v2/image/remix/ideogram-4` reject the combination outright.)
- /// `seed` is honored only on the compatible model; the default model
- /// synthesizes an unseeded instruction prompt, so results are not
- /// reproducible there.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with automatic model selection
+ /// Remix an image guided by a text prompt, with Ideogram choosing the
+ /// model. Upload the source image as `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -130,65 +64,65 @@ public partial interface IAutoModelClient /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are staged for this generation request and are not added to your account's image assets. + /// The image to remix (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. The image is used only for this request and is not saved to your account. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are staged for this generation request and are not added to your account's image assets. + /// The image to remix (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. The image is used only for this request and is not saved to your account. /// /// - /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the selected model chooses its usual strength. Combining a weight with a `resolution` or `aspect_ratio` that changes the source's aspect ratio requires the 1K tier. + /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the selected model chooses its usual strength. Combining a weight with a `resolution` or `aspect_ratio` that changes the source's aspect ratio crops the source to the new shape; this is only available at the 1K tier and is rejected at 2K. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. Not every model consults it. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it. /// /// - /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output is served at the closest resolution the selected model supports in the corresponding 1K or 2K tier. Omit `aspect_ratio` when supplying a resolution. If `resolution_tier` is also supplied, it must match the tier implied by these dimensions. Combining a shape-changing value with `image_weight` requires the 1K tier. + /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output uses the closest supported resolution in the matching 1K or 2K tier. Omit `aspect_ratio` when supplying a resolution. If `resolution_tier` is also supplied, it must match the tier these dimensions fall in. Combining a shape-changing value with `image_weight` requires the 1K tier. /// /// /// The requested output aspect ratio. Omit it to keep the source image's shape. `auto` also keeps the source shape. Omit `resolution` when supplying a concrete value. Combining a shape-changing value with `image_weight` requires the 1K tier. /// /// - /// The output resolution tier. Influences which model serves the request. When omitted, the tier is inferred from `resolution`, or defaults to 1k when no exact resolution is supplied. Inputs that restrict the server's model choice (style references, saved styles, a color palette, style codes, a style preset, or a non-`auto` style type) currently support only 1K AUTO remixes. + /// The output resolution tier. When omitted, the tier is inferred from `resolution`, or defaults to 1k. A color palette, style codes, style preset, or non-`auto` style type are only supported at 1k. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`. The selected model decides how to interpret it.
/// Default Value: auto /// /// - /// Optional. Honored when the server selects the model that supports deterministic remixes; the default model synthesizes its own prompt, so results are not reproducible there. The response reports the seed used.
+ /// Optional. Only honored when the request uses a model that supports reproducible remixes; results from the default model are not reproducible. The response reports the seed used.
/// Example: 12345 /// /// /// Existing upload or generated image assets whose style should guide the remix, by reference. Supplying style references restricts the server to a model that supports them and requires the 1K resolution tier. Ignored if `style_reference_collection_id` is also supplied. /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers`. Restricts the server to a model that supports style references and requires the 1K resolution tier. + /// A saved style to apply, by its URL-safe base64 collection id. Limits the request to a model that supports style references and requires the 1K resolution tier. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// /// - /// A predefined style preset to apply. Restricts the server to a model that supports it and requires the 1K resolution tier. Cannot be combined with style codes or style references. + /// A predefined style preset to apply. Limits the request to a model that supports it and requires the 1K resolution tier. Cannot be combined with style codes. /// /// - /// A color palette to apply. Restricts the server to a model that supports palettes and requires the 1K resolution tier. + /// A color palette to apply. Limits the request to a model that supports palettes and requires the 1K resolution tier. /// /// /// A list of 8-character hexadecimal codes representing the style of the image. Refer to each endpoint for supported combinations with style types, presets, and reference images.
/// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// The style type to generate with. A value other than `auto` restricts the server to a model that supports it and requires the 1K resolution tier. + /// The style type to generate with. A value other than `auto` limits the request to a model that supports it and requires the 1K resolution tier. /// /// /// The number of images to generate.
/// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.g.cs index d1eacb20..9347a9a5 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IAutoModelClient.g.cs @@ -6,7 +6,7 @@ namespace Ideogram /// /// Model-agnostic endpoints where the server selects the model for each
/// request. Requests are JSON and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`.
+ /// polled via `GET /v2/generations/{generation_id}`.
/// If no httpClient is provided, a new one will be created.
/// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.IDesignClient.PostLayerizeDesignIdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.IDesignClient.PostLayerizeDesignIdeogramV3.g.cs index b53a2a29..1a054577 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IDesignClient.PostLayerizeDesignIdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IDesignClient.PostLayerizeDesignIdeogramV3.g.cs @@ -5,25 +5,13 @@ namespace Ideogram public partial interface IDesignClient { /// - /// Layerize the text in an image
- /// Decompose a flat image into an editable design: the text in the image
- /// is detected, erased from the image, and returned as positioned text
- /// blocks with matched fonts, sizes, and colors, alongside a text-free
- /// base image.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// A `prompt` describing the image can guide text detection; when
- /// omitted, detection runs on the image alone.
- /// By default the request blocks until layerization is complete and
- /// returns the result in `data`. Set `async` to true to return
- /// immediately after the request is accepted, then poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Layerize text with Ideogram 3.0
+ /// Turn a flat image into an editable design: detected text is returned as
+ /// positioned text blocks with matched fonts, sizes, and colors, alongside
+ /// a text-free base image. Upload the image as `image` using
+ /// `multipart/form-data`. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -39,25 +27,13 @@ public partial interface IDesignClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Layerize the text in an image
- /// Decompose a flat image into an editable design: the text in the image
- /// is detected, erased from the image, and returned as positioned text
- /// blocks with matched fonts, sizes, and colors, alongside a text-free
- /// base image.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// A `prompt` describing the image can guide text detection; when
- /// omitted, detection runs on the image alone.
- /// By default the request blocks until layerization is complete and
- /// returns the result in `data`. Set `async` to true to return
- /// immediately after the request is accepted, then poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Layerize text with Ideogram 3.0
+ /// Turn a flat image into an editable design: detected text is returned as
+ /// positioned text blocks with matched fonts, sizes, and colors, alongside
+ /// a text-free base image. Upload the image as `image` using
+ /// `multipart/form-data`. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -73,25 +49,13 @@ public partial interface IDesignClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Layerize the text in an image
- /// Decompose a flat image into an editable design: the text in the image
- /// is detected, erased from the image, and returned as positioned text
- /// blocks with matched fonts, sizes, and colors, alongside a text-free
- /// base image.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// A `prompt` describing the image can guide text detection; when
- /// omitted, detection runs on the image alone.
- /// By default the request blocks until layerization is complete and
- /// returns the result in `data`. Set `async` to true to return
- /// immediately after the request is accepted, then poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Layerize text with Ideogram 3.0
+ /// Turn a flat image into an editable design: detected text is returned as
+ /// positioned text blocks with matched fonts, sizes, and colors, alongside
+ /// a text-free base image. Upload the image as `image` using
+ /// `multipart/form-data`. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -101,10 +65,10 @@ public partial interface IDesignClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to layerize (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// The source image to layerize (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// /// A description of the image, used to guide text detection. When omitted, detection runs on the image alone. @@ -117,7 +81,7 @@ public partial interface IDesignClient /// Candidate font files to make available for text style matching. Supported formats .ttf, .otf, .woff, .woff2 (max 5MB each, maximum 5 files). Multipart requests only. /// /// - /// When false (the default), the request blocks until layerization is complete and returns the result in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until layerization is complete and returns the result in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdLocalizer.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdLocalizer.g.cs index 5f5b22ff..c0f1fb5f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdLocalizer.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdLocalizer.g.cs @@ -5,25 +5,13 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Rebuild an advertisement in another language
- /// Rebuilds the source advertisement for one target language. Layout,
- /// logos, brand type, and the product are preserved; the visible marketing
- /// copy is what changes.
- /// Without `exact_copy` the copy is translated. Supply `exact_copy` to
- /// place wording that has already been approved, character for character,
- /// instead of translating it.
- /// The output keeps the source advertisement's own shape and is generated
- /// at a frame derived from it, so neither the shape nor the size is asked
- /// for.
- /// One request localizes into one language. Localize into several languages
- /// by submitting one request per language.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source advertisement as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Localizer
+ /// Rebuilds an ad in one target language, preserving its layout, logos,
+ /// brand type, and product so only the visible marketing copy changes.
+ /// Upload the source ad as `image` using `multipart/form-data`; the copy
+ /// is translated unless you supply `exact_copy`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -39,25 +27,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Rebuild an advertisement in another language
- /// Rebuilds the source advertisement for one target language. Layout,
- /// logos, brand type, and the product are preserved; the visible marketing
- /// copy is what changes.
- /// Without `exact_copy` the copy is translated. Supply `exact_copy` to
- /// place wording that has already been approved, character for character,
- /// instead of translating it.
- /// The output keeps the source advertisement's own shape and is generated
- /// at a frame derived from it, so neither the shape nor the size is asked
- /// for.
- /// One request localizes into one language. Localize into several languages
- /// by submitting one request per language.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source advertisement as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Localizer
+ /// Rebuilds an ad in one target language, preserving its layout, logos,
+ /// brand type, and product so only the visible marketing copy changes.
+ /// Upload the source ad as `image` using `multipart/form-data`; the copy
+ /// is translated unless you supply `exact_copy`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -73,25 +49,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Rebuild an advertisement in another language
- /// Rebuilds the source advertisement for one target language. Layout,
- /// logos, brand type, and the product are preserved; the visible marketing
- /// copy is what changes.
- /// Without `exact_copy` the copy is translated. Supply `exact_copy` to
- /// place wording that has already been approved, character for character,
- /// instead of translating it.
- /// The output keeps the source advertisement's own shape and is generated
- /// at a frame derived from it, so neither the shape nor the size is asked
- /// for.
- /// One request localizes into one language. Localize into several languages
- /// by submitting one request per language.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source advertisement as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Localizer
+ /// Rebuilds an ad in one target language, preserving its layout, logos,
+ /// brand type, and product so only the visible marketing copy changes.
+ /// Upload the source ad as `image` using `multipart/form-data`; the copy
+ /// is translated unless you supply `exact_copy`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -101,23 +65,25 @@ public partial interface IEditWorkflowClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source advertisement to localize (max size 25MB), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Multipart requests
- /// only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source ad to localize (max size 25MB). Its layout, logos, brand
+ /// type, and product are preserved, and the output keeps its shape, so
+ /// no size or aspect ratio is needed. JPEG, PNG, and WEBP formats are
+ /// supported. Multipart requests only. /// /// - /// The source advertisement to localize (max size 25MB), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Multipart requests
- /// only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source ad to localize (max size 25MB). Its layout, logos, brand
+ /// type, and product are preserved, and the output keeps its shape, so
+ /// no size or aspect ratio is needed. JPEG, PNG, and WEBP formats are
+ /// supported. Multipart requests only. /// /// - /// The target language the copy is rebuilt in. Arabic is rendered right-to-left. + /// The target language for the copy. Arabic is rendered right-to-left. Each request covers one language; send one request per language. /// /// /// Pre-approved wording, one `original => replacement` mapping per line. Each mapping names the text element showing `original` and sets it to `replacement`, placed character for character rather than translated. Any text element not listed is left as it is in the source. When omitted, all visible marketing copy is translated. /// /// - /// Optional additional direction for the localization, for example "keep the badge in English". It takes priority over the preservation rules for anything it explicitly asks to change. + /// Optional additional direction for the localization, for example "keep the badge in English". Anything it explicitly asks to change takes priority over the preservation rules. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdResizer.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdResizer.g.cs index dfe926ca..8b30f26e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdResizer.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdResizer.g.cs @@ -5,39 +5,13 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Advertisement Resizer v2
- /// Reframes the source creative to the exact requested ad resolution,
- /// regenerating the layout so text and key elements stay legible at the
- /// target size.
- /// Supply `platform` to keep the whole advertisement clear of that
- /// platform's own interface. The advertisement is generated at the largest
- /// rectangle that fits inside the platform's published safe zone for the
- /// requested aspect ratio, placed at that rectangle's position, and the
- /// space around it is filled in so the returned image is still exactly the
- /// requested resolution. Omit `platform` and the advertisement fills the
- /// whole frame.
- /// Each platform accepts only the resolutions for which it publishes a
- /// safe zone:
- /// | Platform | Accepted resolutions |
- /// | --- | --- |
- /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `meta_stories` | `1080x1920`, `2160x3840` |
- /// | `meta_reels` | `1080x1920`, `2160x3840` |
- /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
- /// | `snapchat` | `1080x1920`, `2160x3840` |
- /// A `platform` combined with any other `resolution` is rejected with a
- /// 400. When `platform` is omitted, every resolution in the request schema
- /// is accepted.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Resizer
+ /// Reframes an ad creative to an exact ad resolution, regenerating the
+ /// layout so text and key elements stay legible at the new size. Upload
+ /// the source creative as `image` using `multipart/form-data`, and supply
+ /// `platform` to keep the ad inside that platform's safe zone.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -53,39 +27,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Advertisement Resizer v2
- /// Reframes the source creative to the exact requested ad resolution,
- /// regenerating the layout so text and key elements stay legible at the
- /// target size.
- /// Supply `platform` to keep the whole advertisement clear of that
- /// platform's own interface. The advertisement is generated at the largest
- /// rectangle that fits inside the platform's published safe zone for the
- /// requested aspect ratio, placed at that rectangle's position, and the
- /// space around it is filled in so the returned image is still exactly the
- /// requested resolution. Omit `platform` and the advertisement fills the
- /// whole frame.
- /// Each platform accepts only the resolutions for which it publishes a
- /// safe zone:
- /// | Platform | Accepted resolutions |
- /// | --- | --- |
- /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `meta_stories` | `1080x1920`, `2160x3840` |
- /// | `meta_reels` | `1080x1920`, `2160x3840` |
- /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
- /// | `snapchat` | `1080x1920`, `2160x3840` |
- /// A `platform` combined with any other `resolution` is rejected with a
- /// 400. When `platform` is omitted, every resolution in the request schema
- /// is accepted.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Resizer
+ /// Reframes an ad creative to an exact ad resolution, regenerating the
+ /// layout so text and key elements stay legible at the new size. Upload
+ /// the source creative as `image` using `multipart/form-data`, and supply
+ /// `platform` to keep the ad inside that platform's safe zone.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -101,39 +49,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Advertisement Resizer v2
- /// Reframes the source creative to the exact requested ad resolution,
- /// regenerating the layout so text and key elements stay legible at the
- /// target size.
- /// Supply `platform` to keep the whole advertisement clear of that
- /// platform's own interface. The advertisement is generated at the largest
- /// rectangle that fits inside the platform's published safe zone for the
- /// requested aspect ratio, placed at that rectangle's position, and the
- /// space around it is filled in so the returned image is still exactly the
- /// requested resolution. Omit `platform` and the advertisement fills the
- /// whole frame.
- /// Each platform accepts only the resolutions for which it publishes a
- /// safe zone:
- /// | Platform | Accepted resolutions |
- /// | --- | --- |
- /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
- /// | `meta_stories` | `1080x1920`, `2160x3840` |
- /// | `meta_reels` | `1080x1920`, `2160x3840` |
- /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
- /// | `snapchat` | `1080x1920`, `2160x3840` |
- /// A `platform` combined with any other `resolution` is rejected with a
- /// 400. When `platform` is omitted, every resolution in the request schema
- /// is accepted.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Resizer
+ /// Reframes an ad creative to an exact ad resolution, regenerating the
+ /// layout so text and key elements stay legible at the new size. Upload
+ /// the source creative as `image` using `multipart/form-data`, and supply
+ /// `platform` to keep the ad inside that platform's safe zone.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -143,33 +65,40 @@ public partial interface IEditWorkflowClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source creative to reframe (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to reframe (max size 25MB). JPEG, PNG, and
+ /// WEBP formats are supported. Multipart requests only. /// /// - /// The source creative to reframe (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to reframe (max size 25MB). JPEG, PNG, and
+ /// WEBP formats are supported. Multipart requests only. /// /// - /// Target ad resolution, formatted as `WIDTHxHEIGHT`. Must be one of
- /// the supported ad resolutions listed above; any other value is
- /// rejected with a 400. Each returned image has exactly these pixel
- /// dimensions, whether or not a `platform` was supplied. + /// Target ad resolution, formatted as `WIDTHxHEIGHT`. Any value not in
+ /// the list is rejected with a 400. Each output image has exactly these
+ /// pixel dimensions, with or without a `platform`. /// /// - /// The ad platform whose published safe zone the advertisement must
- /// stay inside. `google` covers YouTube and Google Ads placements;
- /// use `meta_stories` or `meta_reels` for the placement-specific Meta
- /// generation bounds. Reels uses the largest rectangle contained by
- /// its notched safe-zone polygon. The legacy `meta` value remains
- /// supported for existing callers with its conservative safe zone.
- /// When supplied, the advertisement is generated inside that
- /// platform's safe zone for the requested aspect ratio and the
- /// remaining space is filled in around it. When omitted, the
- /// advertisement fills the whole frame. Any other value is rejected
- /// with a 400. + /// The ad platform whose published safe zone the ad must stay inside.
+ /// The ad is generated inside the largest rectangle that fits the
+ /// platform's safe zone for the requested aspect ratio, and the space
+ /// around it is filled in so the output is still exactly the requested
+ /// `resolution`. `google` covers YouTube and Google Ads placements.
+ /// Use `meta_stories` or `meta_reels` for Meta placements; Reels uses
+ /// the largest rectangle inside its notched safe zone. The legacy
+ /// `meta` value is still supported and uses a more conservative safe
+ /// zone. When omitted, the ad fills the whole frame and every
+ /// supported `resolution` is accepted. Any other value is rejected
+ /// with a 400.
+ /// Each platform accepts only the resolutions for which it publishes a
+ /// safe zone; any other `resolution` is rejected with a 400:
+ /// | Platform | Accepted resolutions |
+ /// | --- | --- |
+ /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
+ /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
+ /// | `meta_stories` | `1080x1920`, `2160x3840` |
+ /// | `meta_reels` | `1080x1920`, `2160x3840` |
+ /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
+ /// | `snapchat` | `1080x1920`, `2160x3840` | /// /// /// Optional edit instruction to apply while reframing, for example "remove the logo" or "put the price bottom-right". diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdVariations.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdVariations.g.cs index 4a31521e..2b92b79d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdVariations.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostAdVariations.g.cs @@ -5,23 +5,13 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Advertisement Variations
- /// Generates a brand-locked creative variation of the source ad along the
- /// requested variation axis: different people, a different setting, a
- /// different group size, or a different scene. Logos, brand colors, the
- /// product, and all on-image text are preserved; only the requested axis
- /// changes.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Each returned image is generated at the source creative's own aspect
- /// ratio (the long side to short side ratio is capped at 3:1).
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Variations
+ /// Creates on-brand variations of an ad along one axis, preserving logos,
+ /// brand colors, the product, and all on-image text. Upload the source
+ /// creative as `image` using `multipart/form-data` and choose a
+ /// `variation_type`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -33,23 +23,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Advertisement Variations
- /// Generates a brand-locked creative variation of the source ad along the
- /// requested variation axis: different people, a different setting, a
- /// different group size, or a different scene. Logos, brand colors, the
- /// product, and all on-image text are preserved; only the requested axis
- /// changes.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Each returned image is generated at the source creative's own aspect
- /// ratio (the long side to short side ratio is capped at 3:1).
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Variations
+ /// Creates on-brand variations of an ad along one axis, preserving logos,
+ /// brand colors, the product, and all on-image text. Upload the source
+ /// creative as `image` using `multipart/form-data` and choose a
+ /// `variation_type`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -61,47 +41,39 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Advertisement Variations
- /// Generates a brand-locked creative variation of the source ad along the
- /// requested variation axis: different people, a different setting, a
- /// different group size, or a different scene. Logos, brand colors, the
- /// product, and all on-image text are preserved; only the requested axis
- /// changes.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. The completed generation
- /// reports the exact amount billed for the request in
- /// `usage_cost_usd_micros`.
- /// Each returned image is generated at the source creative's own aspect
- /// ratio (the long side to short side ratio is capped at 3:1).
- /// Supply the source creative as either an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or the raw image bytes directly (`image`,
- /// multipart requests only). Provide exactly one of the two forms;
- /// supplying both, or neither, is rejected with a 400. + /// Ad Variations
+ /// Creates on-brand variations of an ad along one axis, preserving logos,
+ /// brand colors, the product, and all on-image text. Upload the source
+ /// creative as `image` using `multipart/form-data` and choose a
+ /// `variation_type`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source creative to vary (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to vary (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. Multipart requests only. Each output keeps
+ /// the source's aspect ratio, capped at 3:1 between the long and short
+ /// sides. /// /// - /// The source creative to vary (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to vary (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. Multipart requests only. Each output keeps
+ /// the source's aspect ratio, capped at 3:1 between the long and short
+ /// sides. /// /// - /// The axis to vary while everything else stays on-brand. `people`
+ /// The axis to vary. `people`
/// replaces the people in the ad with different talent. `setting`
/// moves the same subject and product to a different environment.
/// `group_size` changes how many people appear. `scene` shifts the
/// moment or occasion (time of day, season, or activity). /// /// - /// Optional direction to steer the variation, for example "set it on a beach" or "make the models older". Takes priority over the default preservation rules for anything it explicitly asks to change. + /// Optional direction to steer the variation, for example "set it on a beach" or "make the models older". Anything it explicitly asks to change takes priority over the default preservation rules. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostColorways.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostColorways.g.cs index 493fc95e..42617297 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostColorways.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostColorways.g.cs @@ -5,23 +5,13 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Product Color Change
- /// Recolors the masked regions of the product photo, each to its own
- /// target color, while preserving the product's geometry, materials,
- /// prints, logos, and shading, and keeping every region outside the
- /// masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo as raw `image` bytes via
- /// `multipart/form-data`.
- /// Supply the masks marking the regions to recolor as raw `masks` bytes,
- /// paired by position with `colors` — up to 4 regions; a single-region
- /// edit is a one-item list. Every mask must have the same pixel
- /// dimensions as the product photo. White pixels mark the region to
- /// recolor; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to recolor and transparent
- /// pixels are preserved. + /// Colorways
+ /// Recolors masked regions of a product photo, each to its own target
+ /// color, preserving the product's geometry, materials, prints, logos, and
+ /// everything outside the masks. Upload the `image` and up to 4 `masks`
+ /// using `multipart/form-data`, with one entry in `colors` per mask.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -37,23 +27,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Product Color Change
- /// Recolors the masked regions of the product photo, each to its own
- /// target color, while preserving the product's geometry, materials,
- /// prints, logos, and shading, and keeping every region outside the
- /// masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo as raw `image` bytes via
- /// `multipart/form-data`.
- /// Supply the masks marking the regions to recolor as raw `masks` bytes,
- /// paired by position with `colors` — up to 4 regions; a single-region
- /// edit is a one-item list. Every mask must have the same pixel
- /// dimensions as the product photo. White pixels mark the region to
- /// recolor; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to recolor and transparent
- /// pixels are preserved. + /// Colorways
+ /// Recolors masked regions of a product photo, each to its own target
+ /// color, preserving the product's geometry, materials, prints, logos, and
+ /// everything outside the masks. Upload the `image` and up to 4 `masks`
+ /// using `multipart/form-data`, with one entry in `colors` per mask.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -69,23 +49,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Product Color Change
- /// Recolors the masked regions of the product photo, each to its own
- /// target color, while preserving the product's geometry, materials,
- /// prints, logos, and shading, and keeping every region outside the
- /// masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo as raw `image` bytes via
- /// `multipart/form-data`.
- /// Supply the masks marking the regions to recolor as raw `masks` bytes,
- /// paired by position with `colors` — up to 4 regions; a single-region
- /// edit is a one-item list. Every mask must have the same pixel
- /// dimensions as the product photo. White pixels mark the region to
- /// recolor; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to recolor and transparent
- /// pixels are preserved. + /// Colorways
+ /// Recolors masked regions of a product photo, each to its own target
+ /// color, preserving the product's geometry, materials, prints, logos, and
+ /// everything outside the masks. Upload the `image` and up to 4 `masks`
+ /// using `multipart/form-data`, with one entry in `colors` per mask.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -96,12 +66,12 @@ public partial interface IEditWorkflowClient /// `image_asset_identifier` or `image`. /// /// - /// The product photo to recolor (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to recolor (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// - /// The product photo to recolor (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to recolor (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// /// The masks marking the regions of the product photo to recolor, by
@@ -113,13 +83,12 @@ public partial interface IEditWorkflowClient /// exactly one of `mask_asset_identifiers` or `masks`. /// /// - /// The masks marking the regions of the product photo to recolor
- /// (max 4, max size 25MB each), as raw bytes, paired by position with
- /// `colors`; only JPEG, PNG, and WEBP formats are supported. Every
- /// mask must have the same pixel dimensions as the product photo.
- /// White pixels mark the region to recolor; black pixels are
- /// preserved. Alpha-only masks are also supported: opaque pixels
- /// mark the region to recolor and transparent pixels are preserved. + /// Masks marking the regions to recolor (max 4, max size 25MB each),
+ /// paired by position with `colors`. JPEG, PNG, and WEBP formats are
+ /// supported. Every mask must have the same pixel dimensions as the
+ /// product photo. White pixels mark the region to recolor and black
+ /// pixels are preserved; alpha-only masks also work (opaque =
+ /// recolor, transparent = preserve). /// /// /// One target color per mask in `masks`, as six-digit hex codes like
@@ -127,12 +96,11 @@ public partial interface IEditWorkflowClient /// materials, prints, and logos are always preserved. /// /// - /// The aspect ratio of the generated image. Defaults to the aspect
- /// ratio of the product photo when omitted, which preserves the
- /// original framing exactly. When a different ratio is requested, the
- /// scene is extended to fill the new shape rather than cropped, so
- /// part of the frame is newly generated. Supported values are `1:1`,
- /// `3:4`, `4:3`, `16:9`, and `9:16`. + /// Output aspect ratio. Defaults to the product photo's aspect ratio,
+ /// which keeps the original framing. A different ratio extends the
+ /// scene to fill the new shape rather than cropping, so part of the
+ /// frame is newly generated. Supported values are `1:1`, `3:4`,
+ /// `4:3`, `16:9`, and `9:16`. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostGhostMannequin.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostGhostMannequin.g.cs index 7a1cad60..fdd7e738 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostGhostMannequin.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostGhostMannequin.g.cs @@ -5,19 +5,14 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Create ghost-mannequin garment photography
- /// Transforms one or more photographs of the same garment into a polished
- /// ghost-mannequin product image on a clean white studio background. The
- /// garment keeps its identity and construction while the source person,
- /// mannequin, hanger, environment, and other clothing are removed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply one or more garment references. Use the directional fields when
- /// the camera direction is known; each direction accepts either an
- /// existing `AssetIdentifier` or one raw image, but not both. Additional
- /// unlabeled references can be supplied through exactly one transport:
- /// `garment_asset_identifiers`, or multipart `garment_images`. + /// Ghost Mannequin
+ /// Turns photos of one garment into a ghost-mannequin product image on a
+ /// clean white studio background, removing the person, mannequin, hanger,
+ /// and other clothing. Upload the photos using `multipart/form-data`, in
+ /// the directional fields (such as `front_image`) when the camera
+ /// direction is known and in `garment_images` otherwise.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -33,19 +28,14 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Create ghost-mannequin garment photography
- /// Transforms one or more photographs of the same garment into a polished
- /// ghost-mannequin product image on a clean white studio background. The
- /// garment keeps its identity and construction while the source person,
- /// mannequin, hanger, environment, and other clothing are removed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply one or more garment references. Use the directional fields when
- /// the camera direction is known; each direction accepts either an
- /// existing `AssetIdentifier` or one raw image, but not both. Additional
- /// unlabeled references can be supplied through exactly one transport:
- /// `garment_asset_identifiers`, or multipart `garment_images`. + /// Ghost Mannequin
+ /// Turns photos of one garment into a ghost-mannequin product image on a
+ /// clean white studio background, removing the person, mannequin, hanger,
+ /// and other clothing. Upload the photos using `multipart/form-data`, in
+ /// the directional fields (such as `front_image`) when the camera
+ /// direction is known and in `garment_images` otherwise.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -61,19 +51,14 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Create ghost-mannequin garment photography
- /// Transforms one or more photographs of the same garment into a polished
- /// ghost-mannequin product image on a clean white studio background. The
- /// garment keeps its identity and construction while the source person,
- /// mannequin, hanger, environment, and other clothing are removed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply one or more garment references. Use the directional fields when
- /// the camera direction is known; each direction accepts either an
- /// existing `AssetIdentifier` or one raw image, but not both. Additional
- /// unlabeled references can be supplied through exactly one transport:
- /// `garment_asset_identifiers`, or multipart `garment_images`. + /// Ghost Mannequin
+ /// Turns photos of one garment into a ghost-mannequin product image on a
+ /// clean white studio background, removing the person, mannequin, hanger,
+ /// and other clothing. Upload the photos using `multipart/form-data`, in
+ /// the directional fields (such as `front_image`) when the camera
+ /// direction is known and in `garment_images` otherwise.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -85,98 +70,95 @@ public partial interface IEditWorkflowClient /// `garment_images`. /// /// - /// Raw images of the same garment, up to 50 MB each. JPEG, PNG, WEBP,
- /// HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart
- /// requests only. Mutually exclusive with
- /// `garment_asset_identifiers`. + /// Additional photos of the same garment, up to 50 MB each. JPEG,
+ /// PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported.
+ /// Multipart requests only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw front-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `front_asset_identifier`. + /// Optional front-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw front-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `front_asset_identifier`. + /// Optional front-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw back-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `back_asset_identifier`. + /// Optional back-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw back-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `back_asset_identifier`. + /// Optional back-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw left-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `left_asset_identifier`. + /// Optional left-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw left-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `left_asset_identifier`. + /// Optional left-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw right-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `right_asset_identifier`. + /// Optional right-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw right-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `right_asset_identifier`. + /// Optional right-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw top-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `top_asset_identifier`. + /// Optional top-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw top-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `top_asset_identifier`. + /// Optional top-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw bottom-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with
- /// `bottom_asset_identifier`. + /// Optional bottom-view garment photo, up to 50 MB. Multipart
+ /// requests only. /// /// - /// Optional raw bottom-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with
- /// `bottom_asset_identifier`. + /// Optional bottom-view garment photo, up to 50 MB. Multipart
+ /// requests only. /// /// /// Camera view for the output garment. /// /// /// Optional reconstruction guidance or identity-critical garment
- /// details for the analyzer to verify. The output always uses the
- /// workflow's clean white studio presentation. + /// details to check against the photos. The output always uses a clean
+ /// white studio background. /// /// /// Optional JSON object serialized as a string containing factual
/// product context, such as title, brand, category, color, material,
/// item code, and exact printed text. Metadata helps disambiguate the
- /// garment references but does not add unsupported visual features. + /// garment photos but does not add features they do not show. /// /// /// Output aspect ratio. Defaults to `1:1` when omitted. Supported
diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostLookbook.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostLookbook.g.cs index 79447f7a..aa549c8e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostLookbook.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostLookbook.g.cs @@ -10,7 +10,7 @@ public partial interface IEditWorkflowClient /// references and an aesthetic reference. Each generated shoot is returned
/// as four individual lookbook images.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. ///
/// @@ -28,7 +28,7 @@ public partial interface IEditWorkflowClient /// references and an aesthetic reference. Each generated shoot is returned
/// as four individual lookbook images.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. ///
/// @@ -46,7 +46,7 @@ public partial interface IEditWorkflowClient /// references and an aesthetic reference. Each generated shoot is returned
/// as four individual lookbook images.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. ///
/// diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostMaterialSwap.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostMaterialSwap.g.cs index 10099961..1646b031 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostMaterialSwap.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostMaterialSwap.g.cs @@ -5,24 +5,13 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Product Material Change
- /// Re-renders the masked regions of the product photo in the materials
- /// shown by the reference images — matching each one's color, texture,
- /// pattern scale, and orientation — while preserving the product's
- /// silhouette, construction, seams, and shading, and keeping every region
- /// outside the masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo, the masks marking the regions to
- /// re-material, and the material reference images as raw bytes (`image`,
- /// `masks`, and `materials`) via `multipart/form-data` — up to 4 masks; a
- /// single-region edit is a one-item list. Every mask must have the same
- /// pixel dimensions as the product photo. White pixels mark the region to
- /// change; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to change and transparent
- /// pixels are preserved. Send either one material, which every mask
- /// takes, or exactly one material per mask, paired by position. + /// Material Swap
+ /// Re-renders masked regions of a product photo in the materials shown in
+ /// reference images, preserving the product's construction and everything
+ /// outside the masks. Upload the `image`, up to 4 `masks`, and the
+ /// `materials` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -38,24 +27,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Product Material Change
- /// Re-renders the masked regions of the product photo in the materials
- /// shown by the reference images — matching each one's color, texture,
- /// pattern scale, and orientation — while preserving the product's
- /// silhouette, construction, seams, and shading, and keeping every region
- /// outside the masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo, the masks marking the regions to
- /// re-material, and the material reference images as raw bytes (`image`,
- /// `masks`, and `materials`) via `multipart/form-data` — up to 4 masks; a
- /// single-region edit is a one-item list. Every mask must have the same
- /// pixel dimensions as the product photo. White pixels mark the region to
- /// change; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to change and transparent
- /// pixels are preserved. Send either one material, which every mask
- /// takes, or exactly one material per mask, paired by position. + /// Material Swap
+ /// Re-renders masked regions of a product photo in the materials shown in
+ /// reference images, preserving the product's construction and everything
+ /// outside the masks. Upload the `image`, up to 4 `masks`, and the
+ /// `materials` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -71,24 +49,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Product Material Change
- /// Re-renders the masked regions of the product photo in the materials
- /// shown by the reference images — matching each one's color, texture,
- /// pattern scale, and orientation — while preserving the product's
- /// silhouette, construction, seams, and shading, and keeping every region
- /// outside the masks unchanged.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the product photo, the masks marking the regions to
- /// re-material, and the material reference images as raw bytes (`image`,
- /// `masks`, and `materials`) via `multipart/form-data` — up to 4 masks; a
- /// single-region edit is a one-item list. Every mask must have the same
- /// pixel dimensions as the product photo. White pixels mark the region to
- /// change; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to change and transparent
- /// pixels are preserved. Send either one material, which every mask
- /// takes, or exactly one material per mask, paired by position. + /// Material Swap
+ /// Re-renders masked regions of a product photo in the materials shown in
+ /// reference images, preserving the product's construction and everything
+ /// outside the masks. Upload the `image`, up to 4 `masks`, and the
+ /// `materials` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Default Value: false @@ -99,12 +66,12 @@ public partial interface IEditWorkflowClient /// `image_asset_identifier` or `image`. /// /// - /// The product photo to edit (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to edit (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// - /// The product photo to edit (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to edit (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// /// The masks marking the regions of the product photo to change, by
@@ -116,13 +83,11 @@ public partial interface IEditWorkflowClient /// `masks`. /// /// - /// The masks marking the regions of the product photo to change (max
- /// 4, max size 25MB each), as raw bytes; only JPEG, PNG, and WEBP
- /// formats are supported. Every mask must have the same pixel
- /// dimensions as the product photo. White pixels mark the region to
- /// change; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to change and transparent
- /// pixels are preserved. + /// Masks marking the regions to change (max 4, max size 25MB each).
+ /// JPEG, PNG, and WEBP formats are supported. Every mask must have the
+ /// same pixel dimensions as the product photo. White pixels mark the
+ /// region to change and black pixels are preserved; alpha-only masks
+ /// also work (opaque = change, transparent = preserve). /// /// /// The material reference images, by reference. Only their material —
@@ -132,19 +97,18 @@ public partial interface IEditWorkflowClient /// `material_asset_identifiers` or `materials`. /// /// - /// The material reference images (max size 25MB each), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Only their material
- /// — color, texture, pattern scale, and orientation — is applied to
- /// the masked regions. Send one material, which every mask takes, or
- /// exactly one per mask paired by position. + /// Material reference images (max size 25MB each). JPEG, PNG, and WEBP
+ /// formats are supported. Only their material (color, texture, pattern
+ /// scale, and orientation) is applied to the masked regions. Send one
+ /// material for every mask, or exactly one per mask, paired by
+ /// position. /// /// - /// The aspect ratio of the generated image. Defaults to the aspect
- /// ratio of the product photo when omitted, which preserves the
- /// original framing exactly. When a different ratio is requested, the
- /// scene is extended to fill the new shape rather than cropped, so
- /// part of the frame is newly generated. Supported values are `1:1`,
- /// `3:4`, `4:3`, `16:9`, and `9:16`. + /// Output aspect ratio. Defaults to the product photo's aspect ratio,
+ /// which keeps the original framing. A different ratio extends the
+ /// scene to fill the new shape rather than cropping, so part of the
+ /// frame is newly generated. Supported values are `1:1`, `3:4`,
+ /// `4:3`, `16:9`, and `9:16`. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostModelPoseVariants.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostModelPoseVariants.g.cs index 46879761..02d51327 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostModelPoseVariants.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostModelPoseVariants.g.cs @@ -5,18 +5,13 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Generate pose variants of a fashion image
- /// Changes the model's pose or camera presentation while preserving the
- /// source model, garment, styling, and scene. An optional pose-reference
- /// image supplies body pose and gaze only; it does not supply identity,
- /// clothing, or styling.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source as either an `AssetIdentifier` reference
- /// (`source_asset_identifier`) or raw image bytes (`source_image`,
- /// multipart requests only). Provide exactly one source form; supplying
- /// both, or neither, is rejected with a 400. + /// Model Pose Variants
+ /// Changes the model's pose or camera angle in a fashion image while
+ /// preserving the model, garment, styling, and scene. Upload the
+ /// `source_image` using `multipart/form-data` and describe the new pose in
+ /// `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -28,18 +23,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate pose variants of a fashion image
- /// Changes the model's pose or camera presentation while preserving the
- /// source model, garment, styling, and scene. An optional pose-reference
- /// image supplies body pose and gaze only; it does not supply identity,
- /// clothing, or styling.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source as either an `AssetIdentifier` reference
- /// (`source_asset_identifier`) or raw image bytes (`source_image`,
- /// multipart requests only). Provide exactly one source form; supplying
- /// both, or neither, is rejected with a 400. + /// Model Pose Variants
+ /// Changes the model's pose or camera angle in a fashion image while
+ /// preserving the model, garment, styling, and scene. Upload the
+ /// `source_image` using `multipart/form-data` and describe the new pose in
+ /// `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -51,42 +41,35 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate pose variants of a fashion image
- /// Changes the model's pose or camera presentation while preserving the
- /// source model, garment, styling, and scene. An optional pose-reference
- /// image supplies body pose and gaze only; it does not supply identity,
- /// clothing, or styling.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply the source as either an `AssetIdentifier` reference
- /// (`source_asset_identifier`) or raw image bytes (`source_image`,
- /// multipart requests only). Provide exactly one source form; supplying
- /// both, or neither, is rejected with a 400. + /// Model Pose Variants
+ /// Changes the model's pose or camera angle in a fashion image while
+ /// preserving the model, garment, styling, and scene. Upload the
+ /// `source_image` using `multipart/form-data` and describe the new pose in
+ /// `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Fashion image to edit (max size 50MB), as raw bytes. JPEG, PNG,
- /// WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported.
- /// Multipart requests only. Provide exactly one of
- /// `source_asset_identifier` or `source_image`. + /// Fashion image to edit (max size 50MB). JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart
+ /// requests only. /// /// - /// Fashion image to edit (max size 50MB), as raw bytes. JPEG, PNG,
- /// WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported.
- /// Multipart requests only. Provide exactly one of
- /// `source_asset_identifier` or `source_image`. + /// Fashion image to edit (max size 50MB). JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart
+ /// requests only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Required plain-language pose or camera direction, such as a
- /// front-facing catalog stance or right-facing walking profile. + /// Plain-language pose or camera direction, such as a front-facing
+ /// catalog stance or right-facing walking profile. /// /// /// Output aspect ratio. When omitted, the nearest supported ratio is
diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostModelSwap.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostModelSwap.g.cs index e488bd40..c8876651 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostModelSwap.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostModelSwap.g.cs @@ -5,16 +5,13 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Replace the model in a commerce image
- /// Re-casts a fashion commerce image with the identity shown in one or
- /// more ordered target-model references. The workflow uses the working
- /// image for the product, pose, scene, lighting, framing, and camera, and
- /// uses the target references only for identity, hair, skin tone, and body
- /// proportions. Results are full-frame edits; exact pixel preservation is
- /// not guaranteed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. + /// Model Swap
+ /// Replaces the model in a fashion image with the person shown in one to
+ /// four target-model references, keeping the product, pose, scene,
+ /// lighting, and framing. Upload the working image as `source_image` using
+ /// `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -26,16 +23,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Replace the model in a commerce image
- /// Re-casts a fashion commerce image with the identity shown in one or
- /// more ordered target-model references. The workflow uses the working
- /// image for the product, pose, scene, lighting, framing, and camera, and
- /// uses the target references only for identity, hair, skin tone, and body
- /// proportions. Results are full-frame edits; exact pixel preservation is
- /// not guaranteed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. + /// Model Swap
+ /// Replaces the model in a fashion image with the person shown in one to
+ /// four target-model references, keeping the product, pose, scene,
+ /// lighting, and framing. Upload the working image as `source_image` using
+ /// `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -47,26 +41,23 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Replace the model in a commerce image
- /// Re-casts a fashion commerce image with the identity shown in one or
- /// more ordered target-model references. The workflow uses the working
- /// image for the product, pose, scene, lighting, framing, and camera, and
- /// uses the target references only for identity, hair, skin tone, and body
- /// proportions. Results are full-frame edits; exact pixel preservation is
- /// not guaranteed.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed. + /// Model Swap
+ /// Replaces the model in a fashion image with the person shown in one to
+ /// four target-model references, keeping the product, pose, scene,
+ /// lighting, and framing. Upload the working image as `source_image` using
+ /// `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw working-image bytes. Supported formats and the 50 MB limit match the image upload API. Available only with `multipart/form-data`. + /// The working image whose product, pose, scene, lighting, framing, and camera are preserved. Supported formats and the 50 MB limit match the image upload API. Multipart requests only. /// /// - /// Raw working-image bytes. Supported formats and the 50 MB limit match the image upload API. Available only with `multipart/form-data`. + /// The working image whose product, pose, scene, lighting, framing, and camera are preserved. Supported formats and the 50 MB limit match the image upload API. Multipart requests only. /// /// /// Ordered target-model identity and angle references. These images supply only identity, hair, skin tone, and body proportions. diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostPackshots.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostPackshots.g.cs index c93ee772..98a96829 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostPackshots.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostPackshots.g.cs @@ -5,12 +5,12 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Create marketplace-ready product packshots
+ /// Packshots
/// Creates one polished product photograph from one or more ordered product
/// references. An optional style reference may guide framing, crop,
/// background, and lighting without changing the product's identity.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. Product fidelity is
/// best-effort and details absent from every reference may be reconstructed. ///
@@ -24,12 +24,12 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Create marketplace-ready product packshots
+ /// Packshots
/// Creates one polished product photograph from one or more ordered product
/// references. An optional style reference may guide framing, crop,
/// background, and lighting without changing the product's identity.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. Product fidelity is
/// best-effort and details absent from every reference may be reconstructed. ///
@@ -43,12 +43,12 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Create marketplace-ready product packshots
+ /// Packshots
/// Creates one polished product photograph from one or more ordered product
/// references. An optional style reference may guide framing, crop,
/// background, and lighting without changing the product's identity.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. Product fidelity is
/// best-effort and details absent from every reference may be reconstructed. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostPreciseMaskedEdit.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostPreciseMaskedEdit.g.cs index 9b1bddc1..c4cdf90f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostPreciseMaskedEdit.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostPreciseMaskedEdit.g.cs @@ -12,7 +12,7 @@ public partial interface IEditWorkflowClient /// `preserve_unmasked_pixels` to keep decoded pixels outside a supplied mask
/// unchanged in the final image.
/// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. ///
/// @@ -32,7 +32,7 @@ public partial interface IEditWorkflowClient /// `preserve_unmasked_pixels` to keep decoded pixels outside a supplied mask
/// unchanged in the final image.
/// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. ///
/// @@ -52,7 +52,7 @@ public partial interface IEditWorkflowClient /// `preserve_unmasked_pixels` to keep decoded pixels outside a supplied mask
/// unchanged in the final image.
/// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed. ///
/// diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSkechersStyleEdit.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSkechersStyleEdit.g.cs index add43bde..4df6f99c 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSkechersStyleEdit.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSkechersStyleEdit.g.cs @@ -10,7 +10,7 @@ public partial interface IEditWorkflowClient /// change. Image 1 is the base; reference images are numbered from image 2
/// in the supplied order. Resolve image mentions to these numbers before
/// submitting. Descriptions identify the selected view or reference.
- /// Poll GET /v1/generations/{generation_id} with the returned generation_id
+ /// Poll GET /v2/generations/{generation_id} with the returned generation_id
/// until the workflow completes or fails. /// /// @@ -28,7 +28,7 @@ public partial interface IEditWorkflowClient /// change. Image 1 is the base; reference images are numbered from image 2
/// in the supplied order. Resolve image mentions to these numbers before
/// submitting. Descriptions identify the selected view or reference.
- /// Poll GET /v1/generations/{generation_id} with the returned generation_id
+ /// Poll GET /v2/generations/{generation_id} with the returned generation_id
/// until the workflow completes or fails. /// /// @@ -46,7 +46,7 @@ public partial interface IEditWorkflowClient /// change. Image 1 is the base; reference images are numbered from image 2
/// in the supplied order. Resolve image mentions to these numbers before
/// submitting. Descriptions identify the selected view or reference.
- /// Poll GET /v1/generations/{generation_id} with the returned generation_id
+ /// Poll GET /v2/generations/{generation_id} with the returned generation_id
/// until the workflow completes or fails. /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSketchToRender.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSketchToRender.g.cs index 41e9072b..c2523daf 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSketchToRender.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSketchToRender.g.cs @@ -5,16 +5,13 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Render a fashion sketch as product photography
- /// Converts one fashion sketch into photorealistic garment or product
- /// imagery while preserving its silhouette, construction, colors, and
- /// visible design details.
- /// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one sketch transport: an existing `AssetIdentifier` in
- /// `sketch_asset_identifier`, or raw `sketch_image` bytes in a multipart
- /// request. Supplying both or neither is rejected with a 400. + /// Sketch to Render
+ /// Turns a fashion sketch into photorealistic garment or product imagery,
+ /// preserving its silhouette, construction, colors, and design details.
+ /// Upload the `sketch_image` using `multipart/form-data` and describe
+ /// materials and rendering in `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -26,16 +23,13 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Render a fashion sketch as product photography
- /// Converts one fashion sketch into photorealistic garment or product
- /// imagery while preserving its silhouette, construction, colors, and
- /// visible design details.
- /// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one sketch transport: an existing `AssetIdentifier` in
- /// `sketch_asset_identifier`, or raw `sketch_image` bytes in a multipart
- /// request. Supplying both or neither is rejected with a 400. + /// Sketch to Render
+ /// Turns a fashion sketch into photorealistic garment or product imagery,
+ /// preserving its silhouette, construction, colors, and design details.
+ /// Upload the `sketch_image` using `multipart/form-data` and describe
+ /// materials and rendering in `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -47,34 +41,31 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Render a fashion sketch as product photography
- /// Converts one fashion sketch into photorealistic garment or product
- /// imagery while preserving its silhouette, construction, colors, and
- /// visible design details.
- /// The request runs asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one sketch transport: an existing `AssetIdentifier` in
- /// `sketch_asset_identifier`, or raw `sketch_image` bytes in a multipart
- /// request. Supplying both or neither is rejected with a 400. + /// Sketch to Render
+ /// Turns a fashion sketch into photorealistic garment or product imagery,
+ /// preserving its silhouette, construction, colors, and design details.
+ /// Upload the `sketch_image` using `multipart/form-data` and describe
+ /// materials and rendering in `instruction`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}` or
+ /// supply a `webhook_url`. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw fashion-sketch bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only.
- /// Mutually exclusive with `sketch_asset_identifier`. + /// The fashion sketch to render, up to 50 MB. JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart requests
+ /// only. /// /// - /// Raw fashion-sketch bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only.
- /// Mutually exclusive with `sketch_asset_identifier`. + /// The fashion sketch to render, up to 50 MB. JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart requests
+ /// only. /// /// - /// Required material and rendering direction, plus any construction
- /// or design details that are not legible in the sketch. + /// Material and rendering direction, plus any construction or design
+ /// details that are not legible in the sketch. /// /// /// Aspect ratio of each output image. Defaults to `1:1` when omitted. diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSoleSwap.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSoleSwap.g.cs index e30124fb..b7dfb099 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSoleSwap.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSoleSwap.g.cs @@ -5,11 +5,11 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Transfer a shoe upper onto a preserved sole
+ /// Sole Swap
/// Uses the sole-donor shoe as the output canvas, preserving its sole, camera,
/// background, and lighting while transferring the upper from ordered references.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned
+ /// `GET /v2/generations/{generation_id}` with the returned
/// `generation_id` until the generation is completed or failed. ///
/// @@ -22,11 +22,11 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Transfer a shoe upper onto a preserved sole
+ /// Sole Swap
/// Uses the sole-donor shoe as the output canvas, preserving its sole, camera,
/// background, and lighting while transferring the upper from ordered references.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned
+ /// `GET /v2/generations/{generation_id}` with the returned
/// `generation_id` until the generation is completed or failed. ///
/// @@ -39,11 +39,11 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Transfer a shoe upper onto a preserved sole
+ /// Sole Swap
/// Uses the sole-donor shoe as the output canvas, preserving its sole, camera,
/// background, and lighting while transferring the upper from ordered references.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned
+ /// `GET /v2/generations/{generation_id}` with the returned
/// `generation_id` until the generation is completed or failed. ///
/// diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwanSLogoDesign.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwanSLogoDesign.g.cs index b527ee3d..0c465599 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwanSLogoDesign.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwanSLogoDesign.g.cs @@ -6,7 +6,7 @@ public partial interface IEditWorkflowClient { /// /// Design one Swan S logo candidate
- /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -19,7 +19,7 @@ public partial interface IEditWorkflowClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Design one Swan S logo candidate
- /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -32,7 +32,7 @@ public partial interface IEditWorkflowClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Design one Swan S logo candidate
- /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwanSLogoInstall.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwanSLogoInstall.g.cs index 2eba2ede..de6538d7 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwanSLogoInstall.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwanSLogoInstall.g.cs @@ -6,7 +6,7 @@ public partial interface IEditWorkflowClient { /// /// Install a Swan S logo on a shoe
- /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -19,7 +19,7 @@ public partial interface IEditWorkflowClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Install a Swan S logo on a shoe
- /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -32,7 +32,7 @@ public partial interface IEditWorkflowClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Install a Swan S logo on a shoe
- /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed. + /// Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed. ///
/// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwapProduct.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwapProduct.g.cs index 37c7f4b8..c1e71878 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwapProduct.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostSwapProduct.g.cs @@ -5,9 +5,9 @@ namespace Ideogram public partial interface IEditWorkflowClient { /// - /// Replace or recolor footwear in an advertisement
+ /// Swap Product
/// Edits the footwear in a source advertisement using ordered product references.
- /// Poll `GET /v1/generations/{generation_id}` for status and image results. + /// Poll `GET /v2/generations/{generation_id}` for status and image results. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -19,9 +19,9 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Replace or recolor footwear in an advertisement
+ /// Swap Product
/// Edits the footwear in a source advertisement using ordered product references.
- /// Poll `GET /v1/generations/{generation_id}` for status and image results. + /// Poll `GET /v2/generations/{generation_id}` for status and image results. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -33,9 +33,9 @@ public partial interface IEditWorkflowClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Replace or recolor footwear in an advertisement
+ /// Swap Product
/// Edits the footwear in a source advertisement using ordered product references.
- /// Poll `GET /v1/generations/{generation_id}` for status and image results. + /// Poll `GET /v2/generations/{generation_id}` for status and image results. ///
/// /// An identifier for an ideogram asset.
diff --git a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostVirtualTryOn.g.cs b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostVirtualTryOn.g.cs index ac860d48..b398578e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostVirtualTryOn.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IEditWorkflowClient.PostVirtualTryOn.g.cs @@ -10,7 +10,7 @@ public partial interface IEditWorkflowClient /// wearing the supplied garments, preserving their face, body, and
/// background.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed.
/// Supply the person as either an `AssetIdentifier` reference
/// (`person_asset_identifier`) or the raw image bytes directly
@@ -34,7 +34,7 @@ public partial interface IEditWorkflowClient /// wearing the supplied garments, preserving their face, body, and
/// background.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed.
/// Supply the person as either an `AssetIdentifier` reference
/// (`person_asset_identifier`) or the raw image bytes directly
@@ -58,7 +58,7 @@ public partial interface IEditWorkflowClient /// wearing the supplied garments, preserving their face, body, and
/// background.
/// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
/// until the generation is completed or failed.
/// Supply the person as either an `AssetIdentifier` reference
/// (`person_asset_identifier`) or the raw image bytes directly
diff --git a/src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.Authorizations.Bearer.g.cs b/src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.Authorizations.Bearer.g.cs new file mode 100644 index 00000000..362b90c1 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.Authorizations.Bearer.g.cs @@ -0,0 +1,16 @@ + +#nullable enable + +namespace Ideogram +{ + public partial interface IGenerationsClient + { + /// + /// Authorize using bearer authentication. + /// + /// + + public void AuthorizeUsingBearer( + string apiKey); + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.GetGenerationV2.g.cs b/src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.GetGenerationV2.g.cs new file mode 100644 index 00000000..d785a6bf --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.GetGenerationV2.g.cs @@ -0,0 +1,56 @@ +#nullable enable + +namespace Ideogram +{ + public partial interface IGenerationsClient + { + /// + /// Poll a generation
+ /// Retrieves the current status of an asynchronous generation, and its
+ /// results once complete. Use the `generation_id` returned by any `/v2`
+ /// endpoint that runs asynchronously: every video and tool endpoint, and
+ /// any image endpoint called with `async` or a `webhook_url`.
+ /// While the generation is `pending` or has `failed`, the response
+ /// contains only `generation_id`, `status`, and `created` (plus
+ /// `failure_reason` once failed). Once `status` is `completed`, the
+ /// response includes `response_type` and `data`. Each `data` item carries
+ /// an `object_type` that identifies its shape, so image and video results
+ /// can be told apart. `usage_cost_usd_micros` reports the amount billed
+ /// when the request uses variable usage-based pricing.
+ /// Polling is rate limited per organization; a 429 response carries a
+ /// `Retry-After` header with the number of seconds to wait. + ///
+ /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + global::System.Threading.Tasks.Task GetGenerationV2Async( + string generationId, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default); + /// + /// Poll a generation
+ /// Retrieves the current status of an asynchronous generation, and its
+ /// results once complete. Use the `generation_id` returned by any `/v2`
+ /// endpoint that runs asynchronously: every video and tool endpoint, and
+ /// any image endpoint called with `async` or a `webhook_url`.
+ /// While the generation is `pending` or has `failed`, the response
+ /// contains only `generation_id`, `status`, and `created` (plus
+ /// `failure_reason` once failed). Once `status` is `completed`, the
+ /// response includes `response_type` and `data`. Each `data` item carries
+ /// an `object_type` that identifies its shape, so image and video results
+ /// can be told apart. `usage_cost_usd_micros` reports the amount billed
+ /// when the request uses variable usage-based pricing.
+ /// Polling is rate limited per organization; a 429 response carries a
+ /// `Retry-After` header with the number of seconds to wait. + ///
+ /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + global::System.Threading.Tasks.Task> GetGenerationV2AsResponseAsync( + string generationId, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default); + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.g.cs new file mode 100644 index 00000000..3d06d3e8 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.IGenerationsClient.g.cs @@ -0,0 +1,48 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// If no httpClient is provided, a new one will be created.
+ /// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. + ///
+ public partial interface IGenerationsClient : global::System.IDisposable + { + /// + /// The HttpClient instance. + /// + public global::System.Net.Http.HttpClient HttpClient { get; } + + /// + /// The base URL for the API. + /// + public System.Uri? BaseUri { get; } + + /// + /// The authorizations to use for the requests. + /// + public global::System.Collections.Generic.List Authorizations { get; } + + /// + /// Gets or sets a value indicating whether the response content should be read as a string. + /// True by default in debug builds, false otherwise. + /// When false, successful responses are deserialized directly from the response stream for better performance. + /// Error responses are always read as strings regardless of this setting, + /// ensuring is populated. + /// + public bool ReadResponseAsString { get; set; } + /// + /// Client-wide request defaults such as headers, query parameters, retries, and timeout. + /// + public global::Ideogram.AutoSDKClientOptions Options { get; } + + + /// + /// + /// + global::System.Text.Json.Serialization.JsonSerializerContext JsonSerializerContext { get; set; } + + + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.IIdeogramClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.IIdeogramClient.g.cs index c5abab70..05a76af9 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IIdeogramClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IIdeogramClient.g.cs @@ -50,10 +50,15 @@ public partial interface IIdeogramClient : global::System.IDisposable /// public AccountClient Account { get; } + /// + /// + /// + public AssetReferenceUsageClient AssetReferenceUsage { get; } + /// /// Model-agnostic endpoints where the server selects the model for each
/// request. Requests are JSON and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`. + /// polled via `GET /v2/generations/{generation_id}`. ///
public AutoModelClient AutoModel { get; } @@ -82,6 +87,11 @@ public partial interface IIdeogramClient : global::System.IDisposable /// public GenerateClient Generate { get; } + /// + /// + /// + public GenerationsClient Generations { get; } + /// /// /// @@ -91,15 +101,12 @@ public partial interface IIdeogramClient : global::System.IDisposable /// Generate images with a specific model contract. Requests are JSON
/// (Ideogram 3.0 also accepts multipart for style reference bytes) and
/// return a generation id that can be polled via
- /// `GET /v1/generations/{generation_id}`. + /// `GET /v2/generations/{generation_id}`. /// public ImagesGenerateClient ImagesGenerate { get; } /// - /// Repaint a masked region of an image with a specific model contract.
- /// Requests supply the source image and mask by `AssetIdentifier`
- /// reference or as uploaded bytes and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`. + /// Repaint a masked region of an image with a specific model. ///
public ImagesInpaintClient ImagesInpaint { get; } @@ -115,10 +122,7 @@ public partial interface IIdeogramClient : global::System.IDisposable public ImagesReframeClient ImagesReframe { get; } /// - /// Transform an existing image with a specific model contract, guided by
- /// a prompt. Requests supply the source by `AssetIdentifier` reference or
- /// as uploaded bytes, and return a generation id that can be polled via
- /// `GET /v1/generations/{generation_id}`. + /// Transform an image with a specific model, guided by a prompt. ///
public ImagesRemixClient ImagesRemix { get; } @@ -153,9 +157,8 @@ public partial interface IIdeogramClient : global::System.IDisposable public ModelsClient Models { get; } /// - /// Remove unwanted objects from existing image assets. Requests use
- /// `AssetIdentifier` references and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`. + /// Remove unwanted objects from an image. Requests return a generation id
+ /// to poll with `GET /v2/generations/{generation_id}`. ///
public ObjectRemovalClient ObjectRemoval { get; } diff --git a/src/libs/Ideogram/Generated/Ideogram.IImageDescribeClient.PostDescribeImageIdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImageDescribeClient.PostDescribeImageIdeogramV3.g.cs index 608aa621..e3a137bc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImageDescribeClient.PostDescribeImageIdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImageDescribeClient.PostDescribeImageIdeogramV3.g.cs @@ -6,14 +6,10 @@ public partial interface IImageDescribeClient { /// /// Describe with Ideogram 3.0
- /// Generate a natural-language description of an image using Ideogram's
- /// 3.0-generation image captioner (a fine-tune of the Qwen2-VL
- /// vision-language model).
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Generate a natural-language description of an image with Ideogram's 3.0
+ /// image captioner (a fine-tune of the Qwen2-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the description
+ /// is returned directly. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -26,14 +22,10 @@ public partial interface IImageDescribeClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Describe with Ideogram 3.0
- /// Generate a natural-language description of an image using Ideogram's
- /// 3.0-generation image captioner (a fine-tune of the Qwen2-VL
- /// vision-language model).
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Generate a natural-language description of an image with Ideogram's 3.0
+ /// image captioner (a fine-tune of the Qwen2-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the description
+ /// is returned directly. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -46,24 +38,20 @@ public partial interface IImageDescribeClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Describe with Ideogram 3.0
- /// Generate a natural-language description of an image using Ideogram's
- /// 3.0-generation image captioner (a fine-tune of the Qwen2-VL
- /// vision-language model).
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Generate a natural-language description of an image with Ideogram's 3.0
+ /// image captioner (a fine-tune of the Qwen2-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the description
+ /// is returned directly. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. /// The token to cancel the operation with diff --git a/src/libs/Ideogram/Generated/Ideogram.IImageDescribeClient.PostDescribeImageIdeogramV4.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImageDescribeClient.PostDescribeImageIdeogramV4.g.cs index a0836959..796af326 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImageDescribeClient.PostDescribeImageIdeogramV4.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImageDescribeClient.PostDescribeImageIdeogramV4.g.cs @@ -6,17 +6,11 @@ public partial interface IImageDescribeClient { /// /// Describe with Ideogram 4.0
- /// Describe an image using Ideogram's 4.0-generation image captioner (a
- /// fine-tune of the Qwen3-VL vision-language model) and return a
- /// structured `V4JsonPrompt`. The
- /// returned `json_prompt` is a working JSON prompt that can be passed
- /// directly as `json_prompt` to the `/v1/ideogram-v4/generate` family of
- /// endpoints.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Describe an image as a structured `V4JsonPrompt` with Ideogram's 4.0
+ /// image captioner (a fine-tune of the Qwen3-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the
+ /// `json_prompt` is returned directly and can be passed to the
+ /// `/v1/ideogram-v4/generate` endpoints. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -29,17 +23,11 @@ public partial interface IImageDescribeClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Describe with Ideogram 4.0
- /// Describe an image using Ideogram's 4.0-generation image captioner (a
- /// fine-tune of the Qwen3-VL vision-language model) and return a
- /// structured `V4JsonPrompt`. The
- /// returned `json_prompt` is a working JSON prompt that can be passed
- /// directly as `json_prompt` to the `/v1/ideogram-v4/generate` family of
- /// endpoints.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Describe an image as a structured `V4JsonPrompt` with Ideogram's 4.0
+ /// image captioner (a fine-tune of the Qwen3-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the
+ /// `json_prompt` is returned directly and can be passed to the
+ /// `/v1/ideogram-v4/generate` endpoints. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -52,38 +40,32 @@ public partial interface IImageDescribeClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Describe with Ideogram 4.0
- /// Describe an image using Ideogram's 4.0-generation image captioner (a
- /// fine-tune of the Qwen3-VL vision-language model) and return a
- /// structured `V4JsonPrompt`. The
- /// returned `json_prompt` is a working JSON prompt that can be passed
- /// directly as `json_prompt` to the `/v1/ideogram-v4/generate` family of
- /// endpoints.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Describe an image as a structured `V4JsonPrompt` with Ideogram's 4.0
+ /// image captioner (a fine-tune of the Qwen3-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the
+ /// `json_prompt` is returned directly and can be passed to the
+ /// `/v1/ideogram-v4/generate` endpoints. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// - /// Whether to include bounding boxes on the subjects and texts of the returned `json_prompt`. Defaults to true so the prompt preserves the spatial layout of the described image.
+ /// Whether to include bounding boxes for the subjects and text in the returned `json_prompt`. Defaults to true, so the prompt preserves the layout of the described image.
/// Default Value: true /// /// - /// Whether to include a free-form style description on the returned `json_prompt`. Defaults to false.
+ /// Whether to include a free-form style description in the returned `json_prompt`. Defaults to false.
/// Default Value: false /// /// - /// Whether to include the captioner's free-form tags on the returned `json_prompt`. Defaults to false.
+ /// Whether to include free-form tags in the returned `json_prompt`. Defaults to false.
/// Default Value: false /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage2.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage2.g.cs index 49bafe58..40c22f64 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage2.g.cs @@ -5,25 +5,12 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with GPT Image 2, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2. The prompt is consumed
- /// by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2
+ /// Generate images with GPT Image 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -39,25 +26,12 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with GPT Image 2, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2. The prompt is consumed
- /// by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2
+ /// Generate images with GPT Image 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -73,37 +47,24 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with GPT Image 2, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2. The prompt is consumed
- /// by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2
+ /// Generate images with GPT Image 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// /// The number of images to generate.
@@ -125,7 +86,7 @@ public partial interface IImagesGenerateClient /// are between 655360 and 8294400 inclusive. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage25Flare.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage25Flare.g.cs index 0aa09764..6b28a4dd 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage25Flare.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage25Flare.g.cs @@ -5,27 +5,12 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with GPT Image 2.5 Flare, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Flare — the fast
- /// variant of GPT Image 2.5, optimized for speed at quality comparable
- /// to GPT Image 2. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Flare
+ /// Generate images with GPT Image 2.5 Flare, the fast variant of GPT Image
+ /// 2.5. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -41,27 +26,12 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with GPT Image 2.5 Flare, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Flare — the fast
- /// variant of GPT Image 2.5, optimized for speed at quality comparable
- /// to GPT Image 2. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Flare
+ /// Generate images with GPT Image 2.5 Flare, the fast variant of GPT Image
+ /// 2.5. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -77,45 +47,30 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with GPT Image 2.5 Flare, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Flare — the fast
- /// variant of GPT Image 2.5, optimized for speed at quality comparable
- /// to GPT Image 2. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Flare
+ /// Generate images with GPT Image 2.5 Flare, the fast variant of GPT Image
+ /// 2.5. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// /// The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt.
@@ -145,7 +100,7 @@ public partial interface IImagesGenerateClient /// are between 655360 and 8294400 inclusive. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage25Sunburst.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage25Sunburst.g.cs index 1bbd1a9e..ea6fc59f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage25Sunburst.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2GptImage25Sunburst.g.cs @@ -5,27 +5,13 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with GPT Image 2.5 Sunburst, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Sunburst — the quality
- /// variant of GPT Image 2.5, optimized for fine detail at higher
- /// latency than Flare. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Sunburst
+ /// Generate images with GPT Image 2.5 Sunburst, the quality variant of GPT
+ /// Image 2.5, with finer detail at higher latency than Flare. Optionally
+ /// upload source images as `images` using `multipart/form-data` to edit
+ /// them with the prompt. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -41,27 +27,13 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with GPT Image 2.5 Sunburst, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Sunburst — the quality
- /// variant of GPT Image 2.5, optimized for fine detail at higher
- /// latency than Flare. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Sunburst
+ /// Generate images with GPT Image 2.5 Sunburst, the quality variant of GPT
+ /// Image 2.5, with finer detail at higher latency than Flare. Optionally
+ /// upload source images as `images` using `multipart/form-data` to edit
+ /// them with the prompt. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -77,45 +49,31 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with GPT Image 2.5 Sunburst, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Sunburst — the quality
- /// variant of GPT Image 2.5, optimized for fine detail at higher
- /// latency than Flare. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Sunburst
+ /// Generate images with GPT Image 2.5 Sunburst, the quality variant of GPT
+ /// Image 2.5, with finer detail at higher latency than Flare. Optionally
+ /// upload source images as `images` using `multipart/form-data` to edit
+ /// them with the prompt. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// /// The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt.
@@ -145,7 +103,7 @@ public partial interface IImagesGenerateClient /// are between 655360 and 8294400 inclusive. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2Ideogram45.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2Ideogram45.g.cs index f1c45133..7f4a16c1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2Ideogram45.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2Ideogram45.g.cs @@ -5,33 +5,12 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with Ideogram 4.5, from a prompt or by transforming source images
- /// Generate one or more images with Ideogram 4.5. Supplying source
- /// images turns the request into an image-to-image transform: the model
- /// conditions on the sources, the prompt becomes optional guidance, and
- /// `size` may be "source" to keep the first source's own size or "auto"
- /// to let the server pick the canvas from the sources and the prompt.
- /// Provide sources either as `image_asset_identifiers` references or as
- /// raw `images` bytes (multipart requests only); if both are supplied,
- /// the references win and the bytes are ignored. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; the
- /// server detects which was supplied.
- /// `magic_prompt` controls automatic prompt rewriting: `auto` (the
- /// default) and `on` rewrite a natural-language prompt, a prompt that is
- /// already a valid structured JSON prompt is always consumed directly,
- /// and `off` disables rewriting entirely so the model receives your
- /// prompt verbatim.
- /// Ideogram 4.5 renders a fixed set of output sizes. When `size`
- /// is omitted, the server picks a supported size automatically based on
- /// the prompt, and on the source images when there are any.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.5
+ /// Generate images with Ideogram 4.5 from a natural-language or structured
+ /// JSON prompt. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -47,33 +26,12 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Ideogram 4.5, from a prompt or by transforming source images
- /// Generate one or more images with Ideogram 4.5. Supplying source
- /// images turns the request into an image-to-image transform: the model
- /// conditions on the sources, the prompt becomes optional guidance, and
- /// `size` may be "source" to keep the first source's own size or "auto"
- /// to let the server pick the canvas from the sources and the prompt.
- /// Provide sources either as `image_asset_identifiers` references or as
- /// raw `images` bytes (multipart requests only); if both are supplied,
- /// the references win and the bytes are ignored. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; the
- /// server detects which was supplied.
- /// `magic_prompt` controls automatic prompt rewriting: `auto` (the
- /// default) and `on` rewrite a natural-language prompt, a prompt that is
- /// already a valid structured JSON prompt is always consumed directly,
- /// and `off` disables rewriting entirely so the model receives your
- /// prompt verbatim.
- /// Ideogram 4.5 renders a fixed set of output sizes. When `size`
- /// is omitted, the server picks a supported size automatically based on
- /// the prompt, and on the source images when there are any.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.5
+ /// Generate images with Ideogram 4.5 from a natural-language or structured
+ /// JSON prompt. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -89,90 +47,64 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Ideogram 4.5, from a prompt or by transforming source images
- /// Generate one or more images with Ideogram 4.5. Supplying source
- /// images turns the request into an image-to-image transform: the model
- /// conditions on the sources, the prompt becomes optional guidance, and
- /// `size` may be "source" to keep the first source's own size or "auto"
- /// to let the server pick the canvas from the sources and the prompt.
- /// Provide sources either as `image_asset_identifiers` references or as
- /// raw `images` bytes (multipart requests only); if both are supplied,
- /// the references win and the bytes are ignored. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; the
- /// server detects which was supplied.
- /// `magic_prompt` controls automatic prompt rewriting: `auto` (the
- /// default) and `on` rewrite a natural-language prompt, a prompt that is
- /// already a valid structured JSON prompt is always consumed directly,
- /// and `off` disables rewriting entirely so the model receives your
- /// prompt verbatim.
- /// Ideogram 4.5 renders a fixed set of output sizes. When `size`
- /// is omitted, the server picks a supported size automatically based on
- /// the prompt, and on the source images when there are any.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.5
+ /// Generate images with Ideogram 4.5 from a natural-language or structured
+ /// JSON prompt. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to
- /// apply when source images are supplied. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. + /// The prompt to generate images from, or the edit instruction when
+ /// source images are supplied. Natural language or a structured
+ /// Ideogram 4.0 JSON prompt. /// /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`. With source images the
- /// prompt is an edit instruction, and every mode converts it into
- /// the structured edit contract the model consumes.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`. With source images, every mode converts
+ /// the edit instruction into a structured edit prompt.
/// Default Value: auto /// /// /// Existing upload or generated image assets to transform, by reference. Takes priority over `images` if both are supplied. The first source is the primary image; any further sources are additional references. Supplying sources turns the request into an image-to-image transform. /// /// - /// The source images to transform (max 5, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 5, max 25MB each; JPEG, PNG, or WEBP). The first image is the one being edited; any others are extra references. Multipart requests only. /// /// - /// An optional mask confining the edit to part of the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as the first source image, and must contain both black and white areas. Requires source images uploaded as raw `images` bytes; masks cannot be combined with `image_asset_identifiers`. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three other source images. Supplying a mask fixes the output to the first source's own size, so `size` is rejected alongside it. + /// An optional mask that limits the edit to part of the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the first source image and contain both black and white areas. A masked request can include at most three other source images. With a mask, the output is always the first source image's own size, so `size` cannot be set. /// /// - /// An optional mask confining the edit to part of the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as the first source image, and must contain both black and white areas. Requires source images uploaded as raw `images` bytes; masks cannot be combined with `image_asset_identifiers`. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three other source images. Supplying a mask fixes the output to the first source's own size, so `size` is rejected alongside it. + /// An optional mask that limits the edit to part of the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the first source image and contain both black and white areas. A masked request can include at most three other source images. With a mask, the output is always the first source image's own size, so `size` cannot be set. /// /// /// The output size: "auto", "source" or an exact "WIDTHxHEIGHT".
/// Without source images, an exact size must be one of the supported
/// 1K/2K presets (for example 1024x1024, 2048x2048 or 1440x2880);
- /// "auto" or omitted lets the server pick a supported size based on
- /// the prompt. "source" is rejected because there is no source image
- /// to size from.
- /// With source images, "auto" (the default) lets the server pick a
- /// supported 2K size from the source images and the prompt, and
- /// "source" returns the output at the first source image's own width
- /// and height. With "source", a source too large for the model is
- /// scaled down to fit while keeping its exact proportion. Whatever the
- /// size, every source image's aspect ratio must be between 1:6 and
- /// 6:1; the model does not accept a reference outside that range.
- /// An exact size must have both dimensions multiples of 32 and at least
- /// 256px, the total size at most 2048x2048 pixels, and the aspect ratio
- /// at most 6:1. Naming one reshapes the source to it.
+ /// "auto" or omitted picks a supported size based on the prompt.
+ /// "source" is rejected.
+ /// With source images, "auto" (the default) picks a supported 2K size
+ /// based on the source images and the prompt, and "source" returns the
+ /// output at the first source image's own width and height (scaled
+ /// down, keeping its proportions, if it is too large for the model).
+ /// Every source image's aspect ratio must be between 1:6 and 6:1.
+ /// An exact size must have both sides a multiple of 32 and at least
+ /// 256px, a total of at most 2048x2048 pixels, and an aspect ratio of
+ /// at most 6:1. With source images, an exact size reshapes the source
+ /// to it.
/// Pricing is tiered by the resolved output pixels: up to 1024x1024
/// bills as 1K, above that as 2K. An "auto" size bills as 2K.
/// Default Value: auto
/// Example: 2048x2048 /// /// - /// The rendering quality to use. Higher quality renders take longer. With source images it defaults to `medium`, and `high` takes longer and is priced higher; `very_low` requires source images and is the fastest and cheapest. Without source images it defaults to `high`. + /// The rendering quality to use. Higher quality takes longer and costs more. Defaults to `medium` with source images and `high` without. `very_low`, the fastest and cheapest, requires source images. /// /// /// Random seed. Set for reproducible generation.
@@ -183,10 +115,10 @@ public partial interface IImagesGenerateClient /// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV2.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV2.g.cs index 70b4b5d3..eeab3c8d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV2.g.cs @@ -5,18 +5,10 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with Ideogram 2.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2.0,
- /// with an optional style type and negative prompt. Set
- /// `rendering_speed` to `turbo` for faster, lower-cost generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2.0
+ /// Generate images from a text prompt with Ideogram 2.0. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -32,18 +24,10 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Ideogram 2.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2.0,
- /// with an optional style type and negative prompt. Set
- /// `rendering_speed` to `turbo` for faster, lower-cost generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2.0
+ /// Generate images from a text prompt with Ideogram 2.0. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -59,18 +43,10 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Ideogram 2.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2.0,
- /// with an optional style type and negative prompt. Set
- /// `rendering_speed` to `turbo` for faster, lower-cost generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2.0
+ /// Generate images from a text prompt with Ideogram 2.0. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -79,7 +55,7 @@ public partial interface IImagesGenerateClient /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -108,10 +84,10 @@ public partial interface IImagesGenerateClient /// Example: realistic /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV2A.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV2A.g.cs index 33b37830..a050f094 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV2A.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV2A.g.cs @@ -5,18 +5,11 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with Ideogram 2a from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2a, a
- /// fast, lower-cost model, with an optional style type. Set
- /// `rendering_speed` to `turbo` for even faster generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2a
+ /// Generate images from a text prompt with Ideogram 2a, a fast, lower-cost
+ /// model. Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -32,18 +25,11 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Ideogram 2a from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2a, a
- /// fast, lower-cost model, with an optional style type. Set
- /// `rendering_speed` to `turbo` for even faster generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2a
+ /// Generate images from a text prompt with Ideogram 2a, a fast, lower-cost
+ /// model. Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -59,18 +45,11 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Ideogram 2a from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2a, a
- /// fast, lower-cost model, with an optional style type. Set
- /// `rendering_speed` to `turbo` for even faster generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2a
+ /// Generate images from a text prompt with Ideogram 2a, a fast, lower-cost
+ /// model. Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -105,10 +84,10 @@ public partial interface IImagesGenerateClient /// Example: realistic /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3.g.cs index 0e443202..648f2718 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3.g.cs @@ -5,22 +5,12 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with Ideogram 3.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 3.0,
- /// with optional style controls: style codes, a style preset, a color
- /// palette, or style references. Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). These three style reference forms cannot be combined.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 3.0
+ /// Generate images from a text prompt with Ideogram 3.0. Optional style
+ /// controls include style codes, a style preset, a color palette, and style
+ /// references (uploaded `style_reference_images`). Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -36,22 +26,12 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Ideogram 3.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 3.0,
- /// with optional style controls: style codes, a style preset, a color
- /// palette, or style references. Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). These three style reference forms cannot be combined.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 3.0
+ /// Generate images from a text prompt with Ideogram 3.0. Optional style
+ /// controls include style codes, a style preset, a color palette, and style
+ /// references (uploaded `style_reference_images`). Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -67,22 +47,12 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Ideogram 3.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 3.0,
- /// with optional style controls: style codes, a style preset, a color
- /// palette, or style references. Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). These three style reference forms cannot be combined.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 3.0
+ /// Generate images from a text prompt with Ideogram 3.0. Optional style
+ /// controls include style codes, a style preset, a color palette, and style
+ /// references (uploaded `style_reference_images`). Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -91,7 +61,7 @@ public partial interface IImagesGenerateClient /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -135,22 +105,22 @@ public partial interface IImagesGenerateClient /// A predefined style preset to apply to the generated images. Cannot be combined with style codes or style references. /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_asset_identifiers` or `style_reference_images`. + /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_images`. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// /// /// Existing upload or generated image assets to use as style references, by reference. Cannot be combined with `style_reference_collection_id` or `style_reference_images`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `style_reference_collection_id` or `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3Character.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3Character.g.cs index c6d7c055..2b7950e6 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3Character.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3Character.g.cs @@ -5,30 +5,12 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images of a consistent character with Ideogram 3.0
- /// Generate one or more images featuring a consistent character with
- /// Ideogram 3.0. Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Style references may be combined with the character on accounts with
- /// access; otherwise the combination returns a 400. Supply them as a
- /// saved style (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate a consistent character with Ideogram 3.0
+ /// Generate images featuring a consistent character with Ideogram 3.0.
+ /// Upload the character as `character_reference_images` using
+ /// `multipart/form-data`. Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -44,30 +26,12 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images of a consistent character with Ideogram 3.0
- /// Generate one or more images featuring a consistent character with
- /// Ideogram 3.0. Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Style references may be combined with the character on accounts with
- /// access; otherwise the combination returns a 400. Supply them as a
- /// saved style (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate a consistent character with Ideogram 3.0
+ /// Generate images featuring a consistent character with Ideogram 3.0.
+ /// Upload the character as `character_reference_images` using
+ /// `multipart/form-data`. Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -83,30 +47,12 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images of a consistent character with Ideogram 3.0
- /// Generate one or more images featuring a consistent character with
- /// Ideogram 3.0. Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Style references may be combined with the character on accounts with
- /// access; otherwise the combination returns a 400. Supply them as a
- /// saved style (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate a consistent character with Ideogram 3.0
+ /// Generate images featuring a consistent character with Ideogram 3.0.
+ /// Upload the character as `character_reference_images` using
+ /// `multipart/form-data`. Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -115,25 +61,25 @@ public partial interface IImagesGenerateClient /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved character in `character_reference_collection_id`. Ignored without it. /// /// /// An existing upload or generated image asset to use as the character reference, by reference. Takes priority over `character_reference_images` if both are supplied. /// /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image of the character to feature (max 25MB; JPEG, PNG, or WEBP). /// /// - /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. + /// Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. + /// Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only. /// /// /// Random seed. Set for reproducible generation.
@@ -166,22 +112,22 @@ public partial interface IImagesGenerateClient /// Default Value: auto /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// /// /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3CustomModel.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3CustomModel.g.cs index 5957f57b..d3f16d5e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3CustomModel.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3CustomModel.g.cs @@ -5,19 +5,11 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with a custom Ideogram 3.0 model
- /// Generate one or more images with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds and whether it removes
- /// backgrounds automatically.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 3.0 model
+ /// Generate images with a custom Ideogram 3.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -33,19 +25,11 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with a custom Ideogram 3.0 model
- /// Generate one or more images with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds and whether it removes
- /// backgrounds automatically.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 3.0 model
+ /// Generate images with a custom Ideogram 3.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -61,19 +45,11 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with a custom Ideogram 3.0 model
- /// Generate one or more images with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds and whether it removes
- /// backgrounds automatically.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 3.0 model
+ /// Generate images with a custom Ideogram 3.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -82,11 +58,11 @@ public partial interface IImagesGenerateClient /// The prompt to generate images from. /// /// - /// The custom model URI returned by the custom-model API, in the form `model/<model_name>/version/<version_name>`. The authenticated user or organization must have access to the model.
+ /// The custom model URI, in the form `model/<model_name>/version/<version_name>`. You or your organization must have access to the model. The model determines which rendering speeds are supported and whether backgrounds are removed automatically.
/// Example: model/my-custom-model/version/1 /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -103,7 +79,7 @@ public partial interface IImagesGenerateClient /// it uses `1x1`. /// /// - /// The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model. + /// The rendering speed to use. When omitted, a speed supported by the custom model is used. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -127,13 +103,13 @@ public partial interface IImagesGenerateClient /// Existing upload or generated image assets to use as style references, by reference. Cannot be combined with `style_reference_images`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only. Cannot be combined with `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3Transparent.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3Transparent.g.cs index 60a2fc8d..bc6a85e8 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3Transparent.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV3Transparent.g.cs @@ -5,18 +5,11 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate transparent-background images with Ideogram 3.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 3.0, delivered as PNGs with alpha. An optional
- /// `upscale_factor` increases the output size after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 3.0
+ /// Generate images on a transparent background with Ideogram 3.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -32,18 +25,11 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate transparent-background images with Ideogram 3.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 3.0, delivered as PNGs with alpha. An optional
- /// `upscale_factor` increases the output size after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 3.0
+ /// Generate images on a transparent background with Ideogram 3.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -59,18 +45,11 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate transparent-background images with Ideogram 3.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 3.0, delivered as PNGs with alpha. An optional
- /// `upscale_factor` increases the output size after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 3.0
+ /// Generate images on a transparent background with Ideogram 3.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -79,7 +58,7 @@ public partial interface IImagesGenerateClient /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -108,10 +87,10 @@ public partial interface IImagesGenerateClient /// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4.g.cs index b905a677..d34bbd64 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4.g.cs @@ -5,25 +5,11 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with Ideogram 4.0 from a text or structured prompt
- /// Generate one or more images from a prompt with Ideogram 4.0. The
- /// `prompt` accepts either natural language or a structured Ideogram 4.0
- /// JSON prompt; the server detects which was supplied. A structured JSON
- /// prompt is consumed by the model directly and skips magic prompt.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// When `resolution` is omitted, the server picks an aspect ratio
- /// automatically based on the prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.0
+ /// Generate images with Ideogram 4.0 from a natural-language or structured
+ /// JSON prompt. Returns results directly by default; set `async` or supply
+ /// a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -39,25 +25,11 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Ideogram 4.0 from a text or structured prompt
- /// Generate one or more images from a prompt with Ideogram 4.0. The
- /// `prompt` accepts either natural language or a structured Ideogram 4.0
- /// JSON prompt; the server detects which was supplied. A structured JSON
- /// prompt is consumed by the model directly and skips magic prompt.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// When `resolution` is omitted, the server picks an aspect ratio
- /// automatically based on the prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.0
+ /// Generate images with Ideogram 4.0 from a natural-language or structured
+ /// JSON prompt. Returns results directly by default; set `async` or supply
+ /// a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -73,42 +45,26 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Ideogram 4.0 from a text or structured prompt
- /// Generate one or more images from a prompt with Ideogram 4.0. The
- /// `prompt` accepts either natural language or a structured Ideogram 4.0
- /// JSON prompt; the server detects which was supplied. A structured JSON
- /// prompt is consumed by the model directly and skips magic prompt.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// When `resolution` is omitted, the server picks an aspect ratio
- /// automatically based on the prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.0
+ /// Generate images with Ideogram 4.0 from a natural-language or structured
+ /// JSON prompt. Returns results directly by default; set `async` or supply
+ /// a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt. /// /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`.
/// Default Value: auto /// /// @@ -121,18 +77,18 @@ public partial interface IImagesGenerateClient /// /// /// Optional. When supplied, the images are generated at this
- /// resolution. When omitted, the server picks an aspect ratio
- /// automatically based on the prompt. + /// resolution. When omitted, an aspect ratio is picked automatically
+ /// based on the prompt. /// /// /// The rendering speed to use.
/// Default Value: default /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4CustomModel.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4CustomModel.g.cs index 7c7a2ac7..c9156bc2 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4CustomModel.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4CustomModel.g.cs @@ -5,21 +5,11 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with a custom Ideogram 4.0 model
- /// Generate one or more images with a custom Ideogram 4.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds.
- /// The `prompt` accepts either natural language or a structured Ideogram
- /// 4.0 JSON prompt; the server detects which was supplied. A structured
- /// JSON prompt is consumed by the model directly and skips magic prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 4.0 model
+ /// Generate images with a custom Ideogram 4.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -35,21 +25,11 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with a custom Ideogram 4.0 model
- /// Generate one or more images with a custom Ideogram 4.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds.
- /// The `prompt` accepts either natural language or a structured Ideogram
- /// 4.0 JSON prompt; the server detects which was supplied. A structured
- /// JSON prompt is consumed by the model directly and skips magic prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 4.0 model
+ /// Generate images with a custom Ideogram 4.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -65,33 +45,22 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with a custom Ideogram 4.0 model
- /// Generate one or more images with a custom Ideogram 4.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds.
- /// The `prompt` accepts either natural language or a structured Ideogram
- /// 4.0 JSON prompt; the server detects which was supplied. A structured
- /// JSON prompt is consumed by the model directly and skips magic prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 4.0 model
+ /// Generate images with a custom Ideogram 4.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt. /// /// - /// The custom model URI returned by the custom-model API, in the form `model/<model_name>/version/<version_name>`. The authenticated user or organization must have access to the model.
+ /// The custom model URI, in the form `model/<model_name>/version/<version_name>`. You or your organization must have access to the model. The model determines which rendering speeds are supported.
/// Example: model/my-custom-v4-model/version/1 /// /// @@ -101,9 +70,8 @@ public partial interface IImagesGenerateClient /// /// Controls how a natural-language prompt is prepared. `auto` (the
/// default) and `on` rewrite and expand the prompt before generation.
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes. A prompt that is already a
- /// valid structured JSON prompt skips magic prompt entirely unless
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
/// `magic_prompt` is `on`.
/// Default Value: auto /// @@ -117,17 +85,17 @@ public partial interface IImagesGenerateClient /// /// /// Optional. When supplied, the images are generated at this
- /// resolution. When omitted, the server picks an aspect ratio
- /// automatically based on the prompt. + /// resolution. When omitted, an aspect ratio is picked automatically
+ /// based on the prompt. /// /// - /// The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model. + /// The rendering speed to use. When omitted, a speed supported by the custom model is used. /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4Transparent.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4Transparent.g.cs index 7d98acd1..c862b8cc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4Transparent.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2IdeogramV4Transparent.g.cs @@ -5,27 +5,11 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate transparent-background images with Ideogram 4.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 4.0, delivered as PNGs with alpha. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; a
- /// structured prompt is consumed directly and skips magic prompt, except
- /// that its background description is replaced with a
- /// transparent-background directive.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// `output_resolution` selects the output tier (1k to 8k); tiers above
- /// 2K are produced by upscaling after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 4.0
+ /// Generate images on a transparent background with Ideogram 4.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -41,27 +25,11 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate transparent-background images with Ideogram 4.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 4.0, delivered as PNGs with alpha. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; a
- /// structured prompt is consumed directly and skips magic prompt, except
- /// that its background description is replaced with a
- /// transparent-background directive.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// `output_resolution` selects the output tier (1k to 8k); tiers above
- /// 2K are produced by upscaling after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 4.0
+ /// Generate images on a transparent background with Ideogram 4.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -77,46 +45,27 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate transparent-background images with Ideogram 4.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 4.0, delivered as PNGs with alpha. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; a
- /// structured prompt is consumed directly and skips magic prompt, except
- /// that its background description is replaced with a
- /// transparent-background directive.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// `output_resolution` selects the output tier (1k to 8k); tiers above
- /// 2K are produced by upscaling after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 4.0
+ /// Generate images on a transparent background with Ideogram 4.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt, except that its
- /// background description is replaced with a transparent-background
- /// directive. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt, except that its background
+ /// description is replaced with a transparent background. /// /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`.
/// Default Value: auto /// /// @@ -135,11 +84,11 @@ public partial interface IImagesGenerateClient /// Default Value: auto /// /// - /// The output resolution tier for the generated images. Tiers are
- /// total-pixel budgets matching a square of the named size (for
- /// example, `8k` delivers at most 8192x8192 total pixels); wide and
- /// tall aspect ratios keep the same pixel budget, so a single
- /// dimension may exceed the named size. Defaults to 1k.
+ /// The output resolution tier. Each tier is a total pixel budget equal
+ /// to a square of the named size (for example, `8k` delivers at most
+ /// 8192x8192 pixels in total). Wide and tall aspect ratios keep the
+ /// same budget, so one side may exceed the named size. Tiers above
+ /// 2k are produced by upscaling after generation. Defaults to 1k.
/// Default Value: 1k /// /// @@ -147,10 +96,10 @@ public partial interface IImagesGenerateClient /// Default Value: default /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2NanoBanana2.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2NanoBanana2.g.cs index d0d3df36..5614f993 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2NanoBanana2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2NanoBanana2.g.cs @@ -5,25 +5,12 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with Nano Banana 2, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana 2. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana 2
+ /// Generate images with Nano Banana 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -39,25 +26,12 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Nano Banana 2, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana 2. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana 2
+ /// Generate images with Nano Banana 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -73,37 +47,24 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Nano Banana 2, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana 2. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana 2
+ /// Generate images with Nano Banana 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// /// The requested output aspect ratio, for example "1:1", "16:9", or "9:16". The output is served at the closest aspect ratio the model supports, at the requested resolution tier. Defaults to "1:1". @@ -121,7 +82,7 @@ public partial interface IImagesGenerateClient /// Example: 12345 /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2NanoBananaPro.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2NanoBananaPro.g.cs index 764e8e5c..9c8be019 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2NanoBananaPro.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2NanoBananaPro.g.cs @@ -5,25 +5,12 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with Nano Banana Pro, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana Pro. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana Pro
+ /// Generate images with Nano Banana Pro. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -39,25 +26,12 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Nano Banana Pro, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana Pro. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana Pro
+ /// Generate images with Nano Banana Pro. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -73,37 +47,24 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Nano Banana Pro, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana Pro. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana Pro
+ /// Generate images with Nano Banana Pro. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// /// The requested output aspect ratio, for example "1:1", "16:9", or "9:16". The output is served at the closest aspect ratio the model supports, at the requested resolution tier. Defaults to "1:1". @@ -121,7 +82,7 @@ public partial interface IImagesGenerateClient /// Example: 12345 /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2PImageIdeogram.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2PImageIdeogram.g.cs index d852d9f2..a97bc735 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2PImageIdeogram.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2PImageIdeogram.g.cs @@ -5,19 +5,11 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with P-Image Ideogram from a text or structured prompt
- /// Generate one or more images with P-Image Ideogram, a fast model with
- /// selectable quality and resolution tiers. The `prompt` accepts either
- /// natural language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with P-Image Ideogram
+ /// Generate images with P-Image Ideogram, a fast model with selectable
+ /// quality and resolution tiers. Returns results directly by default; set
+ /// `async` or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -33,19 +25,11 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with P-Image Ideogram from a text or structured prompt
- /// Generate one or more images with P-Image Ideogram, a fast model with
- /// selectable quality and resolution tiers. The `prompt` accepts either
- /// natural language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with P-Image Ideogram
+ /// Generate images with P-Image Ideogram, a fast model with selectable
+ /// quality and resolution tiers. Returns results directly by default; set
+ /// `async` or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -61,27 +45,18 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with P-Image Ideogram from a text or structured prompt
- /// Generate one or more images with P-Image Ideogram, a fast model with
- /// selectable quality and resolution tiers. The `prompt` accepts either
- /// natural language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with P-Image Ideogram
+ /// Generate images with P-Image Ideogram, a fast model with selectable
+ /// quality and resolution tiers. Returns results directly by default; set
+ /// `async` or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. /// /// /// Controls magic prompt (automatic prompt rewriting). `off` disables magic prompt entirely. Defaults to `auto`.
@@ -100,7 +75,7 @@ public partial interface IImagesGenerateClient /// Default Value: medium /// /// - /// The output-size tier; the server defaults to `1k` when omitted. Cannot be combined with `custom_width`/`custom_height`. + /// The output size tier. Defaults to `1k`. Cannot be combined with `custom_width`/`custom_height`. /// /// /// The output aspect ratio. Defaults to `1x1`.
@@ -121,10 +96,10 @@ public partial interface IImagesGenerateClient /// billing behavior. /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2ZImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2ZImage.g.cs index 011fcb2e..6971ddf2 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2ZImage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.PostGenerateImageV2ZImage.g.cs @@ -5,17 +5,10 @@ namespace Ideogram public partial interface IImagesGenerateClient { /// - /// Generate images with Z-Image from a text prompt
- /// Generate one or more images from a text prompt with Z-Image. The base
- /// model is pinned server-side.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Z-Image
+ /// Generate images from a text prompt with Z-Image. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -31,17 +24,10 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Z-Image from a text prompt
- /// Generate one or more images from a text prompt with Z-Image. The base
- /// model is pinned server-side.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Z-Image
+ /// Generate images from a text prompt with Z-Image. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -57,17 +43,10 @@ public partial interface IImagesGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate images with Z-Image from a text prompt
- /// Generate one or more images from a text prompt with Z-Image. The base
- /// model is pinned server-side.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Z-Image
+ /// Generate images from a text prompt with Z-Image. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -81,8 +60,8 @@ public partial interface IImagesGenerateClient /// Example: 1024x1024 /// /// - /// Optional diffusion step count. When omitted, the server uses the
- /// model's default. Higher values trade latency for quality.
+ /// Optional number of diffusion steps. When omitted, the model's
+ /// default is used. Higher values improve quality but take longer.
/// Example: 8 /// /// @@ -94,7 +73,7 @@ public partial interface IImagesGenerateClient /// Default Value: 1 /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.g.cs index 80592a98..12ccc427 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesGenerateClient.g.cs @@ -7,7 +7,7 @@ namespace Ideogram /// Generate images with a specific model contract. Requests are JSON
/// (Ideogram 3.0 also accepts multipart for style reference bytes) and
/// return a generation id that can be polled via
- /// `GET /v1/generations/{generation_id}`.
+ /// `GET /v2/generations/{generation_id}`.
/// If no httpClient is provided, a new one will be created.
/// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3.g.cs index 77f113ff..10953c34 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3.g.cs @@ -5,31 +5,13 @@ namespace Ideogram public partial interface IImagesInpaintClient { /// - /// Repaint a masked region with Ideogram 3.0, by asset id or by uploaded bytes
- /// Repaint the masked region of a source image from a text prompt with
- /// Ideogram 3.0. For each of the source image and the mask, supply either
- /// an `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or the raw image bytes directly (`image` /
- /// `mask`, multipart requests only). If both a reference and bytes are
- /// supplied for the same input, the reference wins and the bytes are
- /// ignored.
- /// Optional style controls: style codes, a style preset, or style
- /// reference images.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0, guided
+ /// by a text prompt. Upload the source `image` and its `mask` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -45,31 +27,13 @@ public partial interface IImagesInpaintClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Repaint a masked region with Ideogram 3.0, by asset id or by uploaded bytes
- /// Repaint the masked region of a source image from a text prompt with
- /// Ideogram 3.0. For each of the source image and the mask, supply either
- /// an `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or the raw image bytes directly (`image` /
- /// `mask`, multipart requests only). If both a reference and bytes are
- /// supplied for the same input, the reference wins and the bytes are
- /// ignored.
- /// Optional style controls: style codes, a style preset, or style
- /// reference images.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0, guided
+ /// by a text prompt. Upload the source `image` and its `mask` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -85,31 +49,13 @@ public partial interface IImagesInpaintClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Repaint a masked region with Ideogram 3.0, by asset id or by uploaded bytes
- /// Repaint the masked region of a source image from a text prompt with
- /// Ideogram 3.0. For each of the source image and the mask, supply either
- /// an `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or the raw image bytes directly (`image` /
- /// `mask`, multipart requests only). If both a reference and bytes are
- /// supplied for the same input, the reference wins and the bytes are
- /// ignored.
- /// Optional style controls: style codes, a style preset, or style
- /// reference images.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0, guided
+ /// by a text prompt. Upload the source `image` and its `mask` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -122,20 +68,20 @@ public partial interface IImagesInpaintClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -166,7 +112,7 @@ public partial interface IImagesInpaintClient /// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -175,13 +121,13 @@ public partial interface IImagesInpaintClient /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3Character.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3Character.g.cs index d1d93937..d5dd53b5 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3Character.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3Character.g.cs @@ -5,40 +5,14 @@ namespace Ideogram public partial interface IImagesInpaintClient { /// - /// Repaint a masked region with a consistent character with Ideogram 3.0
- /// Repaint the masked region of a source image so it features a
- /// consistent character, with Ideogram 3.0. For each of the source image
- /// and the mask, supply either an `AssetIdentifier` reference
- /// (`image_asset_identifier` / `mask_asset_identifier`) or the raw image
- /// bytes directly (`image` / `mask`, multipart requests only). If both a
- /// reference and bytes are supplied for the same input, the reference
- /// wins and the bytes are ignored.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Optional style controls may be combined with the character when
- /// `style_type` is `auto`. Supply either style codes or style references.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes (multipart requests only). If more than
- /// one reference form is supplied, the collection wins over the
- /// identifiers, and the identifiers win over the bytes. API-key callers
- /// also need access to the style-with-character API rollout.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint a consistent character with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0 so it
+ /// features a consistent character. Upload the source `image`, its
+ /// `mask`, and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -54,40 +28,14 @@ public partial interface IImagesInpaintClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Repaint a masked region with a consistent character with Ideogram 3.0
- /// Repaint the masked region of a source image so it features a
- /// consistent character, with Ideogram 3.0. For each of the source image
- /// and the mask, supply either an `AssetIdentifier` reference
- /// (`image_asset_identifier` / `mask_asset_identifier`) or the raw image
- /// bytes directly (`image` / `mask`, multipart requests only). If both a
- /// reference and bytes are supplied for the same input, the reference
- /// wins and the bytes are ignored.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Optional style controls may be combined with the character when
- /// `style_type` is `auto`. Supply either style codes or style references.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes (multipart requests only). If more than
- /// one reference form is supplied, the collection wins over the
- /// identifiers, and the identifiers win over the bytes. API-key callers
- /// also need access to the style-with-character API rollout.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint a consistent character with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0 so it
+ /// features a consistent character. Upload the source `image`, its
+ /// `mask`, and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -103,40 +51,14 @@ public partial interface IImagesInpaintClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Repaint a masked region with a consistent character with Ideogram 3.0
- /// Repaint the masked region of a source image so it features a
- /// consistent character, with Ideogram 3.0. For each of the source image
- /// and the mask, supply either an `AssetIdentifier` reference
- /// (`image_asset_identifier` / `mask_asset_identifier`) or the raw image
- /// bytes directly (`image` / `mask`, multipart requests only). If both a
- /// reference and bytes are supplied for the same input, the reference
- /// wins and the bytes are ignored.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Optional style controls may be combined with the character when
- /// `style_type` is `auto`. Supply either style codes or style references.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes (multipart requests only). If more than
- /// one reference form is supplied, the collection wins over the
- /// identifiers, and the identifiers win over the bytes. API-key callers
- /// also need access to the style-with-character API rollout.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint a consistent character with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0 so it
+ /// features a consistent character. Upload the source `image`, its
+ /// `mask`, and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -149,23 +71,23 @@ public partial interface IImagesInpaintClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it. @@ -174,7 +96,7 @@ public partial interface IImagesInpaintClient /// An existing upload or generated image asset to use as the character reference, by reference. Takes priority over `character_reference_images` if both are supplied. /// /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported. /// /// /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. @@ -199,7 +121,7 @@ public partial interface IImagesInpaintClient /// Default Value: default /// /// - /// The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references require `auto`.
+ /// The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references (not both) require `auto`. For API-key callers, combining a style with a character requires that feature to be enabled for their account.
/// Default Value: auto /// /// @@ -207,7 +129,7 @@ public partial interface IImagesInpaintClient /// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. Cannot be combined with `style_codes`. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. Cannot be combined with `style_codes`. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -216,13 +138,13 @@ public partial interface IImagesInpaintClient /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. Cannot be combined with `style_codes`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. Cannot be combined with `style_codes`. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Cannot be combined with `style_codes`. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3CustomModel.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3CustomModel.g.cs index 1cce0c99..cc335f4f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3CustomModel.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.PostInpaintImageV2IdeogramV3CustomModel.g.cs @@ -5,22 +5,12 @@ namespace Ideogram public partial interface IImagesInpaintClient { /// - /// Repaint a masked region with a custom Ideogram 3.0 model
+ /// Inpaint with a custom Ideogram 3.0 model
/// Repaint the masked region of a source image with a custom Ideogram 3.0
- /// model the authenticated user or organization can access. Supply the
- /// model URI returned by the custom-model API as `custom_model_uri`.
- /// For each of the source image and mask, supply either an
- /// `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or raw bytes (`image` / `mask`, multipart
- /// requests only). A reference wins if both forms are supplied.
- /// Optional style controls are style codes, a style preset, or style
- /// reference images. Supply style references as a saved style, existing
- /// asset identifiers, or raw image bytes. Only one style control may be
- /// used; when multiple reference forms are supplied, the collection wins
- /// over identifiers, and identifiers win over bytes.
- /// By default the request blocks until the images are ready. Set `async`
- /// to true to return after dispatch and poll
- /// `GET /v1/generations/{generation_id}`. + /// model, passed as `custom_model_uri`. Upload the source `image` and its
+ /// `mask` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -36,22 +26,12 @@ public partial interface IImagesInpaintClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Repaint a masked region with a custom Ideogram 3.0 model
+ /// Inpaint with a custom Ideogram 3.0 model
/// Repaint the masked region of a source image with a custom Ideogram 3.0
- /// model the authenticated user or organization can access. Supply the
- /// model URI returned by the custom-model API as `custom_model_uri`.
- /// For each of the source image and mask, supply either an
- /// `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or raw bytes (`image` / `mask`, multipart
- /// requests only). A reference wins if both forms are supplied.
- /// Optional style controls are style codes, a style preset, or style
- /// reference images. Supply style references as a saved style, existing
- /// asset identifiers, or raw image bytes. Only one style control may be
- /// used; when multiple reference forms are supplied, the collection wins
- /// over identifiers, and identifiers win over bytes.
- /// By default the request blocks until the images are ready. Set `async`
- /// to true to return after dispatch and poll
- /// `GET /v1/generations/{generation_id}`. + /// model, passed as `custom_model_uri`. Upload the source `image` and its
+ /// `mask` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -67,22 +47,12 @@ public partial interface IImagesInpaintClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Repaint a masked region with a custom Ideogram 3.0 model
+ /// Inpaint with a custom Ideogram 3.0 model
/// Repaint the masked region of a source image with a custom Ideogram 3.0
- /// model the authenticated user or organization can access. Supply the
- /// model URI returned by the custom-model API as `custom_model_uri`.
- /// For each of the source image and mask, supply either an
- /// `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or raw bytes (`image` / `mask`, multipart
- /// requests only). A reference wins if both forms are supplied.
- /// Optional style controls are style codes, a style preset, or style
- /// reference images. Supply style references as a saved style, existing
- /// asset identifiers, or raw image bytes. Only one style control may be
- /// used; when multiple reference forms are supplied, the collection wins
- /// over identifiers, and identifiers win over bytes.
- /// By default the request blocks until the images are ready. Set `async`
- /// to true to return after dispatch and poll
- /// `GET /v1/generations/{generation_id}`. + /// model, passed as `custom_model_uri`. Upload the source `image` and its
+ /// `mask` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -98,19 +68,19 @@ public partial interface IImagesInpaintClient /// The source image asset to repaint. Takes priority over `image`. /// /// - /// The source image to repaint (max size 25MB), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored when `image_asset_identifier` is supplied. + /// The source image to repaint (max 25MB), as JPEG, PNG, or WEBP. Multipart requests only. /// /// - /// The source image to repaint (max size 25MB), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored when `image_asset_identifier` is supplied. + /// The source image to repaint (max 25MB), as JPEG, PNG, or WEBP. Multipart requests only. /// /// /// A black-and-white mask asset the same size as the source image. Black marks the region to repaint. Takes priority over `mask`. /// /// - /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP bytes. Black marks the region to repaint. Multipart requests only; ignored when `mask_asset_identifier` is supplied. + /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP. Black marks the region to repaint. Multipart requests only. /// /// - /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP bytes. Black marks the region to repaint. Multipart requests only; ignored when `mask_asset_identifier` is supplied. + /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP. Black marks the region to repaint. Multipart requests only. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -135,7 +105,7 @@ public partial interface IImagesInpaintClient /// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// A saved style, by its URL-safe base64 collection id. Takes priority over asset identifiers and raw style reference images. + /// A saved style, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id for the saved style. Ignored without `style_reference_collection_id`. @@ -144,13 +114,13 @@ public partial interface IImagesInpaintClient /// Existing upload or generated image assets to use as style references. Takes priority over raw style reference images. /// /// - /// Images to use as style references (max 10, max size 25MB each), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored if a collection or asset identifiers are supplied. + /// Images to use as style references (max 10, max 25MB each), as JPEG, PNG, or WEBP. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images return `is_image_safe: false`. /// /// - /// When false, block until the images are ready. When true, return after dispatch and poll `GET /v1/generations/{generation_id}`.
+ /// When false, wait until the images are ready. When true, return as soon as the request is accepted and poll `GET /v2/generations/{generation_id}`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.g.cs index bb174b08..9bf61e3e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesInpaintClient.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Repaint a masked region of an image with a specific model contract.
- /// Requests supply the source image and mask by `AssetIdentifier`
- /// reference or as uploaded bytes and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`.
+ /// Repaint a masked region of an image with a specific model.
/// If no httpClient is provided, a new one will be created.
/// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesPreciseEditClient.PostPreciseEditImageV2Ideogram45.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesPreciseEditClient.PostPreciseEditImageV2Ideogram45.g.cs index da9de061..856dc9c3 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesPreciseEditClient.PostPreciseEditImageV2Ideogram45.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesPreciseEditClient.PostPreciseEditImageV2Ideogram45.g.cs @@ -5,44 +5,13 @@ namespace Ideogram public partial interface IImagesPreciseEditClient { /// - /// Edit an image with Ideogram 4.5, keeping the source's exact geometry
- /// Edit an image with Ideogram 4.5, returning output at that image's exact
- /// width and height. An image too large for the model is scaled down to
- /// fit while keeping its exact proportion, and one whose aspect ratio is
- /// outside 1:6 to 6:1 is rejected — this endpoint never reshapes, so there
- /// is no size to reshape it to. Unlike
- /// `POST /v2/image/generate/ideogram-4-5`, this endpoint takes no `size`:
- /// the output always matches the image being edited, so the edit drops
- /// back into whatever it came from without reframing.
- /// When the output is delivered at the image's own size (every image the
- /// model can hold), pixels the edit did not meaningfully change are
- /// restored exactly from the image being edited, with the edited region
- /// blended smoothly into its surroundings — untouched areas stay
- /// identical across repeated edits. An image too large for the model is
- /// delivered at the scaled-down size, where every pixel is resampled, so
- /// it is returned as rendered.
- /// Supply the image to edit as an `image_asset_identifier` reference or as
- /// raw `image` bytes (multipart requests only); if both are supplied, the
- /// reference wins and the bytes are ignored. Add up to four more images
- /// via `reference_image_asset_identifiers` or `reference_images` to guide
- /// the edit — those are never edited themselves.
- /// Supply a `mask` to confine the edit to part of the image being edited.
- /// The mask is optional — without one the prompt is applied to the whole
- /// image. Masks are read as an additional reference image, so a masked
- /// request may carry at most three `reference_images`.
- /// The `prompt` is the edit instruction. It accepts either natural
- /// language or a structured JSON prompt; the server detects which was
- /// supplied. A natural-language instruction is automatically rewritten
- /// into the model's structured edit contract, while a prompt that is
- /// already valid structured JSON is consumed directly.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Precise edit with Ideogram 4.5
+ /// Edit an image with Ideogram 4.5 and get the result back at that image's
+ /// exact width and height. Upload the image as `image` using
+ /// `multipart/form-data`, with optional `reference_images` and a `mask`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -58,44 +27,13 @@ public partial interface IImagesPreciseEditClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Edit an image with Ideogram 4.5, keeping the source's exact geometry
- /// Edit an image with Ideogram 4.5, returning output at that image's exact
- /// width and height. An image too large for the model is scaled down to
- /// fit while keeping its exact proportion, and one whose aspect ratio is
- /// outside 1:6 to 6:1 is rejected — this endpoint never reshapes, so there
- /// is no size to reshape it to. Unlike
- /// `POST /v2/image/generate/ideogram-4-5`, this endpoint takes no `size`:
- /// the output always matches the image being edited, so the edit drops
- /// back into whatever it came from without reframing.
- /// When the output is delivered at the image's own size (every image the
- /// model can hold), pixels the edit did not meaningfully change are
- /// restored exactly from the image being edited, with the edited region
- /// blended smoothly into its surroundings — untouched areas stay
- /// identical across repeated edits. An image too large for the model is
- /// delivered at the scaled-down size, where every pixel is resampled, so
- /// it is returned as rendered.
- /// Supply the image to edit as an `image_asset_identifier` reference or as
- /// raw `image` bytes (multipart requests only); if both are supplied, the
- /// reference wins and the bytes are ignored. Add up to four more images
- /// via `reference_image_asset_identifiers` or `reference_images` to guide
- /// the edit — those are never edited themselves.
- /// Supply a `mask` to confine the edit to part of the image being edited.
- /// The mask is optional — without one the prompt is applied to the whole
- /// image. Masks are read as an additional reference image, so a masked
- /// request may carry at most three `reference_images`.
- /// The `prompt` is the edit instruction. It accepts either natural
- /// language or a structured JSON prompt; the server detects which was
- /// supplied. A natural-language instruction is automatically rewritten
- /// into the model's structured edit contract, while a prompt that is
- /// already valid structured JSON is consumed directly.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Precise edit with Ideogram 4.5
+ /// Edit an image with Ideogram 4.5 and get the result back at that image's
+ /// exact width and height. Upload the image as `image` using
+ /// `multipart/form-data`, with optional `reference_images` and a `mask`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -111,75 +49,42 @@ public partial interface IImagesPreciseEditClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Edit an image with Ideogram 4.5, keeping the source's exact geometry
- /// Edit an image with Ideogram 4.5, returning output at that image's exact
- /// width and height. An image too large for the model is scaled down to
- /// fit while keeping its exact proportion, and one whose aspect ratio is
- /// outside 1:6 to 6:1 is rejected — this endpoint never reshapes, so there
- /// is no size to reshape it to. Unlike
- /// `POST /v2/image/generate/ideogram-4-5`, this endpoint takes no `size`:
- /// the output always matches the image being edited, so the edit drops
- /// back into whatever it came from without reframing.
- /// When the output is delivered at the image's own size (every image the
- /// model can hold), pixels the edit did not meaningfully change are
- /// restored exactly from the image being edited, with the edited region
- /// blended smoothly into its surroundings — untouched areas stay
- /// identical across repeated edits. An image too large for the model is
- /// delivered at the scaled-down size, where every pixel is resampled, so
- /// it is returned as rendered.
- /// Supply the image to edit as an `image_asset_identifier` reference or as
- /// raw `image` bytes (multipart requests only); if both are supplied, the
- /// reference wins and the bytes are ignored. Add up to four more images
- /// via `reference_image_asset_identifiers` or `reference_images` to guide
- /// the edit — those are never edited themselves.
- /// Supply a `mask` to confine the edit to part of the image being edited.
- /// The mask is optional — without one the prompt is applied to the whole
- /// image. Masks are read as an additional reference image, so a masked
- /// request may carry at most three `reference_images`.
- /// The `prompt` is the edit instruction. It accepts either natural
- /// language or a structured JSON prompt; the server detects which was
- /// supplied. A natural-language instruction is automatically rewritten
- /// into the model's structured edit contract, while a prompt that is
- /// already valid structured JSON is consumed directly.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Precise edit with Ideogram 4.5
+ /// Edit an image with Ideogram 4.5 and get the result back at that image's
+ /// exact width and height. Upload the image as `image` using
+ /// `multipart/form-data`, with optional `reference_images` and a `mask`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The edit instruction to apply to the sources. Accepts either
- /// natural language or a structured JSON prompt; the server detects
- /// which was supplied. Natural language is automatically rewritten
- /// into the model's structured edit contract, while structured JSON
- /// is consumed directly. + /// The edit instruction, in natural language or as a structured JSON
+ /// prompt. Natural language is automatically converted into a
+ /// structured prompt; valid structured JSON is used as is. /// /// /// The image to edit, as an existing upload or generated image asset. Supply this or `image`, never both. Takes priority over `image` if both are supplied. Cannot be combined with `mask`. /// /// - /// The image to edit, as raw bytes (max size 25MB; JPEG, PNG, or WEBP only). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask`. + /// The image to edit (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it. Images too large for the model are scaled down, keeping their proportions, and returned as rendered. Images with an aspect ratio outside 1:6 to 6:1 are rejected. /// /// - /// The image to edit, as raw bytes (max size 25MB; JPEG, PNG, or WEBP only). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask`. + /// The image to edit (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it. Images too large for the model are scaled down, keeping their proportions, and returned as rendered. Images with an aspect ratio outside 1:6 to 6:1 are rejected. /// /// /// Optional additional images to guide the edit, by reference. These are never edited themselves; only `image_asset_identifier` or `image` is. Requires the image being edited to be supplied by reference too, and cannot be combined with `mask`. /// /// - /// Optional additional images to guide the edit (max 4, max size 25MB each), as raw bytes; only JPEG, PNG, and WEBP formats are supported. These are never edited themselves; only `image` is. Multipart requests only; ignored if `reference_image_asset_identifiers` is also supplied. A masked request may carry at most three, because the mask occupies one of the model's reference slots. + /// Optional images to guide the edit (max 4, max 25MB each; JPEG, PNG, or WEBP). They are never edited themselves; only `image` is. Multipart requests only. A request with a `mask` can include at most three, because the mask takes up one reference slot. /// /// - /// An optional mask confining the edit to part of `image`, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as `image`, and must contain both black and white areas. Requires the image being edited to be uploaded as raw `image` bytes in the same request; masks cannot be combined with asset references. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three `reference_images`. + /// An optional mask that limits the edit to part of `image` (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. A masked request can include at most three `reference_images`. /// /// - /// An optional mask confining the edit to part of `image`, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as `image`, and must contain both black and white areas. Requires the image being edited to be uploaded as raw `image` bytes in the same request; masks cannot be combined with asset references. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three `reference_images`. + /// An optional mask that limits the edit to part of `image` (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. A masked request can include at most three `reference_images`. /// /// /// The rendering quality to use. `very_low` is the fastest and cheapest, and `high` takes longer and is priced higher.
@@ -194,10 +99,10 @@ public partial interface IImagesPreciseEditClient /// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesReframeClient.IdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesReframeClient.IdeogramV3.g.cs index bf776b78..770f2ea5 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesReframeClient.IdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesReframeClient.IdeogramV3.g.cs @@ -5,19 +5,12 @@ namespace Ideogram public partial interface IImagesReframeClient { /// - /// Reframe an image with Ideogram 3.0, by asset id or by uploaded bytes
- /// Expand an image to a new Ideogram 3.0 resolution. The source pixels
- /// are preserved in the center and Ideogram fills the new area. Supply
- /// exactly one source: an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or raw image bytes (`image`, multipart
- /// requests only). Supplying both forms, or neither, is rejected.
- /// Optional style controls are mutually exclusive. Supply at most one of
- /// `style_preset`, `style_codes`, `style_reference_asset_identifiers`, or
- /// raw `style_reference_images` (multipart requests only). Each style
- /// reference transport accepts at most 10 images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately, then poll
- /// `GET /v1/generations/{generation_id}`. + /// Reframe with Ideogram 3.0
+ /// Expand an image to a new Ideogram 3.0 resolution, keeping the source
+ /// pixels in the center and filling the new area. Upload the source
+ /// `image` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -33,19 +26,12 @@ public partial interface IImagesReframeClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Reframe an image with Ideogram 3.0, by asset id or by uploaded bytes
- /// Expand an image to a new Ideogram 3.0 resolution. The source pixels
- /// are preserved in the center and Ideogram fills the new area. Supply
- /// exactly one source: an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or raw image bytes (`image`, multipart
- /// requests only). Supplying both forms, or neither, is rejected.
- /// Optional style controls are mutually exclusive. Supply at most one of
- /// `style_preset`, `style_codes`, `style_reference_asset_identifiers`, or
- /// raw `style_reference_images` (multipart requests only). Each style
- /// reference transport accepts at most 10 images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately, then poll
- /// `GET /v1/generations/{generation_id}`. + /// Reframe with Ideogram 3.0
+ /// Expand an image to a new Ideogram 3.0 resolution, keeping the source
+ /// pixels in the center and filling the new area. Upload the source
+ /// `image` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -61,19 +47,12 @@ public partial interface IImagesReframeClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Reframe an image with Ideogram 3.0, by asset id or by uploaded bytes
- /// Expand an image to a new Ideogram 3.0 resolution. The source pixels
- /// are preserved in the center and Ideogram fills the new area. Supply
- /// exactly one source: an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or raw image bytes (`image`, multipart
- /// requests only). Supplying both forms, or neither, is rejected.
- /// Optional style controls are mutually exclusive. Supply at most one of
- /// `style_preset`, `style_codes`, `style_reference_asset_identifiers`, or
- /// raw `style_reference_images` (multipart requests only). Each style
- /// reference transport accepts at most 10 images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately, then poll
- /// `GET /v1/generations/{generation_id}`. + /// Reframe with Ideogram 3.0
+ /// Expand an image to a new Ideogram 3.0 resolution, keeping the source
+ /// pixels in the center and filling the new area. Upload the source
+ /// `image` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -83,10 +62,10 @@ public partial interface IImagesReframeClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The JPEG, PNG, or WEBP image to reframe (max 25MB), as raw bytes. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only. /// /// - /// The JPEG, PNG, or WEBP image to reframe (max 25MB), as raw bytes. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only. /// /// /// The resolutions supported for Ideogram 3.0.
@@ -118,7 +97,7 @@ public partial interface IImagesReframeClient /// Existing upload or generated image assets to use as style references. Cannot be combined with a style preset, style codes, or uploaded style reference images. /// /// - /// JPEG, PNG, or WEBP style reference images (max 10, max 25MB each), as raw bytes. Multipart requests only. Cannot be combined with a style preset, style codes, or referenced style assets. + /// JPEG, PNG, or WEBP style reference images (max 10, max 25MB each). Multipart requests only. Cannot be combined with `style_preset` or `style_codes`. /// /// /// Return immediately instead of waiting for reframed images.
diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesReframeClient.NanoBanana2.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesReframeClient.NanoBanana2.g.cs index cc8ad2f4..80729e94 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesReframeClient.NanoBanana2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesReframeClient.NanoBanana2.g.cs @@ -5,14 +5,11 @@ namespace Ideogram public partial interface IImagesReframeClient { /// - /// Reframe an image with Nano Banana 2
- /// Expand one image to a new aspect ratio with Nano Banana 2.
- /// Supply either an existing Ideogram image asset or raw image bytes,
- /// but not both. The requested aspect ratio is resolved to the closest
- /// supported 1K output dimensions.
- /// This operation is asynchronous. It returns as soon as the request is
- /// accepted; poll `GET /v1/generations/{generation_id}` for completion
- /// and results. + /// Reframe with Nano Banana 2
+ /// Expand an image to a new aspect ratio with Nano Banana 2. Upload the
+ /// source `image` using `multipart/form-data`. Always asynchronous:
+ /// returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// for results. ///
/// /// Default Value: false @@ -28,14 +25,11 @@ public partial interface IImagesReframeClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Reframe an image with Nano Banana 2
- /// Expand one image to a new aspect ratio with Nano Banana 2.
- /// Supply either an existing Ideogram image asset or raw image bytes,
- /// but not both. The requested aspect ratio is resolved to the closest
- /// supported 1K output dimensions.
- /// This operation is asynchronous. It returns as soon as the request is
- /// accepted; poll `GET /v1/generations/{generation_id}` for completion
- /// and results. + /// Reframe with Nano Banana 2
+ /// Expand an image to a new aspect ratio with Nano Banana 2. Upload the
+ /// source `image` using `multipart/form-data`. Always asynchronous:
+ /// returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// for results. ///
/// /// Default Value: false @@ -51,14 +45,11 @@ public partial interface IImagesReframeClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Reframe an image with Nano Banana 2
- /// Expand one image to a new aspect ratio with Nano Banana 2.
- /// Supply either an existing Ideogram image asset or raw image bytes,
- /// but not both. The requested aspect ratio is resolved to the closest
- /// supported 1K output dimensions.
- /// This operation is asynchronous. It returns as soon as the request is
- /// accepted; poll `GET /v1/generations/{generation_id}` for completion
- /// and results. + /// Reframe with Nano Banana 2
+ /// Expand an image to a new aspect ratio with Nano Banana 2. Upload the
+ /// source `image` using `multipart/form-data`. Always asynchronous:
+ /// returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// for results. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3.g.cs index 413811e6..1837f41f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3.g.cs @@ -5,29 +5,12 @@ namespace Ideogram public partial interface IImagesRemixClient { /// - /// Remix an existing image with Ideogram 3.0, guided by a prompt
+ /// Remix with Ideogram 3.0
/// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Optional style controls work as on the Ideogram 3.0 generate
- /// endpoint: style codes, a style preset, a color palette, or style
- /// reference images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -43,29 +26,12 @@ public partial interface IImagesRemixClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix an existing image with Ideogram 3.0, guided by a prompt
+ /// Remix with Ideogram 3.0
/// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Optional style controls work as on the Ideogram 3.0 generate
- /// endpoint: style codes, a style preset, a color palette, or style
- /// reference images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -81,29 +47,12 @@ public partial interface IImagesRemixClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix an existing image with Ideogram 3.0, guided by a prompt
+ /// Remix with Ideogram 3.0
/// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Optional style controls work as on the Ideogram 3.0 generate
- /// endpoint: style codes, a style preset, a color palette, or style
- /// reference images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -115,10 +64,10 @@ public partial interface IImagesRemixClient /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. @@ -165,7 +114,7 @@ public partial interface IImagesRemixClient /// A predefined style preset to apply to the remixed images. Cannot be combined with style codes or style references. /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_asset_identifiers` or `style_reference_images`. + /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_images`. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -174,13 +123,13 @@ public partial interface IImagesRemixClient /// Existing upload or generated image assets to use as style references, by reference. Cannot be combined with `style_reference_collection_id` or `style_reference_images`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `style_reference_collection_id` or `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3Character.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3Character.g.cs index 08f3af55..65a4cfdd 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3Character.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3Character.g.cs @@ -5,38 +5,14 @@ namespace Ideogram public partial interface IImagesRemixClient { /// - /// Remix an existing image with Ideogram 3.0, featuring a consistent character
- /// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt and featuring a consistent character. Supply the source either
- /// as an `image_asset_identifier` reference (an image already stored
- /// with Ideogram) or as raw `image` bytes (multipart requests only).
- /// Supplying both is rejected rather than one being ignored.
- /// `image_weight` controls how closely the result follows the source;
- /// when omitted the server picks a value from your prompt.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references, or as raw
- /// `character_reference_images` bytes (multipart requests only, with an
- /// optional `character_reference_mask` marking where the character is in
- /// the reference). If more than one form is supplied, the collection
- /// wins over the identifiers, and the identifiers win over the bytes.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Style references may be supplied as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix a consistent character with Ideogram 3.0
+ /// Transform an existing image with Ideogram 3.0 so it features a
+ /// consistent character, guided by a text prompt. Upload the source
+ /// `image` and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -52,38 +28,14 @@ public partial interface IImagesRemixClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix an existing image with Ideogram 3.0, featuring a consistent character
- /// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt and featuring a consistent character. Supply the source either
- /// as an `image_asset_identifier` reference (an image already stored
- /// with Ideogram) or as raw `image` bytes (multipart requests only).
- /// Supplying both is rejected rather than one being ignored.
- /// `image_weight` controls how closely the result follows the source;
- /// when omitted the server picks a value from your prompt.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references, or as raw
- /// `character_reference_images` bytes (multipart requests only, with an
- /// optional `character_reference_mask` marking where the character is in
- /// the reference). If more than one form is supplied, the collection
- /// wins over the identifiers, and the identifiers win over the bytes.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Style references may be supplied as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix a consistent character with Ideogram 3.0
+ /// Transform an existing image with Ideogram 3.0 so it features a
+ /// consistent character, guided by a text prompt. Upload the source
+ /// `image` and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -99,38 +51,14 @@ public partial interface IImagesRemixClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix an existing image with Ideogram 3.0, featuring a consistent character
- /// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt and featuring a consistent character. Supply the source either
- /// as an `image_asset_identifier` reference (an image already stored
- /// with Ideogram) or as raw `image` bytes (multipart requests only).
- /// Supplying both is rejected rather than one being ignored.
- /// `image_weight` controls how closely the result follows the source;
- /// when omitted the server picks a value from your prompt.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references, or as raw
- /// `character_reference_images` bytes (multipart requests only, with an
- /// optional `character_reference_mask` marking where the character is in
- /// the reference). If more than one form is supplied, the collection
- /// wins over the identifiers, and the identifiers win over the bytes.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Style references may be supplied as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix a consistent character with Ideogram 3.0
+ /// Transform an existing image with Ideogram 3.0 so it features a
+ /// consistent character, guided by a text prompt. Upload the source
+ /// `image` and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -142,10 +70,10 @@ public partial interface IImagesRemixClient /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. @@ -154,7 +82,7 @@ public partial interface IImagesRemixClient /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. /// /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it. @@ -163,7 +91,7 @@ public partial interface IImagesRemixClient /// An existing upload or generated image asset to use as the character reference, by reference. Takes priority over `character_reference_images` if both are supplied. /// /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported. /// /// /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. @@ -199,7 +127,7 @@ public partial interface IImagesRemixClient /// Default Value: auto /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -208,13 +136,13 @@ public partial interface IImagesRemixClient /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3CustomModel.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3CustomModel.g.cs index dc9c8fa6..216d4c19 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3CustomModel.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV3CustomModel.g.cs @@ -5,27 +5,13 @@ namespace Ideogram public partial interface IImagesRemixClient { /// - /// Remix an existing image with a custom Ideogram 3.0 model
- /// Transform an existing image with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with a custom Ideogram 3.0 model
+ /// Transform an existing image with a custom Ideogram 3.0 model that your
+ /// user or organization can access, guided by a text prompt. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -41,27 +27,13 @@ public partial interface IImagesRemixClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix an existing image with a custom Ideogram 3.0 model
- /// Transform an existing image with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with a custom Ideogram 3.0 model
+ /// Transform an existing image with a custom Ideogram 3.0 model that your
+ /// user or organization can access, guided by a text prompt. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -77,27 +49,13 @@ public partial interface IImagesRemixClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix an existing image with a custom Ideogram 3.0 model
- /// Transform an existing image with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with a custom Ideogram 3.0 model
+ /// Transform an existing image with a custom Ideogram 3.0 model that your
+ /// user or organization can access, guided by a text prompt. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -113,10 +71,10 @@ public partial interface IImagesRemixClient /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. @@ -160,13 +118,13 @@ public partial interface IImagesRemixClient /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `style_reference_asset_identifiers` is also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV4.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV4.g.cs index 225b1eeb..1759b3b2 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV4.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.PostRemixImageV2IdeogramV4.g.cs @@ -5,29 +5,12 @@ namespace Ideogram public partial interface IImagesRemixClient { /// - /// Remix an existing image with Ideogram 4.0, guided by a prompt
+ /// Remix with Ideogram 4.0
/// Transform an existing image with Ideogram 4.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` to keep the source image's shape. A `resolution`
- /// whose aspect ratio differs from the source's cannot be combined with
- /// `image_weight` — that request is rejected with a 400.
- /// The prompt is always interpreted by an instruction-editing model, so
- /// there is no `magic_prompt` option. Remixes are not reproducible, so
- /// no seed is accepted; the response reports the seed the request
- /// resolved to.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -43,29 +26,12 @@ public partial interface IImagesRemixClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix an existing image with Ideogram 4.0, guided by a prompt
+ /// Remix with Ideogram 4.0
/// Transform an existing image with Ideogram 4.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` to keep the source image's shape. A `resolution`
- /// whose aspect ratio differs from the source's cannot be combined with
- /// `image_weight` — that request is rejected with a 400.
- /// The prompt is always interpreted by an instruction-editing model, so
- /// there is no `magic_prompt` option. Remixes are not reproducible, so
- /// no seed is accepted; the response reports the seed the request
- /// resolved to.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -81,47 +47,30 @@ public partial interface IImagesRemixClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remix an existing image with Ideogram 4.0, guided by a prompt
+ /// Remix with Ideogram 4.0
/// Transform an existing image with Ideogram 4.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` to keep the source image's shape. A `resolution`
- /// whose aspect ratio differs from the source's cannot be combined with
- /// `image_weight` — that request is rejected with a 400.
- /// The prompt is always interpreted by an instruction-editing model, so
- /// there is no `magic_prompt` option. Remixes are not reproducible, so
- /// no seed is accepted; the response reports the seed the request
- /// resolved to.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt that guides the remix. + /// The prompt that guides the remix. It is always read as an editing instruction, so there is no `magic_prompt` option. /// /// /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` to keep its shape. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` to keep its shape. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` to keep its shape. /// /// - /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining image_weight with a resolution whose aspect ratio differs from the source's is rejected with a 400. + /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining `image_weight` with a `resolution` whose aspect ratio differs from the source's is rejected with a 400. /// /// /// The number of images to generate.
@@ -131,7 +80,7 @@ public partial interface IImagesRemixClient /// Optional. When supplied, the images are generated at this
/// resolution. When omitted, the source image's shape is kept. A
/// resolution whose aspect ratio differs from the source's cannot
- /// be combined with image_weight. + /// be combined with `image_weight`. /// /// /// The rendering speed to use.
@@ -141,7 +90,7 @@ public partial interface IImagesRemixClient /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.g.cs index ea285d7d..8e2baa5c 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesRemixClient.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Transform an existing image with a specific model contract, guided by
- /// a prompt. Requests supply the source by `AssetIdentifier` reference or
- /// as uploaded bytes, and return a generation id that can be polled via
- /// `GET /v1/generations/{generation_id}`.
+ /// Transform an image with a specific model, guided by a prompt.
/// If no httpClient is provided, a new one will be created.
/// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageNanoBananaPro.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageNanoBananaPro.g.cs index b6586a06..97930ee9 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageNanoBananaPro.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageNanoBananaPro.g.cs @@ -5,27 +5,13 @@ namespace Ideogram public partial interface IImagesUpscaleClient { /// - /// Upscale an image with Nano Banana Pro, by asset id or by uploaded bytes
- /// Regenerate the source image at a higher resolution tier (1K, 2K, or
- /// 4K) while preserving its content, composition, and style. Supply the
- /// source either as an `image_asset_identifier` reference (an image
- /// already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only) — callers are never required to upload the asset
- /// first. If both are supplied, the reference wins and the bytes are
- /// ignored. Uploaded bytes are used for this request only and are not
- /// stored as an asset; upscales of a referenced asset keep a visible
- /// link to their source image.
- /// An optional `prompt` adds short guidance for the enhancement; the
- /// image is otherwise upscaled as-is. The source must be smaller than
- /// the requested `resolution_tier`.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Nano Banana Pro
+ /// Regenerate an image at a higher `resolution_tier` (1K, 2K, or 4K) while
+ /// preserving its content, composition, and style. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -41,27 +27,13 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Nano Banana Pro, by asset id or by uploaded bytes
- /// Regenerate the source image at a higher resolution tier (1K, 2K, or
- /// 4K) while preserving its content, composition, and style. Supply the
- /// source either as an `image_asset_identifier` reference (an image
- /// already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only) — callers are never required to upload the asset
- /// first. If both are supplied, the reference wins and the bytes are
- /// ignored. Uploaded bytes are used for this request only and are not
- /// stored as an asset; upscales of a referenced asset keep a visible
- /// link to their source image.
- /// An optional `prompt` adds short guidance for the enhancement; the
- /// image is otherwise upscaled as-is. The source must be smaller than
- /// the requested `resolution_tier`.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Nano Banana Pro
+ /// Regenerate an image at a higher `resolution_tier` (1K, 2K, or 4K) while
+ /// preserving its content, composition, and style. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -77,27 +49,13 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Nano Banana Pro, by asset id or by uploaded bytes
- /// Regenerate the source image at a higher resolution tier (1K, 2K, or
- /// 4K) while preserving its content, composition, and style. Supply the
- /// source either as an `image_asset_identifier` reference (an image
- /// already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only) — callers are never required to upload the asset
- /// first. If both are supplied, the reference wins and the bytes are
- /// ignored. Uploaded bytes are used for this request only and are not
- /// stored as an asset; upscales of a referenced asset keep a visible
- /// link to their source image.
- /// An optional `prompt` adds short guidance for the enhancement; the
- /// image is otherwise upscaled as-is. The source must be smaller than
- /// the requested `resolution_tier`.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Nano Banana Pro
+ /// Regenerate an image at a higher `resolution_tier` (1K, 2K, or 4K) while
+ /// preserving its content, composition, and style. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -107,10 +65,10 @@ public partial interface IImagesUpscaleClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// Optional short guidance for the enhancement, appended to the model's upscaling instruction. When omitted, the image is upscaled as-is. @@ -124,7 +82,7 @@ public partial interface IImagesUpscaleClient /// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazBloom2.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazBloom2.g.cs index bacff0a5..343dace0 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazBloom2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazBloom2.g.cs @@ -5,26 +5,13 @@ namespace Ideogram public partial interface IImagesUpscaleClient { /// - /// Upscale an image with Topaz Bloom 2, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, and `creativity`
- /// controls how strongly the model reinterprets the source while
- /// enlarging it.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Bloom 2
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// optionally guided by a `prompt`. Upload the source `image` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -40,26 +27,13 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Topaz Bloom 2, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, and `creativity`
- /// controls how strongly the model reinterprets the source while
- /// enlarging it.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Bloom 2
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// optionally guided by a `prompt`. Upload the source `image` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -75,26 +49,13 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Topaz Bloom 2, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, and `creativity`
- /// controls how strongly the model reinterprets the source while
- /// enlarging it.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Bloom 2
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// optionally guided by a `prompt`. Upload the source `image` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -104,10 +65,10 @@ public partial interface IImagesUpscaleClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -129,7 +90,7 @@ public partial interface IImagesUpscaleClient /// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazRedefine.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazRedefine.g.cs index cf95b312..05238af9 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazRedefine.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazRedefine.g.cs @@ -5,28 +5,13 @@ namespace Ideogram public partial interface IImagesUpscaleClient { /// - /// Upscale an image with Topaz Redefine, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, or `autoprompt`
- /// lets the model describe the image itself. `creativity` controls how
- /// strongly the model reinterprets the source, `texture` how much fine
- /// texture it adds, and the precision knobs (sharpen, denoise, detail,
- /// face enhancement, subject detection) refine the result.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Redefine
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// guided by an optional `prompt` or `autoprompt`. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -42,28 +27,13 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Topaz Redefine, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, or `autoprompt`
- /// lets the model describe the image itself. `creativity` controls how
- /// strongly the model reinterprets the source, `texture` how much fine
- /// texture it adds, and the precision knobs (sharpen, denoise, detail,
- /// face enhancement, subject detection) refine the result.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Redefine
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// guided by an optional `prompt` or `autoprompt`. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -79,28 +49,13 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Topaz Redefine, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, or `autoprompt`
- /// lets the model describe the image itself. `creativity` controls how
- /// strongly the model reinterprets the source, `texture` how much fine
- /// texture it adds, and the precision knobs (sharpen, denoise, detail,
- /// face enhancement, subject detection) refine the result.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Redefine
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// guided by an optional `prompt` or `autoprompt`. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -110,10 +65,10 @@ public partial interface IImagesUpscaleClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -142,10 +97,10 @@ public partial interface IImagesUpscaleClient /// Detail adjustment intensity, from 0 to 10. /// /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// /// /// Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required. @@ -157,14 +112,14 @@ public partial interface IImagesUpscaleClient /// How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative). /// /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// /// /// Random seed. Set for reproducible generation.
/// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazStandardV2.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazStandardV2.g.cs index 8c0828ff..cde1153a 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazStandardV2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazStandardV2.g.cs @@ -5,24 +5,12 @@ namespace Ideogram public partial interface IImagesUpscaleClient { /// - /// Upscale an image with Topaz Standard V2, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Standard V2
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -38,24 +26,12 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Topaz Standard V2, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Standard V2
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -71,24 +47,12 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Topaz Standard V2, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Standard V2
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -98,26 +62,26 @@ public partial interface IImagesUpscaleClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
/// Default Value: x2 /// /// - /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let Topaz choose per image. + /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let the model choose per image. /// /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// /// - /// Compression artifact removal, from 0 to 1. Omit to let Topaz choose per image. + /// Compression artifact removal, from 0 to 1. Omit to let the model choose per image. /// /// /// Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required. @@ -129,10 +93,10 @@ public partial interface IImagesUpscaleClient /// How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative). /// /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazTextRefine.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazTextRefine.g.cs index 74bee0fb..b9e34748 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazTextRefine.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazTextRefine.g.cs @@ -5,24 +5,12 @@ namespace Ideogram public partial interface IImagesUpscaleClient { /// - /// Upscale an image with Topaz Text Refine, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Text Refine
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -38,24 +26,12 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Topaz Text Refine, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Text Refine
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -71,24 +47,12 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Topaz Text Refine, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Text Refine
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -98,26 +62,26 @@ public partial interface IImagesUpscaleClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
/// Default Value: x2 /// /// - /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let Topaz choose per image. + /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let the model choose per image. /// /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// /// - /// Compression artifact removal, from 0 to 1. Omit to let Topaz choose per image. + /// Compression artifact removal, from 0 to 1. Omit to let the model choose per image. /// /// /// Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required. @@ -129,14 +93,14 @@ public partial interface IImagesUpscaleClient /// How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative). /// /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// /// /// Random seed. Set for reproducible generation.
/// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazWonder35.g.cs b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazWonder35.g.cs index b0e01e43..1ffbb391 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazWonder35.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IImagesUpscaleClient.PostUpscaleImageTopazWonder35.g.cs @@ -5,26 +5,13 @@ namespace Ideogram public partial interface IImagesUpscaleClient { /// - /// Upscale an image with Topaz Wonder 3.5, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// Use `enhancement_strength` to control how strongly the generative
- /// model reconstructs detail.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Wonder 3.5
+ /// Upscale an image to 2x, 4x, or 8x its original resolution, with
+ /// `enhancement_strength` controlling how strongly detail is reconstructed.
+ /// Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -40,26 +27,13 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Topaz Wonder 3.5, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// Use `enhancement_strength` to control how strongly the generative
- /// model reconstructs detail.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Wonder 3.5
+ /// Upscale an image to 2x, 4x, or 8x its original resolution, with
+ /// `enhancement_strength` controlling how strongly detail is reconstructed.
+ /// Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -75,26 +49,13 @@ public partial interface IImagesUpscaleClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image with Topaz Wonder 3.5, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// Use `enhancement_strength` to control how strongly the generative
- /// model reconstructs detail.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Wonder 3.5
+ /// Upscale an image to 2x, 4x, or 8x its original resolution, with
+ /// `enhancement_strength` controlling how strongly detail is reconstructed.
+ /// Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -104,10 +65,10 @@ public partial interface IImagesUpscaleClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -122,7 +83,7 @@ public partial interface IImagesUpscaleClient /// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IObjectRemovalClient.PostRemoveObjectFromV2Assets.g.cs b/src/libs/Ideogram/Generated/Ideogram.IObjectRemovalClient.PostRemoveObjectFromV2Assets.g.cs index b226ead2..6e537644 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IObjectRemovalClient.PostRemoveObjectFromV2Assets.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IObjectRemovalClient.PostRemoveObjectFromV2Assets.g.cs @@ -5,17 +5,11 @@ namespace Ideogram public partial interface IObjectRemovalClient { /// - /// Remove a masked object from an image, by asset id or by uploaded bytes
- /// Remove a masked object from an image. For each of the source image and the
- /// mask, supply either an `AssetIdentifier` reference (`image_asset_identifier`
- /// / `mask_asset_identifier`) or the raw image bytes directly (`image` / `mask`,
- /// multipart requests only) — callers are never required to call
- /// `POST /v2/assets` first. If both a reference and bytes are supplied for the
- /// same input, the reference wins and the bytes are ignored.
- /// Poll for completion with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// This is the `/v2` capability-first shape; no `model` or `model_uri` field is
- /// exposed until a second backend exists. + /// Remove an object
+ /// Remove a masked object from an image. Upload the source `image` and a
+ /// `mask` of the same size using `multipart/form-data`. Returns a
+ /// `generation_id`; poll `GET /v2/generations/{generation_id}` for the
+ /// result. ///
/// /// Default Value: false @@ -31,17 +25,11 @@ public partial interface IObjectRemovalClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remove a masked object from an image, by asset id or by uploaded bytes
- /// Remove a masked object from an image. For each of the source image and the
- /// mask, supply either an `AssetIdentifier` reference (`image_asset_identifier`
- /// / `mask_asset_identifier`) or the raw image bytes directly (`image` / `mask`,
- /// multipart requests only) — callers are never required to call
- /// `POST /v2/assets` first. If both a reference and bytes are supplied for the
- /// same input, the reference wins and the bytes are ignored.
- /// Poll for completion with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// This is the `/v2` capability-first shape; no `model` or `model_uri` field is
- /// exposed until a second backend exists. + /// Remove an object
+ /// Remove a masked object from an image. Upload the source `image` and a
+ /// `mask` of the same size using `multipart/form-data`. Returns a
+ /// `generation_id`; poll `GET /v2/generations/{generation_id}` for the
+ /// result. ///
/// /// Default Value: false @@ -57,17 +45,11 @@ public partial interface IObjectRemovalClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remove a masked object from an image, by asset id or by uploaded bytes
- /// Remove a masked object from an image. For each of the source image and the
- /// mask, supply either an `AssetIdentifier` reference (`image_asset_identifier`
- /// / `mask_asset_identifier`) or the raw image bytes directly (`image` / `mask`,
- /// multipart requests only) — callers are never required to call
- /// `POST /v2/assets` first. If both a reference and bytes are supplied for the
- /// same input, the reference wins and the bytes are ignored.
- /// Poll for completion with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// This is the `/v2` capability-first shape; no `model` or `model_uri` field is
- /// exposed until a second backend exists. + /// Remove an object
+ /// Remove a masked object from an image. Upload the source `image` and a
+ /// `mask` of the same size using `multipart/form-data`. Returns a
+ /// `generation_id`; poll `GET /v2/generations/{generation_id}` for the
+ /// result. ///
/// /// Default Value: false @@ -77,20 +59,20 @@ public partial interface IObjectRemovalClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to remove an object from (max size 50MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to remove an object from. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// - /// The source image to remove an object from (max size 50MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to remove an object from. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// A binary mask the same size as the image (max size 50MB), as raw bytes; white (>= 128) marks the region to remove. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the image; white (>= 128) marks the region to remove. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// - /// A binary mask the same size as the image (max size 50MB), as raw bytes; white (>= 128) marks the region to remove. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the image; white (>= 128) marks the region to remove. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// /// Random seed. Set for reproducible generation.
@@ -100,9 +82,8 @@ public partial interface IObjectRemovalClient /// A collection you can write to, by its URL-safe base64 collection id. Completed outputs are added to it automatically. /// /// - /// Whether to store resulting generation assets on Ideogram. Defaults to `false` for
- /// API developers; first-party mini-apps should pass `true`. Reserved in the schema for
- /// an upcoming storage-control rollout — currently accepted but not yet enforced.
+ /// Whether to store the resulting images on Ideogram. Defaults to `false`.
+ /// Currently accepted but not yet enforced.
/// Default Value: false /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. diff --git a/src/libs/Ideogram/Generated/Ideogram.IObjectRemovalClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.IObjectRemovalClient.g.cs index f4461e9f..5942cbf4 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IObjectRemovalClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IObjectRemovalClient.g.cs @@ -4,9 +4,8 @@ namespace Ideogram { /// - /// Remove unwanted objects from existing image assets. Requests use
- /// `AssetIdentifier` references and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`.
+ /// Remove unwanted objects from an image. Requests return a generation id
+ /// to poll with `GET /v2/generations/{generation_id}`.
/// If no httpClient is provided, a new one will be created.
/// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.IToolClient.RemoveBackground.g.cs b/src/libs/Ideogram/Generated/Ideogram.IToolClient.RemoveBackground.g.cs index e05d686a..046fb7cc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IToolClient.RemoveBackground.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IToolClient.RemoveBackground.g.cs @@ -5,19 +5,11 @@ namespace Ideogram public partial interface IToolClient { /// - /// Remove an image background
- /// Remove the background from one image and return a foreground PNG with
- /// transparency. Supply exactly one source: raw `image` bytes in a
- /// multipart request, or an existing `image_asset_identifier` in JSON or
- /// multipart form.
- /// By default the request blocks until the foreground image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll `GET /v1/generations/{generation_id}`.
- /// API-key requests use the organization bound to the key. Firebase Bearer
- /// requests use their selected organization, and Mini App context tokens
- /// remain bound to the organization in the token. When `private` is omitted,
- /// Bearer and Mini App callers inherit their plan's private-generation
- /// default; Enterprise generations are always private. + /// Remove background
+ /// Remove the background from an image and return the foreground as a
+ /// transparent PNG. Upload the source `image` using `multipart/form-data`.
+ /// Returns the result directly by default; set `async` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -33,19 +25,11 @@ public partial interface IToolClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remove an image background
- /// Remove the background from one image and return a foreground PNG with
- /// transparency. Supply exactly one source: raw `image` bytes in a
- /// multipart request, or an existing `image_asset_identifier` in JSON or
- /// multipart form.
- /// By default the request blocks until the foreground image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll `GET /v1/generations/{generation_id}`.
- /// API-key requests use the organization bound to the key. Firebase Bearer
- /// requests use their selected organization, and Mini App context tokens
- /// remain bound to the organization in the token. When `private` is omitted,
- /// Bearer and Mini App callers inherit their plan's private-generation
- /// default; Enterprise generations are always private. + /// Remove background
+ /// Remove the background from an image and return the foreground as a
+ /// transparent PNG. Upload the source `image` using `multipart/form-data`.
+ /// Returns the result directly by default; set `async` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -61,28 +45,20 @@ public partial interface IToolClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Remove an image background
- /// Remove the background from one image and return a foreground PNG with
- /// transparency. Supply exactly one source: raw `image` bytes in a
- /// multipart request, or an existing `image_asset_identifier` in JSON or
- /// multipart form.
- /// By default the request blocks until the foreground image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll `GET /v1/generations/{generation_id}`.
- /// API-key requests use the organization bound to the key. Firebase Bearer
- /// requests use their selected organization, and Mini App context tokens
- /// remain bound to the organization in the token. When `private` is omitted,
- /// Bearer and Mini App callers inherit their plan's private-generation
- /// default; Enterprise generations are always private. + /// Remove background
+ /// Remove the background from an image and return the foreground as a
+ /// transparent PNG. Upload the source `image` using `multipart/form-data`.
+ /// Returns the result directly by default; set `async` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// Raw JPEG, PNG, or WebP image bytes (max 25MB). Multipart requests only. + /// The source image. JPEG, PNG, or WebP, up to 25MB. Multipart requests only. /// /// - /// Raw JPEG, PNG, or WebP image bytes (max 25MB). Multipart requests only. + /// The source image. JPEG, PNG, or WebP, up to 25MB. Multipart requests only. /// /// /// An identifier for an ideogram asset.
@@ -93,13 +69,11 @@ public partial interface IToolClient /// /// /// Whether to keep the result out of the public gallery. When omitted,
- /// Firebase Bearer and Mini App callers inherit their plan entitlement.
- /// Enterprise generations are always private. API keys use their bound
- /// organization and otherwise default to public when no subscription
- /// entitlement is available. + /// defaults to your plan's setting, or public if your plan has none.
+ /// Enterprise generations are always private. /// /// - /// When false (the default), wait for and return the foreground image. When true, return after acceptance and poll `GET /v1/generations/{generation_id}`.
+ /// When false (the default), wait for and return the foreground image. When true, return as soon as the request is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. diff --git a/src/libs/Ideogram/Generated/Ideogram.IToolClient.ReplaceBackground.g.cs b/src/libs/Ideogram/Generated/Ideogram.IToolClient.ReplaceBackground.g.cs index 0befbe52..ca08f1ae 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IToolClient.ReplaceBackground.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IToolClient.ReplaceBackground.g.cs @@ -5,16 +5,12 @@ namespace Ideogram public partial interface IToolClient { /// - /// Replace an image background
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject. The foreground mask is detected automatically;
- /// callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. + /// Replace background with GPT Image 2
+ /// Replace the background of an image from a text prompt while keeping the
+ /// automatically detected foreground subject; no mask is needed. Upload
+ /// the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -30,16 +26,12 @@ public partial interface IToolClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Replace an image background
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject. The foreground mask is detected automatically;
- /// callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. + /// Replace background with GPT Image 2
+ /// Replace the background of an image from a text prompt while keeping the
+ /// automatically detected foreground subject; no mask is needed. Upload
+ /// the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -55,16 +47,12 @@ public partial interface IToolClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Replace an image background
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject. The foreground mask is detected automatically;
- /// callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. + /// Replace background with GPT Image 2
+ /// Replace the background of an image from a text prompt while keeping the
+ /// automatically detected foreground subject; no mask is needed. Upload
+ /// the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -74,12 +62,12 @@ public partial interface IToolClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only. /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only. /// /// /// Plain-language description of the desired new background. @@ -93,9 +81,8 @@ public partial interface IToolClient /// Default Value: 1 /// /// - /// If true, the user is requesting private generation. If omitted,
- /// this defaults to the user's plan entitlement. Enterprise
- /// generations are always private. + /// Whether to keep the result private. When omitted, defaults to your
+ /// plan's setting. Enterprise generations are always private. /// /// /// HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a
diff --git a/src/libs/Ideogram/Generated/Ideogram.IToolClient.ReplaceBackgroundIdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.IToolClient.ReplaceBackgroundIdeogramV3.g.cs index a5fd012b..f54aa49d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IToolClient.ReplaceBackgroundIdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IToolClient.ReplaceBackgroundIdeogramV3.g.cs @@ -5,18 +5,12 @@ namespace Ideogram public partial interface IToolClient { /// - /// Replace an image background with Ideogram 3.0
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject, generated by Ideogram 3.0 inpainting. The
- /// foreground mask is detected automatically; callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. The source's longer
- /// side must be at most 3 times its shorter side; wider aspect ratios are
- /// rejected with a 400. + /// Replace background with Ideogram 3.0
+ /// Replace the background of an image from a text prompt with Ideogram 3.0,
+ /// keeping the automatically detected foreground subject; no mask is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -32,18 +26,12 @@ public partial interface IToolClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Replace an image background with Ideogram 3.0
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject, generated by Ideogram 3.0 inpainting. The
- /// foreground mask is detected automatically; callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. The source's longer
- /// side must be at most 3 times its shorter side; wider aspect ratios are
- /// rejected with a 400. + /// Replace background with Ideogram 3.0
+ /// Replace the background of an image from a text prompt with Ideogram 3.0,
+ /// keeping the automatically detected foreground subject; no mask is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -59,18 +47,12 @@ public partial interface IToolClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Replace an image background with Ideogram 3.0
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject, generated by Ideogram 3.0 inpainting. The
- /// foreground mask is detected automatically; callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. The source's longer
- /// side must be at most 3 times its shorter side; wider aspect ratios are
- /// rejected with a 400. + /// Replace background with Ideogram 3.0
+ /// Replace the background of an image from a text prompt with Ideogram 3.0,
+ /// keeping the automatically detected foreground subject; no mask is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -80,12 +62,16 @@ public partial interface IToolClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only.
+ /// The longer side must be at most 3 times the shorter side; wider
+ /// aspect ratios are rejected with a 400. /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only.
+ /// The longer side must be at most 3 times the shorter side; wider
+ /// aspect ratios are rejected with a 400. /// /// /// Plain-language description of the desired new background. @@ -99,9 +85,8 @@ public partial interface IToolClient /// Default Value: 1 /// /// - /// If true, the user is requesting private generation. If omitted,
- /// this defaults to the user's plan entitlement. Enterprise
- /// generations are always private. + /// Whether to keep the result private. When omitted, defaults to your
+ /// plan's setting. Enterprise generations are always private. /// /// /// HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a
diff --git a/src/libs/Ideogram/Generated/Ideogram.IToolsClient.PostUpscale.g.cs b/src/libs/Ideogram/Generated/Ideogram.IToolsClient.PostUpscale.g.cs index e60b8f95..13e3ff0b 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IToolsClient.PostUpscale.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IToolsClient.PostUpscale.g.cs @@ -5,26 +5,13 @@ namespace Ideogram public partial interface IToolsClient { /// - /// Upscale an image
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Ideogram selects the best upscaling
- /// model for each request, and the selection may change over time; callers
- /// never choose a model.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400. Uploaded bytes are used for this
- /// request only and are not stored as an asset; upscales of a referenced
- /// asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the source image is enhanced as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with automatic model selection
+ /// Upscale an image to 2x, 4x, or 8x its original resolution with a model
+ /// Ideogram picks per request; the choice may change over time. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -40,26 +27,13 @@ public partial interface IToolsClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Ideogram selects the best upscaling
- /// model for each request, and the selection may change over time; callers
- /// never choose a model.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400. Uploaded bytes are used for this
- /// request only and are not stored as an asset; upscales of a referenced
- /// asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the source image is enhanced as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with automatic model selection
+ /// Upscale an image to 2x, 4x, or 8x its original resolution with a model
+ /// Ideogram picks per request; the choice may change over time. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -75,26 +49,13 @@ public partial interface IToolsClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Upscale an image
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Ideogram selects the best upscaling
- /// model for each request, and the selection may change over time; callers
- /// never choose a model.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400. Uploaded bytes are used for this
- /// request only and are not stored as an asset; upscales of a referenced
- /// asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the source image is enhanced as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with automatic model selection
+ /// Upscale an image to 2x, 4x, or 8x its original resolution with a model
+ /// Ideogram picks per request; the choice may change over time. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -104,10 +65,10 @@ public partial interface IToolsClient /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -122,7 +83,7 @@ public partial interface IToolsClient /// Default Value: false /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoEditClient.PostEditVideoMinimaxH3ReferenceToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoEditClient.PostEditVideoMinimaxH3ReferenceToVideo.g.cs index a165b4eb..fc0e701f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoEditClient.PostEditVideoMinimaxH3ReferenceToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoEditClient.PostEditVideoMinimaxH3ReferenceToVideo.g.cs @@ -5,32 +5,12 @@ namespace Ideogram public partial interface IVideoEditClient { /// - /// Produce a video from reference media with MiniMax H3
- /// Produce a video from a text prompt and reference media with MiniMax H3.
- /// The prompt addresses the references by position: the first reference
- /// image is `Image 1`, the second `Image 2`, the first reference video is
- /// `Video 1`, and the first reference audio is `Audio 1`. Supply reference
- /// images either as
- /// `reference_image_asset_identifiers` (images already stored with
- /// Ideogram) or as raw `reference_images` bytes (multipart requests only);
- /// supplying both is rejected, and uploaded bytes are used for this request
- /// only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which must reference videos
- /// generated or uploaded with Ideogram. At most 9 reference images and 3 reference
- /// videos are accepted, and reference videos are capped again on clip
- /// length. Optional `reference_audios` accepts MP3/WAV uploads alongside
- /// an image or video. Audio and video references must total at most 15
- /// seconds; at most 12 references are accepted across all media.
- /// References are optional. With none, the video is produced from the
- /// prompt alone.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with MiniMax H3
+ /// Produce a video from a text prompt and optional reference media with
+ /// MiniMax H3. Upload `reference_images` and `reference_audios` using
+ /// `multipart/form-data`, and address them in the prompt by position
+ /// (`Image 1`, `Audio 1`, …). Returns a `generation_id`; poll
+ /// `GET /v2/generations/{generation_id}` or supply a `webhook_url`. ///
/// /// Default Value: false @@ -46,32 +26,12 @@ public partial interface IVideoEditClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Produce a video from reference media with MiniMax H3
- /// Produce a video from a text prompt and reference media with MiniMax H3.
- /// The prompt addresses the references by position: the first reference
- /// image is `Image 1`, the second `Image 2`, the first reference video is
- /// `Video 1`, and the first reference audio is `Audio 1`. Supply reference
- /// images either as
- /// `reference_image_asset_identifiers` (images already stored with
- /// Ideogram) or as raw `reference_images` bytes (multipart requests only);
- /// supplying both is rejected, and uploaded bytes are used for this request
- /// only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which must reference videos
- /// generated or uploaded with Ideogram. At most 9 reference images and 3 reference
- /// videos are accepted, and reference videos are capped again on clip
- /// length. Optional `reference_audios` accepts MP3/WAV uploads alongside
- /// an image or video. Audio and video references must total at most 15
- /// seconds; at most 12 references are accepted across all media.
- /// References are optional. With none, the video is produced from the
- /// prompt alone.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with MiniMax H3
+ /// Produce a video from a text prompt and optional reference media with
+ /// MiniMax H3. Upload `reference_images` and `reference_audios` using
+ /// `multipart/form-data`, and address them in the prompt by position
+ /// (`Image 1`, `Audio 1`, …). Returns a `generation_id`; poll
+ /// `GET /v2/generations/{generation_id}` or supply a `webhook_url`. ///
/// /// Default Value: false @@ -87,32 +47,12 @@ public partial interface IVideoEditClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Produce a video from reference media with MiniMax H3
- /// Produce a video from a text prompt and reference media with MiniMax H3.
- /// The prompt addresses the references by position: the first reference
- /// image is `Image 1`, the second `Image 2`, the first reference video is
- /// `Video 1`, and the first reference audio is `Audio 1`. Supply reference
- /// images either as
- /// `reference_image_asset_identifiers` (images already stored with
- /// Ideogram) or as raw `reference_images` bytes (multipart requests only);
- /// supplying both is rejected, and uploaded bytes are used for this request
- /// only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which must reference videos
- /// generated or uploaded with Ideogram. At most 9 reference images and 3 reference
- /// videos are accepted, and reference videos are capped again on clip
- /// length. Optional `reference_audios` accepts MP3/WAV uploads alongside
- /// an image or video. Audio and video references must total at most 15
- /// seconds; at most 12 references are accepted across all media.
- /// References are optional. With none, the video is produced from the
- /// prompt alone.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with MiniMax H3
+ /// Produce a video from a text prompt and optional reference media with
+ /// MiniMax H3. Upload `reference_images` and `reference_audios` using
+ /// `multipart/form-data`, and address them in the prompt by position
+ /// (`Image 1`, `Audio 1`, …). Returns a `generation_id`; poll
+ /// `GET /v2/generations/{generation_id}` or supply a `webhook_url`. ///
/// /// Default Value: false @@ -125,7 +65,7 @@ public partial interface IVideoEditClient /// Images already stored with Ideogram to use as references, by reference, in prompt order. Cannot be combined with `reference_images`. Only image assets are accepted. /// /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Uploaded images are used for this request only and are not stored. /// /// /// Videos generated or uploaded with Ideogram to use as motion references, by reference, in prompt order. Each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds. Raw video uploads are not accepted. diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoEditClient.PostEditVideoSeedDance2.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoEditClient.PostEditVideoSeedDance2.g.cs index c497913e..1604524f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoEditClient.PostEditVideoSeedDance2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoEditClient.PostEditVideoSeedDance2.g.cs @@ -5,7 +5,7 @@ namespace Ideogram public partial interface IVideoEditClient { /// - /// Edit a video with Seedance 2.0 by regenerating from frames of it
+ /// Edit video with Seedance 2.0
/// Edit a video you already have stored with Ideogram by replacing part of
/// it. Reference the source video with `video_asset_identifier` and mark the
/// span to replace with `start_frame_time` and `end_frame_time`, in seconds.
@@ -29,7 +29,7 @@ public partial interface IVideoEditClient /// Video generation always runs asynchronously: the response returns as
/// soon as the request is accepted and carries only a `generation_id`.
/// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
+ /// `GET /v2/generations/{generation_id}` using that id, or supply a
/// `webhook_url` to have the finished result POSTed to your server
/// instead.
/// Video links are available for a limited period of time; download the
@@ -49,7 +49,7 @@ public partial interface IVideoEditClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Edit a video with Seedance 2.0 by regenerating from frames of it
+ /// Edit video with Seedance 2.0
/// Edit a video you already have stored with Ideogram by replacing part of
/// it. Reference the source video with `video_asset_identifier` and mark the
/// span to replace with `start_frame_time` and `end_frame_time`, in seconds.
@@ -73,7 +73,7 @@ public partial interface IVideoEditClient /// Video generation always runs asynchronously: the response returns as
/// soon as the request is accepted and carries only a `generation_id`.
/// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
+ /// `GET /v2/generations/{generation_id}` using that id, or supply a
/// `webhook_url` to have the finished result POSTed to your server
/// instead.
/// Video links are available for a limited period of time; download the
@@ -93,7 +93,7 @@ public partial interface IVideoEditClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Edit a video with Seedance 2.0 by regenerating from frames of it
+ /// Edit video with Seedance 2.0
/// Edit a video you already have stored with Ideogram by replacing part of
/// it. Reference the source video with `video_asset_identifier` and mark the
/// span to replace with `start_frame_time` and `end_frame_time`, in seconds.
@@ -117,7 +117,7 @@ public partial interface IVideoEditClient /// Video generation always runs asynchronously: the response returns as
/// soon as the request is accepted and carries only a `generation_id`.
/// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
+ /// `GET /v2/generations/{generation_id}` using that id, or supply a
/// `webhook_url` to have the finished result POSTed to your server
/// instead.
/// Video links are available for a limited period of time; download the
diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoKlingV3StandardImageToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoKlingV3StandardImageToVideo.g.cs index 1f2f3a74..f2fe01be 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoKlingV3StandardImageToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoKlingV3StandardImageToVideo.g.cs @@ -5,29 +5,12 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Generate a video from a first frame with Kling v3 Standard, by asset id or by uploaded bytes
+ /// Image to video with Kling v3 Standard
/// Generate a video from a first-frame image and a text prompt with Kling
- /// v3 Standard. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// there is no aspect ratio to set.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// v3 Standard. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -43,29 +26,12 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a first frame with Kling v3 Standard, by asset id or by uploaded bytes
+ /// Image to video with Kling v3 Standard
/// Generate a video from a first-frame image and a text prompt with Kling
- /// v3 Standard. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// there is no aspect ratio to set.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// v3 Standard. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -81,29 +47,12 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a first frame with Kling v3 Standard, by asset id or by uploaded bytes
+ /// Image to video with Kling v3 Standard
/// Generate a video from a first-frame image and a text prompt with Kling
- /// v3 Standard. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// there is no aspect ratio to set.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// v3 Standard. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -112,19 +61,19 @@ public partial interface IVideoGenerateClient /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// A natural-language prompt describing how the first frame should animate.
diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoKlingV3StandardTextToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoKlingV3StandardTextToVideo.g.cs index de7d8343..ee261acc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoKlingV3StandardTextToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoKlingV3StandardTextToVideo.g.cs @@ -5,16 +5,10 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Generate a video from a text prompt with Kling v3 Standard
+ /// Text to video with Kling v3 Standard
/// Generate a video from a text prompt with Kling v3 Standard.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -30,16 +24,10 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a text prompt with Kling v3 Standard
+ /// Text to video with Kling v3 Standard
/// Generate a video from a text prompt with Kling v3 Standard.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -55,16 +43,10 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a text prompt with Kling v3 Standard
+ /// Text to video with Kling v3 Standard
/// Generate a video from a text prompt with Kling v3 Standard.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoMinimaxH3ImageToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoMinimaxH3ImageToVideo.g.cs index 5a640286..f3978907 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoMinimaxH3ImageToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoMinimaxH3ImageToVideo.g.cs @@ -5,29 +5,12 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Generate a video from a first frame with MiniMax H3, by asset id or by uploaded bytes
+ /// Image to video with MiniMax H3
/// Generate a video from a first-frame image and a text prompt with
- /// MiniMax H3. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// this endpoint accepts no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// MiniMax H3. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -43,29 +26,12 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a first frame with MiniMax H3, by asset id or by uploaded bytes
+ /// Image to video with MiniMax H3
/// Generate a video from a first-frame image and a text prompt with
- /// MiniMax H3. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// this endpoint accepts no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// MiniMax H3. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -81,29 +47,12 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a first frame with MiniMax H3, by asset id or by uploaded bytes
+ /// Image to video with MiniMax H3
/// Generate a video from a first-frame image and a text prompt with
- /// MiniMax H3. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// this endpoint accepts no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// MiniMax H3. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -112,19 +61,19 @@ public partial interface IVideoGenerateClient /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// A natural-language prompt describing how the first frame should animate.
diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoMinimaxH3TextToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoMinimaxH3TextToVideo.g.cs index 168bd56e..929426d0 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoMinimaxH3TextToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoMinimaxH3TextToVideo.g.cs @@ -5,16 +5,10 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Generate a video from a text prompt with MiniMax H3
+ /// Text to video with MiniMax H3
/// Generate a video from a text prompt with MiniMax H3.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -30,16 +24,10 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a text prompt with MiniMax H3
+ /// Text to video with MiniMax H3
/// Generate a video from a text prompt with MiniMax H3.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -55,16 +43,10 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a text prompt with MiniMax H3
+ /// Text to video with MiniMax H3
/// Generate a video from a text prompt with MiniMax H3.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25ImageToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25ImageToVideo.g.cs index e69a9c14..a901b6d9 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25ImageToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25ImageToVideo.g.cs @@ -5,29 +5,12 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Generate a video from a first frame with Seedance 2.5, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.5
/// Generate a video from a first-frame image and a text prompt with
- /// Seedance 2.5. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// Seedance 2.5 always derives an image-to-video result's aspect ratio
- /// from its first frame, so this endpoint takes no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Seedance 2.5. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -43,29 +26,12 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a first frame with Seedance 2.5, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.5
/// Generate a video from a first-frame image and a text prompt with
- /// Seedance 2.5. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// Seedance 2.5 always derives an image-to-video result's aspect ratio
- /// from its first frame, so this endpoint takes no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Seedance 2.5. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -81,29 +47,12 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a first frame with Seedance 2.5, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.5
/// Generate a video from a first-frame image and a text prompt with
- /// Seedance 2.5. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// Seedance 2.5 always derives an image-to-video result's aspect ratio
- /// from its first frame, so this endpoint takes no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Seedance 2.5. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -112,19 +61,19 @@ public partial interface IVideoGenerateClient /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// A natural-language prompt describing how the first frame should animate.
diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25ReferenceToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25ReferenceToVideo.g.cs index c19dc594..17aa0cf0 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25ReferenceToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25ReferenceToVideo.g.cs @@ -5,34 +5,12 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Produce a video from reference images and videos with Seedance 2.5
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.5.
- /// The prompt addresses the references by position: the first reference
- /// image is `[Image1]`, the second
- /// `[Image2]`, the first reference video is
- /// `[Video1]`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 10
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds.
- /// Supply up to 10 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–30 seconds, with at most 30 seconds total. Reference
- /// them as `[Audio1]`, `[Audio2]`, and so on. Audio is used for this request only.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.5
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.5. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -48,34 +26,12 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Produce a video from reference images and videos with Seedance 2.5
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.5.
- /// The prompt addresses the references by position: the first reference
- /// image is `[Image1]`, the second
- /// `[Image2]`, the first reference video is
- /// `[Video1]`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 10
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds.
- /// Supply up to 10 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–30 seconds, with at most 30 seconds total. Reference
- /// them as `[Audio1]`, `[Audio2]`, and so on. Audio is used for this request only.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.5
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.5. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -91,53 +47,31 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Produce a video from reference images and videos with Seedance 2.5
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.5.
- /// The prompt addresses the references by position: the first reference
- /// image is `[Image1]`, the second
- /// `[Image2]`, the first reference video is
- /// `[Video1]`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 10
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds.
- /// Supply up to 10 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–30 seconds, with at most 30 seconds total. Reference
- /// them as `[Audio1]`, `[Audio2]`, and so on. Audio is used for this request only.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.5
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.5. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false /// /// - /// A natural-language prompt describing the video to produce. Reference media is addressed by position, as in "[Image1] walks toward the camera with the motion of [Video1]".
+ /// A natural-language prompt describing the video to produce. Refer to references by position, as in "[Image1] walks toward the camera".
/// Example: [Image1] walks through the snowy forest at dawn. /// /// /// Images already stored with Ideogram to use as references, by reference, in prompt order. Cannot be combined with `reference_images`. Only image assets are accepted. /// /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Reference images, in prompt order. Common formats such as JPEG, PNG, and WEBP are supported, up to 50MB each. Multipart requests only. Uploaded images are used for this request only and are not stored. /// /// /// Uploaded or generated videos to use as references, by reference, in prompt order. Each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds. Upload video files first and pass their asset identifiers. /// /// - /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 30 seconds; combined duration must not exceed 30 seconds. At least one reference image or video is required. Audio is used for this generation only and is not saved to your library. + /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 30 seconds long, with a combined duration of at most 30 seconds. Requires at least one reference image. Audio is used for this request only and is not saved to your library. /// /// /// The aspect ratio of the generated video. `AUTO` lets the model choose the
diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25TextToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25TextToVideo.g.cs index aff5f50c..10711ac5 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25TextToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance25TextToVideo.g.cs @@ -5,17 +5,10 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Generate a video from a text prompt with Seedance 2.5
- /// Generate a video from a text prompt with Seedance 2.5, which serves
- /// resolutions up to 1080p and durations up to 30 seconds.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Text to video with Seedance 2.5
+ /// Generate a video from a text prompt with Seedance 2.5, at up to 1080p and
+ /// 30 seconds. Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -31,17 +24,10 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a text prompt with Seedance 2.5
- /// Generate a video from a text prompt with Seedance 2.5, which serves
- /// resolutions up to 1080p and durations up to 30 seconds.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Text to video with Seedance 2.5
+ /// Generate a video from a text prompt with Seedance 2.5, at up to 1080p and
+ /// 30 seconds. Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -57,17 +43,10 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a text prompt with Seedance 2.5
- /// Generate a video from a text prompt with Seedance 2.5, which serves
- /// resolutions up to 1080p and durations up to 30 seconds.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Text to video with Seedance 2.5
+ /// Generate a video from a text prompt with Seedance 2.5, at up to 1080p and
+ /// 30 seconds. Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2ImageToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2ImageToVideo.g.cs index 354baf96..f87395cd 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2ImageToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2ImageToVideo.g.cs @@ -5,27 +5,12 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Generate a video from a first frame with Seedance 2.0, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.0
/// Generate one or more videos from a first-frame image and a text prompt
- /// with Seedance 2.0. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional, follows the same one-form-only
- /// rule, and requires a first frame.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// with Seedance 2.0. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -41,27 +26,12 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a first frame with Seedance 2.0, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.0
/// Generate one or more videos from a first-frame image and a text prompt
- /// with Seedance 2.0. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional, follows the same one-form-only
- /// rule, and requires a first frame.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// with Seedance 2.0. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -77,27 +47,12 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a first frame with Seedance 2.0, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.0
/// Generate one or more videos from a first-frame image and a text prompt
- /// with Seedance 2.0. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional, follows the same one-form-only
- /// rule, and requires a first frame.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// with Seedance 2.0. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -106,19 +61,19 @@ public partial interface IVideoGenerateClient /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// A natural-language prompt describing how the first frame should animate.
diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2ReferenceToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2ReferenceToVideo.g.cs index 108183bc..1cfbfe04 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2ReferenceToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2ReferenceToVideo.g.cs @@ -5,35 +5,12 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Produce a video from reference images and videos with Seedance 2.0
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.0.
- /// The prompt addresses the references by position: the first reference
- /// image is `@Image1`, the second
- /// `@Image2`, the first reference video is
- /// `@Video1`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 3
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds.
- /// Supply up to 3 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–15 seconds, with at most 15 seconds total. Reference
- /// them as `@Audio1`, `@Audio2`, and so on. Audio is used for this request only.
- /// Images, videos, and audio combined must not exceed 12 references.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.0
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.0. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -49,35 +26,12 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Produce a video from reference images and videos with Seedance 2.0
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.0.
- /// The prompt addresses the references by position: the first reference
- /// image is `@Image1`, the second
- /// `@Image2`, the first reference video is
- /// `@Video1`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 3
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds.
- /// Supply up to 3 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–15 seconds, with at most 15 seconds total. Reference
- /// them as `@Audio1`, `@Audio2`, and so on. Audio is used for this request only.
- /// Images, videos, and audio combined must not exceed 12 references.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.0
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.0. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -93,54 +47,31 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Produce a video from reference images and videos with Seedance 2.0
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.0.
- /// The prompt addresses the references by position: the first reference
- /// image is `@Image1`, the second
- /// `@Image2`, the first reference video is
- /// `@Video1`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 3
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds.
- /// Supply up to 3 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–15 seconds, with at most 15 seconds total. Reference
- /// them as `@Audio1`, `@Audio2`, and so on. Audio is used for this request only.
- /// Images, videos, and audio combined must not exceed 12 references.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.0
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.0. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false /// /// - /// A natural-language prompt describing the video to produce. Reference media is addressed by position, as in "@Image1 walks toward the camera with the motion of @Video1".
+ /// A natural-language prompt describing the video to produce. Refer to references by position, as in "@Image1 walks toward the camera".
/// Example: @Image1 walks through the snowy forest at dawn. /// /// /// Images already stored with Ideogram to use as references, by reference, in prompt order. Cannot be combined with `reference_images`. Only image assets are accepted. /// /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Reference images, in prompt order. Common formats such as JPEG, PNG, and WEBP are supported, up to 50MB each. Multipart requests only. Uploaded images are used for this request only and are not stored. /// /// /// Uploaded or generated videos to use as references, by reference, in prompt order. Each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds. Upload video files first and pass their asset identifiers. /// /// - /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 15 seconds; combined duration must not exceed 15 seconds. At least one reference image or video is required. Audio is used for this generation only and is not saved to your library. + /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 15 seconds long, with a combined duration of at most 15 seconds. Requires at least one reference image. Audio is used for this request only and is not saved to your library. /// /// /// The aspect ratio of the generated video. `AUTO` lets the model choose the
diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2TextToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2TextToVideo.g.cs index 1f2222a6..be5b51cf 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2TextToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostGenerateVideoSeedDance2TextToVideo.g.cs @@ -5,16 +5,10 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Generate a video from a text prompt with Seedance 2.0
+ /// Text to video with Seedance 2.0
/// Generate one or more videos from a text prompt with Seedance 2.0.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -30,16 +24,10 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a text prompt with Seedance 2.0
+ /// Text to video with Seedance 2.0
/// Generate one or more videos from a text prompt with Seedance 2.0.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -55,16 +43,10 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Generate a video from a text prompt with Seedance 2.0
+ /// Text to video with Seedance 2.0
/// Generate one or more videos from a text prompt with Seedance 2.0.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostLivingImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostLivingImage.g.cs new file mode 100644 index 00000000..2a31465f --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostLivingImage.g.cs @@ -0,0 +1,79 @@ +#nullable enable + +namespace Ideogram +{ + public partial interface IVideoGenerateClient + { + /// + /// Turn a still image into a subtle looping video
+ /// Animates one image into a short, loop-ready clip for use as a living background. The camera stays fixed and only the parts of the scene that would move in real life move: water, light, mist, particles, fabric, creatures. Ideogram inspects the image and writes the motion prompt, so the request needs only the image.
+ /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + ///
+ /// + /// Default Value: false + /// + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + global::System.Threading.Tasks.Task PostLivingImageAsync( + + global::Ideogram.LivingImageRequest request, + bool? dryRun = default, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default); + /// + /// Turn a still image into a subtle looping video
+ /// Animates one image into a short, loop-ready clip for use as a living background. The camera stays fixed and only the parts of the scene that would move in real life move: water, light, mist, particles, fabric, creatures. Ideogram inspects the image and writes the motion prompt, so the request needs only the image.
+ /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + ///
+ /// + /// Default Value: false + /// + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + global::System.Threading.Tasks.Task> PostLivingImageAsResponseAsync( + + global::Ideogram.LivingImageRequest request, + bool? dryRun = default, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default); + /// + /// Turn a still image into a subtle looping video
+ /// Animates one image into a short, loop-ready clip for use as a living background. The camera stays fixed and only the parts of the scene that would move in real life move: water, light, mist, particles, fabric, creatures. Ideogram inspects the image and writes the motion prompt, so the request needs only the image.
+ /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + ///
+ /// + /// Default Value: false + /// + /// + /// An identifier for an ideogram asset.
+ /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} + /// + /// + /// The output resolution tier. `standard` renders at 768P; `high` renders at 2K. Higher tiers cost more.
+ /// Default Value: standard + /// + /// + /// The length of the generated video in seconds.
+ /// Default Value: 8
+ /// Example: 8 + /// + /// + /// A collection you can write to, by its URL-safe base64 collection id. The output video is added to it when the request completes. + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + global::System.Threading.Tasks.Task PostLivingImageAsync( + global::Ideogram.AssetIdentifier imageAssetIdentifier, + bool? dryRun = default, + global::Ideogram.LivingImageQuality? quality = default, + int? duration = default, + string? targetCollectionId = default, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default); + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostProduct360Video.g.cs b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostProduct360Video.g.cs index 0980dae8..63c9749f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostProduct360Video.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IVideoGenerateClient.PostProduct360Video.g.cs @@ -5,9 +5,9 @@ namespace Ideogram public partial interface IVideoGenerateClient { /// - /// Create a looping 360-degree product video
+ /// Product 360 Video
/// Animates one product image through a complete turntable revolution and returns to the starting pose so the result loops cleanly.
- /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + /// Video generation runs asynchronously. Poll `GET /v2/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. ///
/// /// Default Value: false @@ -23,9 +23,9 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Create a looping 360-degree product video
+ /// Product 360 Video
/// Animates one product image through a complete turntable revolution and returns to the starting pose so the result loops cleanly.
- /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + /// Video generation runs asynchronously. Poll `GET /v2/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. ///
/// /// Default Value: false @@ -41,9 +41,9 @@ public partial interface IVideoGenerateClient global::Ideogram.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// - /// Create a looping 360-degree product video
+ /// Product 360 Video
/// Animates one product image through a complete turntable revolution and returns to the starting pose so the result loops cleanly.
- /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + /// Video generation runs asynchronously. Poll `GET /v2/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.IdeogramClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.IdeogramClient.g.cs index 3ccbea80..532db9a5 100644 --- a/src/libs/Ideogram/Generated/Ideogram.IdeogramClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.IdeogramClient.g.cs @@ -56,10 +56,19 @@ public sealed partial class IdeogramClient : global::Ideogram.IIdeogramClient, g JsonSerializerContextProvider = JsonSerializerContextProvider, }; + /// + /// + /// + public AssetReferenceUsageClient AssetReferenceUsage => new AssetReferenceUsageClient(HttpClient, baseUri: null, authorizations: Authorizations, options: Options) + { + ReadResponseAsString = ReadResponseAsString, + JsonSerializerContextProvider = JsonSerializerContextProvider, + }; + /// /// Model-agnostic endpoints where the server selects the model for each
/// request. Requests are JSON and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`. + /// polled via `GET /v2/generations/{generation_id}`. ///
public AutoModelClient AutoModel => new AutoModelClient(HttpClient, baseUri: null, authorizations: Authorizations, options: Options) { @@ -112,6 +121,15 @@ public sealed partial class IdeogramClient : global::Ideogram.IIdeogramClient, g JsonSerializerContextProvider = JsonSerializerContextProvider, }; + /// + /// + /// + public GenerationsClient Generations => new GenerationsClient(HttpClient, baseUri: null, authorizations: Authorizations, options: Options) + { + ReadResponseAsString = ReadResponseAsString, + JsonSerializerContextProvider = JsonSerializerContextProvider, + }; + /// /// /// @@ -125,7 +143,7 @@ public sealed partial class IdeogramClient : global::Ideogram.IIdeogramClient, g /// Generate images with a specific model contract. Requests are JSON
/// (Ideogram 3.0 also accepts multipart for style reference bytes) and
/// return a generation id that can be polled via
- /// `GET /v1/generations/{generation_id}`. + /// `GET /v2/generations/{generation_id}`. ///
public ImagesGenerateClient ImagesGenerate => new ImagesGenerateClient(HttpClient, baseUri: null, authorizations: Authorizations, options: Options) { @@ -134,10 +152,7 @@ public sealed partial class IdeogramClient : global::Ideogram.IIdeogramClient, g }; /// - /// Repaint a masked region of an image with a specific model contract.
- /// Requests supply the source image and mask by `AssetIdentifier`
- /// reference or as uploaded bytes and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`. + /// Repaint a masked region of an image with a specific model. ///
public ImagesInpaintClient ImagesInpaint => new ImagesInpaintClient(HttpClient, baseUri: null, authorizations: Authorizations, options: Options) { @@ -165,10 +180,7 @@ public sealed partial class IdeogramClient : global::Ideogram.IIdeogramClient, g }; /// - /// Transform an existing image with a specific model contract, guided by
- /// a prompt. Requests supply the source by `AssetIdentifier` reference or
- /// as uploaded bytes, and return a generation id that can be polled via
- /// `GET /v1/generations/{generation_id}`. + /// Transform an image with a specific model, guided by a prompt. ///
public ImagesRemixClient ImagesRemix => new ImagesRemixClient(HttpClient, baseUri: null, authorizations: Authorizations, options: Options) { @@ -231,9 +243,8 @@ public sealed partial class IdeogramClient : global::Ideogram.IIdeogramClient, g }; /// - /// Remove unwanted objects from existing image assets. Requests use
- /// `AssetIdentifier` references and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`. + /// Remove unwanted objects from an image. Requests return a generation id
+ /// to poll with `GET /v2/generations/{generation_id}`. ///
public ObjectRemovalClient ObjectRemoval => new ObjectRemovalClient(HttpClient, baseUri: null, authorizations: Authorizations, options: Options) { diff --git a/src/libs/Ideogram/Generated/Ideogram.ImageDescribe.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImageDescribe.JsonSerializerContext.g.cs index c5c0601e..36c31200 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImageDescribe.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImageDescribe.JsonSerializerContext.g.cs @@ -20,10 +20,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(byte[]))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.DateTime))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.DescribeImageIdeogramV3Response))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GeneratedDescription))] diff --git a/src/libs/Ideogram/Generated/Ideogram.ImageDescribeClient.PostDescribeImageIdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImageDescribeClient.PostDescribeImageIdeogramV3.g.cs index 4a16f2ec..795f3033 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImageDescribeClient.PostDescribeImageIdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImageDescribeClient.PostDescribeImageIdeogramV3.g.cs @@ -43,14 +43,10 @@ partial void ProcessPostDescribeImageIdeogramV3ResponseContent( /// /// Describe with Ideogram 3.0
- /// Generate a natural-language description of an image using Ideogram's
- /// 3.0-generation image captioner (a fine-tune of the Qwen2-VL
- /// vision-language model).
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Generate a natural-language description of an image with Ideogram's 3.0
+ /// image captioner (a fine-tune of the Qwen2-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the description
+ /// is returned directly. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -73,14 +69,10 @@ partial void ProcessPostDescribeImageIdeogramV3ResponseContent( } /// /// Describe with Ideogram 3.0
- /// Generate a natural-language description of an image using Ideogram's
- /// 3.0-generation image captioner (a fine-tune of the Qwen2-VL
- /// vision-language model).
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Generate a natural-language description of an image with Ideogram's 3.0
+ /// image captioner (a fine-tune of the Qwen2-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the description
+ /// is returned directly. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -769,24 +761,20 @@ request.Imagename is null } /// /// Describe with Ideogram 3.0
- /// Generate a natural-language description of an image using Ideogram's
- /// 3.0-generation image captioner (a fine-tune of the Qwen2-VL
- /// vision-language model).
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Generate a natural-language description of an image with Ideogram's 3.0
+ /// image captioner (a fine-tune of the Qwen2-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the description
+ /// is returned directly. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. /// The token to cancel the operation with diff --git a/src/libs/Ideogram/Generated/Ideogram.ImageDescribeClient.PostDescribeImageIdeogramV4.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImageDescribeClient.PostDescribeImageIdeogramV4.g.cs index 89246062..50151feb 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImageDescribeClient.PostDescribeImageIdeogramV4.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImageDescribeClient.PostDescribeImageIdeogramV4.g.cs @@ -43,17 +43,11 @@ partial void ProcessPostDescribeImageIdeogramV4ResponseContent( /// /// Describe with Ideogram 4.0
- /// Describe an image using Ideogram's 4.0-generation image captioner (a
- /// fine-tune of the Qwen3-VL vision-language model) and return a
- /// structured `V4JsonPrompt`. The
- /// returned `json_prompt` is a working JSON prompt that can be passed
- /// directly as `json_prompt` to the `/v1/ideogram-v4/generate` family of
- /// endpoints.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Describe an image as a structured `V4JsonPrompt` with Ideogram's 4.0
+ /// image captioner (a fine-tune of the Qwen3-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the
+ /// `json_prompt` is returned directly and can be passed to the
+ /// `/v1/ideogram-v4/generate` endpoints. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -76,17 +70,11 @@ partial void ProcessPostDescribeImageIdeogramV4ResponseContent( } /// /// Describe with Ideogram 4.0
- /// Describe an image using Ideogram's 4.0-generation image captioner (a
- /// fine-tune of the Qwen3-VL vision-language model) and return a
- /// structured `V4JsonPrompt`. The
- /// returned `json_prompt` is a working JSON prompt that can be passed
- /// directly as `json_prompt` to the `/v1/ideogram-v4/generate` family of
- /// endpoints.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Describe an image as a structured `V4JsonPrompt` with Ideogram's 4.0
+ /// image captioner (a fine-tune of the Qwen3-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the
+ /// `json_prompt` is returned directly and can be passed to the
+ /// `/v1/ideogram-v4/generate` endpoints. ///
/// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. @@ -799,38 +787,32 @@ request.Imagename is null } /// /// Describe with Ideogram 4.0
- /// Describe an image using Ideogram's 4.0-generation image captioner (a
- /// fine-tune of the Qwen3-VL vision-language model) and return a
- /// structured `V4JsonPrompt`. The
- /// returned `json_prompt` is a working JSON prompt that can be passed
- /// directly as `json_prompt` to the `/v1/ideogram-v4/generate` family of
- /// endpoints.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400.
- /// Supported image formats include JPEG, PNG, and WebP. + /// Describe an image as a structured `V4JsonPrompt` with Ideogram's 4.0
+ /// image captioner (a fine-tune of the Qwen3-VL vision-language model).
+ /// Upload the image as `image` using `multipart/form-data`; the
+ /// `json_prompt` is returned directly and can be passed to the
+ /// `/v1/ideogram-v4/generate` endpoints. ///
/// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// - /// Whether to include bounding boxes on the subjects and texts of the returned `json_prompt`. Defaults to true so the prompt preserves the spatial layout of the described image.
+ /// Whether to include bounding boxes for the subjects and text in the returned `json_prompt`. Defaults to true, so the prompt preserves the layout of the described image.
/// Default Value: true /// /// - /// Whether to include a free-form style description on the returned `json_prompt`. Defaults to false.
+ /// Whether to include a free-form style description in the returned `json_prompt`. Defaults to false.
/// Default Value: false /// /// - /// Whether to include the captioner's free-form tags on the returned `json_prompt`. Defaults to false.
+ /// Whether to include free-form tags in the returned `json_prompt`. Defaults to false.
/// Default Value: false /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerate.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerate.JsonSerializerContext.g.cs index 57bf79d5..e09e1ee6 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerate.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerate.JsonSerializerContext.g.cs @@ -22,10 +22,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ResolutionV3), TypeInfoPropertyName = "ResolutionV32")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateImageIdeogramV3Response))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage2.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage2.g.cs index c938d218..35ab60ff 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage2.g.cs @@ -44,25 +44,12 @@ partial void ProcessPostGenerateImageV2GptImage2ResponseContent( ref string content); /// - /// Generate images with GPT Image 2, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2. The prompt is consumed
- /// by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2
+ /// Generate images with GPT Image 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -89,25 +76,12 @@ partial void ProcessPostGenerateImageV2GptImage2ResponseContent( return __response.Body; } /// - /// Generate images with GPT Image 2, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2. The prompt is consumed
- /// by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2
+ /// Generate images with GPT Image 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -811,37 +785,24 @@ partial void ProcessPostGenerateImageV2GptImage2ResponseContent( } } /// - /// Generate images with GPT Image 2, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2. The prompt is consumed
- /// by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2
+ /// Generate images with GPT Image 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// /// The number of images to generate.
@@ -863,7 +824,7 @@ partial void ProcessPostGenerateImageV2GptImage2ResponseContent( /// are between 655360 and 8294400 inclusive. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage25Flare.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage25Flare.g.cs index 5451d5ab..6a020cb6 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage25Flare.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage25Flare.g.cs @@ -44,27 +44,12 @@ partial void ProcessPostGenerateImageV2GptImage25FlareResponseContent( ref string content); /// - /// Generate images with GPT Image 2.5 Flare, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Flare — the fast
- /// variant of GPT Image 2.5, optimized for speed at quality comparable
- /// to GPT Image 2. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Flare
+ /// Generate images with GPT Image 2.5 Flare, the fast variant of GPT Image
+ /// 2.5. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -91,27 +76,12 @@ partial void ProcessPostGenerateImageV2GptImage25FlareResponseContent( return __response.Body; } /// - /// Generate images with GPT Image 2.5 Flare, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Flare — the fast
- /// variant of GPT Image 2.5, optimized for speed at quality comparable
- /// to GPT Image 2. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Flare
+ /// Generate images with GPT Image 2.5 Flare, the fast variant of GPT Image
+ /// 2.5. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -873,45 +843,30 @@ request.Maskname is null } } /// - /// Generate images with GPT Image 2.5 Flare, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Flare — the fast
- /// variant of GPT Image 2.5, optimized for speed at quality comparable
- /// to GPT Image 2. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Flare
+ /// Generate images with GPT Image 2.5 Flare, the fast variant of GPT Image
+ /// 2.5. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// /// The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt.
@@ -941,7 +896,7 @@ request.Maskname is null /// are between 655360 and 8294400 inclusive. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage25Sunburst.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage25Sunburst.g.cs index 48d91794..7614fae1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage25Sunburst.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2GptImage25Sunburst.g.cs @@ -44,27 +44,13 @@ partial void ProcessPostGenerateImageV2GptImage25SunburstResponseContent( ref string content); /// - /// Generate images with GPT Image 2.5 Sunburst, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Sunburst — the quality
- /// variant of GPT Image 2.5, optimized for fine detail at higher
- /// latency than Flare. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Sunburst
+ /// Generate images with GPT Image 2.5 Sunburst, the quality variant of GPT
+ /// Image 2.5, with finer detail at higher latency than Flare. Optionally
+ /// upload source images as `images` using `multipart/form-data` to edit
+ /// them with the prompt. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -91,27 +77,13 @@ partial void ProcessPostGenerateImageV2GptImage25SunburstResponseContent( return __response.Body; } /// - /// Generate images with GPT Image 2.5 Sunburst, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Sunburst — the quality
- /// variant of GPT Image 2.5, optimized for fine detail at higher
- /// latency than Flare. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Sunburst
+ /// Generate images with GPT Image 2.5 Sunburst, the quality variant of GPT
+ /// Image 2.5, with finer detail at higher latency than Flare. Optionally
+ /// upload source images as `images` using `multipart/form-data` to edit
+ /// them with the prompt. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -873,45 +845,31 @@ request.Maskname is null } } /// - /// Generate images with GPT Image 2.5 Sunburst, from a text prompt or by editing source images
- /// Generate one or more images with GPT Image 2.5 Sunburst — the quality
- /// variant of GPT Image 2.5, optimized for fine detail at higher
- /// latency than Flare. The prompt is consumed by the model directly, without
- /// rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output size follows `resolution` when provided, otherwise the
- /// closest size the model supports for `aspect_ratio`.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with GPT Image 2.5 Sunburst
+ /// Generate images with GPT Image 2.5 Sunburst, the quality variant of GPT
+ /// Image 2.5, with finer detail at higher latency than Flare. Optionally
+ /// upload source images as `images` using `multipart/form-data` to edit
+ /// them with the prompt. Returns results directly by default; set `async`
+ /// or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// /// The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt.
@@ -941,7 +899,7 @@ request.Maskname is null /// are between 655360 and 8294400 inclusive. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2Ideogram45.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2Ideogram45.g.cs index 219a42f6..17d8ab10 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2Ideogram45.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2Ideogram45.g.cs @@ -44,33 +44,12 @@ partial void ProcessPostGenerateImageV2Ideogram45ResponseContent( ref string content); /// - /// Generate images with Ideogram 4.5, from a prompt or by transforming source images
- /// Generate one or more images with Ideogram 4.5. Supplying source
- /// images turns the request into an image-to-image transform: the model
- /// conditions on the sources, the prompt becomes optional guidance, and
- /// `size` may be "source" to keep the first source's own size or "auto"
- /// to let the server pick the canvas from the sources and the prompt.
- /// Provide sources either as `image_asset_identifiers` references or as
- /// raw `images` bytes (multipart requests only); if both are supplied,
- /// the references win and the bytes are ignored. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; the
- /// server detects which was supplied.
- /// `magic_prompt` controls automatic prompt rewriting: `auto` (the
- /// default) and `on` rewrite a natural-language prompt, a prompt that is
- /// already a valid structured JSON prompt is always consumed directly,
- /// and `off` disables rewriting entirely so the model receives your
- /// prompt verbatim.
- /// Ideogram 4.5 renders a fixed set of output sizes. When `size`
- /// is omitted, the server picks a supported size automatically based on
- /// the prompt, and on the source images when there are any.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.5
+ /// Generate images with Ideogram 4.5 from a natural-language or structured
+ /// JSON prompt. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -97,33 +76,12 @@ partial void ProcessPostGenerateImageV2Ideogram45ResponseContent( return __response.Body; } /// - /// Generate images with Ideogram 4.5, from a prompt or by transforming source images
- /// Generate one or more images with Ideogram 4.5. Supplying source
- /// images turns the request into an image-to-image transform: the model
- /// conditions on the sources, the prompt becomes optional guidance, and
- /// `size` may be "source" to keep the first source's own size or "auto"
- /// to let the server pick the canvas from the sources and the prompt.
- /// Provide sources either as `image_asset_identifiers` references or as
- /// raw `images` bytes (multipart requests only); if both are supplied,
- /// the references win and the bytes are ignored. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; the
- /// server detects which was supplied.
- /// `magic_prompt` controls automatic prompt rewriting: `auto` (the
- /// default) and `on` rewrite a natural-language prompt, a prompt that is
- /// already a valid structured JSON prompt is always consumed directly,
- /// and `off` disables rewriting entirely so the model receives your
- /// prompt verbatim.
- /// Ideogram 4.5 renders a fixed set of output sizes. When `size`
- /// is omitted, the server picks a supported size automatically based on
- /// the prompt, and on the source images when there are any.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.5
+ /// Generate images with Ideogram 4.5 from a natural-language or structured
+ /// JSON prompt. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -885,90 +843,64 @@ request.Maskname is null } } /// - /// Generate images with Ideogram 4.5, from a prompt or by transforming source images
- /// Generate one or more images with Ideogram 4.5. Supplying source
- /// images turns the request into an image-to-image transform: the model
- /// conditions on the sources, the prompt becomes optional guidance, and
- /// `size` may be "source" to keep the first source's own size or "auto"
- /// to let the server pick the canvas from the sources and the prompt.
- /// Provide sources either as `image_asset_identifiers` references or as
- /// raw `images` bytes (multipart requests only); if both are supplied,
- /// the references win and the bytes are ignored. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; the
- /// server detects which was supplied.
- /// `magic_prompt` controls automatic prompt rewriting: `auto` (the
- /// default) and `on` rewrite a natural-language prompt, a prompt that is
- /// already a valid structured JSON prompt is always consumed directly,
- /// and `off` disables rewriting entirely so the model receives your
- /// prompt verbatim.
- /// Ideogram 4.5 renders a fixed set of output sizes. When `size`
- /// is omitted, the server picks a supported size automatically based on
- /// the prompt, and on the source images when there are any.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.5
+ /// Generate images with Ideogram 4.5 from a natural-language or structured
+ /// JSON prompt. Optionally upload source images as `images` using
+ /// `multipart/form-data` to edit them with the prompt. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to
- /// apply when source images are supplied. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. + /// The prompt to generate images from, or the edit instruction when
+ /// source images are supplied. Natural language or a structured
+ /// Ideogram 4.0 JSON prompt. /// /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`. With source images the
- /// prompt is an edit instruction, and every mode converts it into
- /// the structured edit contract the model consumes.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`. With source images, every mode converts
+ /// the edit instruction into a structured edit prompt.
/// Default Value: auto /// /// /// Existing upload or generated image assets to transform, by reference. Takes priority over `images` if both are supplied. The first source is the primary image; any further sources are additional references. Supplying sources turns the request into an image-to-image transform. /// /// - /// The source images to transform (max 5, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 5, max 25MB each; JPEG, PNG, or WEBP). The first image is the one being edited; any others are extra references. Multipart requests only. /// /// - /// An optional mask confining the edit to part of the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as the first source image, and must contain both black and white areas. Requires source images uploaded as raw `images` bytes; masks cannot be combined with `image_asset_identifiers`. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three other source images. Supplying a mask fixes the output to the first source's own size, so `size` is rejected alongside it. + /// An optional mask that limits the edit to part of the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the first source image and contain both black and white areas. A masked request can include at most three other source images. With a mask, the output is always the first source image's own size, so `size` cannot be set. /// /// - /// An optional mask confining the edit to part of the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as the first source image, and must contain both black and white areas. Requires source images uploaded as raw `images` bytes; masks cannot be combined with `image_asset_identifiers`. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three other source images. Supplying a mask fixes the output to the first source's own size, so `size` is rejected alongside it. + /// An optional mask that limits the edit to part of the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the first source image and contain both black and white areas. A masked request can include at most three other source images. With a mask, the output is always the first source image's own size, so `size` cannot be set. /// /// /// The output size: "auto", "source" or an exact "WIDTHxHEIGHT".
/// Without source images, an exact size must be one of the supported
/// 1K/2K presets (for example 1024x1024, 2048x2048 or 1440x2880);
- /// "auto" or omitted lets the server pick a supported size based on
- /// the prompt. "source" is rejected because there is no source image
- /// to size from.
- /// With source images, "auto" (the default) lets the server pick a
- /// supported 2K size from the source images and the prompt, and
- /// "source" returns the output at the first source image's own width
- /// and height. With "source", a source too large for the model is
- /// scaled down to fit while keeping its exact proportion. Whatever the
- /// size, every source image's aspect ratio must be between 1:6 and
- /// 6:1; the model does not accept a reference outside that range.
- /// An exact size must have both dimensions multiples of 32 and at least
- /// 256px, the total size at most 2048x2048 pixels, and the aspect ratio
- /// at most 6:1. Naming one reshapes the source to it.
+ /// "auto" or omitted picks a supported size based on the prompt.
+ /// "source" is rejected.
+ /// With source images, "auto" (the default) picks a supported 2K size
+ /// based on the source images and the prompt, and "source" returns the
+ /// output at the first source image's own width and height (scaled
+ /// down, keeping its proportions, if it is too large for the model).
+ /// Every source image's aspect ratio must be between 1:6 and 6:1.
+ /// An exact size must have both sides a multiple of 32 and at least
+ /// 256px, a total of at most 2048x2048 pixels, and an aspect ratio of
+ /// at most 6:1. With source images, an exact size reshapes the source
+ /// to it.
/// Pricing is tiered by the resolved output pixels: up to 1024x1024
/// bills as 1K, above that as 2K. An "auto" size bills as 2K.
/// Default Value: auto
/// Example: 2048x2048 /// /// - /// The rendering quality to use. Higher quality renders take longer. With source images it defaults to `medium`, and `high` takes longer and is priced higher; `very_low` requires source images and is the fastest and cheapest. Without source images it defaults to `high`. + /// The rendering quality to use. Higher quality takes longer and costs more. Defaults to `medium` with source images and `high` without. `very_low`, the fastest and cheapest, requires source images. /// /// /// Random seed. Set for reproducible generation.
@@ -979,10 +911,10 @@ request.Maskname is null /// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV2.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV2.g.cs index 69f3ae2e..35cfe0fd 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV2.g.cs @@ -44,18 +44,10 @@ partial void ProcessPostGenerateImageV2IdeogramV2ResponseContent( ref string content); /// - /// Generate images with Ideogram 2.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2.0,
- /// with an optional style type and negative prompt. Set
- /// `rendering_speed` to `turbo` for faster, lower-cost generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2.0
+ /// Generate images from a text prompt with Ideogram 2.0. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -82,18 +74,10 @@ partial void ProcessPostGenerateImageV2IdeogramV2ResponseContent( return __response.Body; } /// - /// Generate images with Ideogram 2.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2.0,
- /// with an optional style type and negative prompt. Set
- /// `rendering_speed` to `turbo` for faster, lower-cost generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2.0
+ /// Generate images from a text prompt with Ideogram 2.0. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -704,18 +688,10 @@ partial void ProcessPostGenerateImageV2IdeogramV2ResponseContent( } } /// - /// Generate images with Ideogram 2.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2.0,
- /// with an optional style type and negative prompt. Set
- /// `rendering_speed` to `turbo` for faster, lower-cost generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2.0
+ /// Generate images from a text prompt with Ideogram 2.0. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -724,7 +700,7 @@ partial void ProcessPostGenerateImageV2IdeogramV2ResponseContent( /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -753,10 +729,10 @@ partial void ProcessPostGenerateImageV2IdeogramV2ResponseContent( /// Example: realistic /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV2A.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV2A.g.cs index cc41dad8..7d789f71 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV2A.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV2A.g.cs @@ -44,18 +44,11 @@ partial void ProcessPostGenerateImageV2IdeogramV2AResponseContent( ref string content); /// - /// Generate images with Ideogram 2a from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2a, a
- /// fast, lower-cost model, with an optional style type. Set
- /// `rendering_speed` to `turbo` for even faster generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2a
+ /// Generate images from a text prompt with Ideogram 2a, a fast, lower-cost
+ /// model. Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -82,18 +75,11 @@ partial void ProcessPostGenerateImageV2IdeogramV2AResponseContent( return __response.Body; } /// - /// Generate images with Ideogram 2a from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2a, a
- /// fast, lower-cost model, with an optional style type. Set
- /// `rendering_speed` to `turbo` for even faster generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2a
+ /// Generate images from a text prompt with Ideogram 2a, a fast, lower-cost
+ /// model. Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -704,18 +690,11 @@ partial void ProcessPostGenerateImageV2IdeogramV2AResponseContent( } } /// - /// Generate images with Ideogram 2a from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 2a, a
- /// fast, lower-cost model, with an optional style type. Set
- /// `rendering_speed` to `turbo` for even faster generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 2a
+ /// Generate images from a text prompt with Ideogram 2a, a fast, lower-cost
+ /// model. Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -750,10 +729,10 @@ partial void ProcessPostGenerateImageV2IdeogramV2AResponseContent( /// Example: realistic /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3.g.cs index aaaf99cd..97aea0da 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3.g.cs @@ -44,22 +44,12 @@ partial void ProcessPostGenerateImageV2IdeogramV3ResponseContent( ref string content); /// - /// Generate images with Ideogram 3.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 3.0,
- /// with optional style controls: style codes, a style preset, a color
- /// palette, or style references. Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). These three style reference forms cannot be combined.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 3.0
+ /// Generate images from a text prompt with Ideogram 3.0. Optional style
+ /// controls include style codes, a style preset, a color palette, and style
+ /// references (uploaded `style_reference_images`). Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -86,22 +76,12 @@ partial void ProcessPostGenerateImageV2IdeogramV3ResponseContent( return __response.Body; } /// - /// Generate images with Ideogram 3.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 3.0,
- /// with optional style controls: style codes, a style preset, a color
- /// palette, or style references. Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). These three style reference forms cannot be combined.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 3.0
+ /// Generate images from a text prompt with Ideogram 3.0. Optional style
+ /// controls include style codes, a style preset, a color palette, and style
+ /// references (uploaded `style_reference_images`). Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -917,22 +897,12 @@ partial void ProcessPostGenerateImageV2IdeogramV3ResponseContent( } } /// - /// Generate images with Ideogram 3.0 from a text prompt
- /// Generate one or more images from a text prompt with Ideogram 3.0,
- /// with optional style controls: style codes, a style preset, a color
- /// palette, or style references. Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). These three style reference forms cannot be combined.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 3.0
+ /// Generate images from a text prompt with Ideogram 3.0. Optional style
+ /// controls include style codes, a style preset, a color palette, and style
+ /// references (uploaded `style_reference_images`). Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -941,7 +911,7 @@ partial void ProcessPostGenerateImageV2IdeogramV3ResponseContent( /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -985,22 +955,22 @@ partial void ProcessPostGenerateImageV2IdeogramV3ResponseContent( /// A predefined style preset to apply to the generated images. Cannot be combined with style codes or style references. /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_asset_identifiers` or `style_reference_images`. + /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_images`. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// /// /// Existing upload or generated image assets to use as style references, by reference. Cannot be combined with `style_reference_collection_id` or `style_reference_images`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `style_reference_collection_id` or `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3Character.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3Character.g.cs index 9eee149f..86139373 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3Character.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3Character.g.cs @@ -44,30 +44,12 @@ partial void ProcessPostGenerateImageV2IdeogramV3CharacterResponseContent( ref string content); /// - /// Generate images of a consistent character with Ideogram 3.0
- /// Generate one or more images featuring a consistent character with
- /// Ideogram 3.0. Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Style references may be combined with the character on accounts with
- /// access; otherwise the combination returns a 400. Supply them as a
- /// saved style (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate a consistent character with Ideogram 3.0
+ /// Generate images featuring a consistent character with Ideogram 3.0.
+ /// Upload the character as `character_reference_images` using
+ /// `multipart/form-data`. Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -94,30 +76,12 @@ partial void ProcessPostGenerateImageV2IdeogramV3CharacterResponseContent( return __response.Body; } /// - /// Generate images of a consistent character with Ideogram 3.0
- /// Generate one or more images featuring a consistent character with
- /// Ideogram 3.0. Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Style references may be combined with the character on accounts with
- /// access; otherwise the combination returns a 400. Supply them as a
- /// saved style (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate a consistent character with Ideogram 3.0
+ /// Generate images featuring a consistent character with Ideogram 3.0.
+ /// Upload the character as `character_reference_images` using
+ /// `multipart/form-data`. Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -993,30 +957,12 @@ request.CharacterReferenceMaskname is null } } /// - /// Generate images of a consistent character with Ideogram 3.0
- /// Generate one or more images featuring a consistent character with
- /// Ideogram 3.0. Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Style references may be combined with the character on accounts with
- /// access; otherwise the combination returns a 400. Supply them as a
- /// saved style (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate a consistent character with Ideogram 3.0
+ /// Generate images featuring a consistent character with Ideogram 3.0.
+ /// Upload the character as `character_reference_images` using
+ /// `multipart/form-data`. Returns
+ /// results directly by default; set `async` or supply a `webhook_url` to
+ /// get a `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1025,25 +971,25 @@ request.CharacterReferenceMaskname is null /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved character in `character_reference_collection_id`. Ignored without it. /// /// /// An existing upload or generated image asset to use as the character reference, by reference. Takes priority over `character_reference_images` if both are supplied. /// /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image of the character to feature (max 25MB; JPEG, PNG, or WEBP). /// /// - /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. + /// Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. + /// Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only. /// /// /// Random seed. Set for reproducible generation.
@@ -1076,22 +1022,22 @@ request.CharacterReferenceMaskname is null /// Default Value: auto /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// /// /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3CustomModel.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3CustomModel.g.cs index 485ae721..d0c4cc38 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3CustomModel.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3CustomModel.g.cs @@ -44,19 +44,11 @@ partial void ProcessPostGenerateImageV2IdeogramV3CustomModelResponseContent( ref string content); /// - /// Generate images with a custom Ideogram 3.0 model
- /// Generate one or more images with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds and whether it removes
- /// backgrounds automatically.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 3.0 model
+ /// Generate images with a custom Ideogram 3.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -83,19 +75,11 @@ partial void ProcessPostGenerateImageV2IdeogramV3CustomModelResponseContent( return __response.Body; } /// - /// Generate images with a custom Ideogram 3.0 model
- /// Generate one or more images with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds and whether it removes
- /// backgrounds automatically.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 3.0 model
+ /// Generate images with a custom Ideogram 3.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -923,19 +907,11 @@ partial void ProcessPostGenerateImageV2IdeogramV3CustomModelResponseContent( } } /// - /// Generate images with a custom Ideogram 3.0 model
- /// Generate one or more images with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds and whether it removes
- /// backgrounds automatically.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 3.0 model
+ /// Generate images with a custom Ideogram 3.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -944,11 +920,11 @@ partial void ProcessPostGenerateImageV2IdeogramV3CustomModelResponseContent( /// The prompt to generate images from. /// /// - /// The custom model URI returned by the custom-model API, in the form `model/<model_name>/version/<version_name>`. The authenticated user or organization must have access to the model.
+ /// The custom model URI, in the form `model/<model_name>/version/<version_name>`. You or your organization must have access to the model. The model determines which rendering speeds are supported and whether backgrounds are removed automatically.
/// Example: model/my-custom-model/version/1 /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -965,7 +941,7 @@ partial void ProcessPostGenerateImageV2IdeogramV3CustomModelResponseContent( /// it uses `1x1`. /// /// - /// The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model. + /// The rendering speed to use. When omitted, a speed supported by the custom model is used. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -989,13 +965,13 @@ partial void ProcessPostGenerateImageV2IdeogramV3CustomModelResponseContent( /// Existing upload or generated image assets to use as style references, by reference. Cannot be combined with `style_reference_images`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only. Cannot be combined with `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3Transparent.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3Transparent.g.cs index 5db27ec6..adf4f9c1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3Transparent.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV3Transparent.g.cs @@ -44,18 +44,11 @@ partial void ProcessPostGenerateImageV2IdeogramV3TransparentResponseContent( ref string content); /// - /// Generate transparent-background images with Ideogram 3.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 3.0, delivered as PNGs with alpha. An optional
- /// `upscale_factor` increases the output size after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 3.0
+ /// Generate images on a transparent background with Ideogram 3.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -82,18 +75,11 @@ partial void ProcessPostGenerateImageV2IdeogramV3TransparentResponseContent( return __response.Body; } /// - /// Generate transparent-background images with Ideogram 3.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 3.0, delivered as PNGs with alpha. An optional
- /// `upscale_factor` increases the output size after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 3.0
+ /// Generate images on a transparent background with Ideogram 3.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -704,18 +690,11 @@ partial void ProcessPostGenerateImageV2IdeogramV3TransparentResponseContent( } } /// - /// Generate transparent-background images with Ideogram 3.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 3.0, delivered as PNGs with alpha. An optional
- /// `upscale_factor` increases the output size after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 3.0
+ /// Generate images on a transparent background with Ideogram 3.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -724,7 +703,7 @@ partial void ProcessPostGenerateImageV2IdeogramV3TransparentResponseContent( /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -753,10 +732,10 @@ partial void ProcessPostGenerateImageV2IdeogramV3TransparentResponseContent( /// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4.g.cs index c3a695d8..0bd42a22 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4.g.cs @@ -44,25 +44,11 @@ partial void ProcessPostGenerateImageV2IdeogramV4ResponseContent( ref string content); /// - /// Generate images with Ideogram 4.0 from a text or structured prompt
- /// Generate one or more images from a prompt with Ideogram 4.0. The
- /// `prompt` accepts either natural language or a structured Ideogram 4.0
- /// JSON prompt; the server detects which was supplied. A structured JSON
- /// prompt is consumed by the model directly and skips magic prompt.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// When `resolution` is omitted, the server picks an aspect ratio
- /// automatically based on the prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.0
+ /// Generate images with Ideogram 4.0 from a natural-language or structured
+ /// JSON prompt. Returns results directly by default; set `async` or supply
+ /// a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -89,25 +75,11 @@ partial void ProcessPostGenerateImageV2IdeogramV4ResponseContent( return __response.Body; } /// - /// Generate images with Ideogram 4.0 from a text or structured prompt
- /// Generate one or more images from a prompt with Ideogram 4.0. The
- /// `prompt` accepts either natural language or a structured Ideogram 4.0
- /// JSON prompt; the server detects which was supplied. A structured JSON
- /// prompt is consumed by the model directly and skips magic prompt.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// When `resolution` is omitted, the server picks an aspect ratio
- /// automatically based on the prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.0
+ /// Generate images with Ideogram 4.0 from a natural-language or structured
+ /// JSON prompt. Returns results directly by default; set `async` or supply
+ /// a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -718,42 +690,26 @@ partial void ProcessPostGenerateImageV2IdeogramV4ResponseContent( } } /// - /// Generate images with Ideogram 4.0 from a text or structured prompt
- /// Generate one or more images from a prompt with Ideogram 4.0. The
- /// `prompt` accepts either natural language or a structured Ideogram 4.0
- /// JSON prompt; the server detects which was supplied. A structured JSON
- /// prompt is consumed by the model directly and skips magic prompt.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// When `resolution` is omitted, the server picks an aspect ratio
- /// automatically based on the prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Ideogram 4.0
+ /// Generate images with Ideogram 4.0 from a natural-language or structured
+ /// JSON prompt. Returns results directly by default; set `async` or supply
+ /// a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt. /// /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`.
/// Default Value: auto /// /// @@ -766,18 +722,18 @@ partial void ProcessPostGenerateImageV2IdeogramV4ResponseContent( /// /// /// Optional. When supplied, the images are generated at this
- /// resolution. When omitted, the server picks an aspect ratio
- /// automatically based on the prompt. + /// resolution. When omitted, an aspect ratio is picked automatically
+ /// based on the prompt. /// /// /// The rendering speed to use.
/// Default Value: default /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4CustomModel.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4CustomModel.g.cs index d3b19097..ad4c53c7 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4CustomModel.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4CustomModel.g.cs @@ -44,21 +44,11 @@ partial void ProcessPostGenerateImageV2IdeogramV4CustomModelResponseContent( ref string content); /// - /// Generate images with a custom Ideogram 4.0 model
- /// Generate one or more images with a custom Ideogram 4.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds.
- /// The `prompt` accepts either natural language or a structured Ideogram
- /// 4.0 JSON prompt; the server detects which was supplied. A structured
- /// JSON prompt is consumed by the model directly and skips magic prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 4.0 model
+ /// Generate images with a custom Ideogram 4.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -85,21 +75,11 @@ partial void ProcessPostGenerateImageV2IdeogramV4CustomModelResponseContent( return __response.Body; } /// - /// Generate images with a custom Ideogram 4.0 model
- /// Generate one or more images with a custom Ideogram 4.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds.
- /// The `prompt` accepts either natural language or a structured Ideogram
- /// 4.0 JSON prompt; the server detects which was supplied. A structured
- /// JSON prompt is consumed by the model directly and skips magic prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 4.0 model
+ /// Generate images with a custom Ideogram 4.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -742,33 +722,22 @@ partial void ProcessPostGenerateImageV2IdeogramV4CustomModelResponseContent( } } /// - /// Generate images with a custom Ideogram 4.0 model
- /// Generate one or more images with a custom Ideogram 4.0 model that the
- /// authenticated user or organization can access. The model registry
- /// controls the model's supported rendering speeds.
- /// The `prompt` accepts either natural language or a structured Ideogram
- /// 4.0 JSON prompt; the server detects which was supplied. A structured
- /// JSON prompt is consumed by the model directly and skips magic prompt.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with a custom Ideogram 4.0 model
+ /// Generate images with a custom Ideogram 4.0 model that you or your
+ /// organization can access, selected by `custom_model_uri`. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt. /// /// - /// The custom model URI returned by the custom-model API, in the form `model/<model_name>/version/<version_name>`. The authenticated user or organization must have access to the model.
+ /// The custom model URI, in the form `model/<model_name>/version/<version_name>`. You or your organization must have access to the model. The model determines which rendering speeds are supported.
/// Example: model/my-custom-v4-model/version/1 /// /// @@ -778,9 +747,8 @@ partial void ProcessPostGenerateImageV2IdeogramV4CustomModelResponseContent( /// /// Controls how a natural-language prompt is prepared. `auto` (the
/// default) and `on` rewrite and expand the prompt before generation.
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes. A prompt that is already a
- /// valid structured JSON prompt skips magic prompt entirely unless
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
/// `magic_prompt` is `on`.
/// Default Value: auto /// @@ -794,17 +762,17 @@ partial void ProcessPostGenerateImageV2IdeogramV4CustomModelResponseContent( /// /// /// Optional. When supplied, the images are generated at this
- /// resolution. When omitted, the server picks an aspect ratio
- /// automatically based on the prompt. + /// resolution. When omitted, an aspect ratio is picked automatically
+ /// based on the prompt. /// /// - /// The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model. + /// The rendering speed to use. When omitted, a speed supported by the custom model is used. /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4Transparent.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4Transparent.g.cs index a032432d..e021d531 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4Transparent.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2IdeogramV4Transparent.g.cs @@ -44,27 +44,11 @@ partial void ProcessPostGenerateImageV2IdeogramV4TransparentResponseContent( ref string content); /// - /// Generate transparent-background images with Ideogram 4.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 4.0, delivered as PNGs with alpha. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; a
- /// structured prompt is consumed directly and skips magic prompt, except
- /// that its background description is replaced with a
- /// transparent-background directive.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// `output_resolution` selects the output tier (1k to 8k); tiers above
- /// 2K are produced by upscaling after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 4.0
+ /// Generate images on a transparent background with Ideogram 4.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -91,27 +75,11 @@ partial void ProcessPostGenerateImageV2IdeogramV4TransparentResponseContent( return __response.Body; } /// - /// Generate transparent-background images with Ideogram 4.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 4.0, delivered as PNGs with alpha. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; a
- /// structured prompt is consumed directly and skips magic prompt, except
- /// that its background description is replaced with a
- /// transparent-background directive.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// `output_resolution` selects the output tier (1k to 8k); tiers above
- /// 2K are produced by upscaling after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 4.0
+ /// Generate images on a transparent background with Ideogram 4.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -722,46 +690,27 @@ partial void ProcessPostGenerateImageV2IdeogramV4TransparentResponseContent( } } /// - /// Generate transparent-background images with Ideogram 4.0
- /// Generate one or more images on a transparent background with
- /// Ideogram 4.0, delivered as PNGs with alpha. The `prompt` accepts
- /// either natural language or a structured Ideogram 4.0 JSON prompt; a
- /// structured prompt is consumed directly and skips magic prompt, except
- /// that its background description is replaced with a
- /// transparent-background directive.
- /// `magic_prompt` controls how a natural-language prompt is prepared:
- /// `auto`/`on` rewrite and expand the prompt before generation, while
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes.
- /// `output_resolution` selects the output tier (1k to 8k); tiers above
- /// 2K are produced by upscaling after generation.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate transparent images with Ideogram 4.0
+ /// Generate images on a transparent background with Ideogram 4.0, delivered
+ /// as PNGs with alpha. Returns results directly by default; set `async` or
+ /// supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt, except that its
- /// background description is replaced with a transparent-background
- /// directive. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt, except that its background
+ /// description is replaced with a transparent background. /// /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`.
/// Default Value: auto /// /// @@ -780,11 +729,11 @@ partial void ProcessPostGenerateImageV2IdeogramV4TransparentResponseContent( /// Default Value: auto /// /// - /// The output resolution tier for the generated images. Tiers are
- /// total-pixel budgets matching a square of the named size (for
- /// example, `8k` delivers at most 8192x8192 total pixels); wide and
- /// tall aspect ratios keep the same pixel budget, so a single
- /// dimension may exceed the named size. Defaults to 1k.
+ /// The output resolution tier. Each tier is a total pixel budget equal
+ /// to a square of the named size (for example, `8k` delivers at most
+ /// 8192x8192 pixels in total). Wide and tall aspect ratios keep the
+ /// same budget, so one side may exceed the named size. Tiers above
+ /// 2k are produced by upscaling after generation. Defaults to 1k.
/// Default Value: 1k /// /// @@ -792,10 +741,10 @@ partial void ProcessPostGenerateImageV2IdeogramV4TransparentResponseContent( /// Default Value: default /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2NanoBanana2.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2NanoBanana2.g.cs index c839ff12..b88d77c1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2NanoBanana2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2NanoBanana2.g.cs @@ -44,25 +44,12 @@ partial void ProcessPostGenerateImageV2NanoBanana2ResponseContent( ref string content); /// - /// Generate images with Nano Banana 2, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana 2. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana 2
+ /// Generate images with Nano Banana 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -89,25 +76,12 @@ partial void ProcessPostGenerateImageV2NanoBanana2ResponseContent( return __response.Body; } /// - /// Generate images with Nano Banana 2, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana 2. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana 2
+ /// Generate images with Nano Banana 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -811,37 +785,24 @@ partial void ProcessPostGenerateImageV2NanoBanana2ResponseContent( } } /// - /// Generate images with Nano Banana 2, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana 2. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana 2
+ /// Generate images with Nano Banana 2. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// /// The requested output aspect ratio, for example "1:1", "16:9", or "9:16". The output is served at the closest aspect ratio the model supports, at the requested resolution tier. Defaults to "1:1". @@ -859,7 +820,7 @@ partial void ProcessPostGenerateImageV2NanoBanana2ResponseContent( /// Example: 12345 /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2NanoBananaPro.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2NanoBananaPro.g.cs index 81343efe..7de68376 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2NanoBananaPro.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2NanoBananaPro.g.cs @@ -44,25 +44,12 @@ partial void ProcessPostGenerateImageV2NanoBananaProResponseContent( ref string content); /// - /// Generate images with Nano Banana Pro, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana Pro. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana Pro
+ /// Generate images with Nano Banana Pro. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -89,25 +76,12 @@ partial void ProcessPostGenerateImageV2NanoBananaProResponseContent( return __response.Body; } /// - /// Generate images with Nano Banana Pro, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana Pro. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana Pro
+ /// Generate images with Nano Banana Pro. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -811,37 +785,24 @@ partial void ProcessPostGenerateImageV2NanoBananaProResponseContent( } } /// - /// Generate images with Nano Banana Pro, from a text prompt or by editing source images
- /// Generate one or more images with Nano Banana Pro. The prompt is
- /// consumed by the model directly, without rewriting.
- /// Supplying source images turns the request into an edit: the model
- /// applies the prompt to the sources. Provide them either as
- /// `image_asset_identifiers` references (images already stored with
- /// Ideogram) or as raw `images` bytes (multipart requests only) — if both
- /// are supplied, the references win and the bytes are ignored. Without
- /// source images the prompt alone drives the generation.
- /// The output is served at the closest aspect ratio the model supports,
- /// at the requested `resolution_tier` (1K by default).
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Nano Banana Pro
+ /// Generate images with Nano Banana Pro. Optionally upload source images as
+ /// `images` using `multipart/form-data` to edit them with the prompt.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// /// The requested output aspect ratio, for example "1:1", "16:9", or "9:16". The output is served at the closest aspect ratio the model supports, at the requested resolution tier. Defaults to "1:1". @@ -859,7 +820,7 @@ partial void ProcessPostGenerateImageV2NanoBananaProResponseContent( /// Example: 12345 /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2PImageIdeogram.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2PImageIdeogram.g.cs index b22ce34b..39a1d2ad 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2PImageIdeogram.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2PImageIdeogram.g.cs @@ -44,19 +44,11 @@ partial void ProcessPostGenerateImageV2PImageIdeogramResponseContent( ref string content); /// - /// Generate images with P-Image Ideogram from a text or structured prompt
- /// Generate one or more images with P-Image Ideogram, a fast model with
- /// selectable quality and resolution tiers. The `prompt` accepts either
- /// natural language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with P-Image Ideogram
+ /// Generate images with P-Image Ideogram, a fast model with selectable
+ /// quality and resolution tiers. Returns results directly by default; set
+ /// `async` or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -83,19 +75,11 @@ partial void ProcessPostGenerateImageV2PImageIdeogramResponseContent( return __response.Body; } /// - /// Generate images with P-Image Ideogram from a text or structured prompt
- /// Generate one or more images with P-Image Ideogram, a fast model with
- /// selectable quality and resolution tiers. The `prompt` accepts either
- /// natural language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with P-Image Ideogram
+ /// Generate images with P-Image Ideogram, a fast model with selectable
+ /// quality and resolution tiers. Returns results directly by default; set
+ /// `async` or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -706,27 +690,18 @@ partial void ProcessPostGenerateImageV2PImageIdeogramResponseContent( } } /// - /// Generate images with P-Image Ideogram from a text or structured prompt
- /// Generate one or more images with P-Image Ideogram, a fast model with
- /// selectable quality and resolution tiers. The `prompt` accepts either
- /// natural language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with P-Image Ideogram
+ /// Generate images with P-Image Ideogram, a fast model with selectable
+ /// quality and resolution tiers. Returns results directly by default; set
+ /// `async` or supply a `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. /// /// /// Controls magic prompt (automatic prompt rewriting). `off` disables magic prompt entirely. Defaults to `auto`.
@@ -745,7 +720,7 @@ partial void ProcessPostGenerateImageV2PImageIdeogramResponseContent( /// Default Value: medium /// /// - /// The output-size tier; the server defaults to `1k` when omitted. Cannot be combined with `custom_width`/`custom_height`. + /// The output size tier. Defaults to `1k`. Cannot be combined with `custom_width`/`custom_height`. /// /// /// The output aspect ratio. Defaults to `1x1`.
@@ -766,10 +741,10 @@ partial void ProcessPostGenerateImageV2PImageIdeogramResponseContent( /// billing behavior. /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2ZImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2ZImage.g.cs index adcc1e3d..10c0d9c0 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2ZImage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.PostGenerateImageV2ZImage.g.cs @@ -44,17 +44,10 @@ partial void ProcessPostGenerateImageV2ZImageResponseContent( ref string content); /// - /// Generate images with Z-Image from a text prompt
- /// Generate one or more images from a text prompt with Z-Image. The base
- /// model is pinned server-side.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Z-Image
+ /// Generate images from a text prompt with Z-Image. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -81,17 +74,10 @@ partial void ProcessPostGenerateImageV2ZImageResponseContent( return __response.Body; } /// - /// Generate images with Z-Image from a text prompt
- /// Generate one or more images from a text prompt with Z-Image. The base
- /// model is pinned server-side.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Z-Image
+ /// Generate images from a text prompt with Z-Image. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -702,17 +688,10 @@ partial void ProcessPostGenerateImageV2ZImageResponseContent( } } /// - /// Generate images with Z-Image from a text prompt
- /// Generate one or more images from a text prompt with Z-Image. The base
- /// model is pinned server-side.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Generate with Z-Image
+ /// Generate images from a text prompt with Z-Image. Returns results
+ /// directly by default; set `async` or supply a `webhook_url` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -726,8 +705,8 @@ partial void ProcessPostGenerateImageV2ZImageResponseContent( /// Example: 1024x1024 /// /// - /// Optional diffusion step count. When omitted, the server uses the
- /// model's default. Higher values trade latency for quality.
+ /// Optional number of diffusion steps. When omitted, the model's
+ /// default is used. Higher values improve quality but take longer.
/// Example: 8 /// /// @@ -739,7 +718,7 @@ partial void ProcessPostGenerateImageV2ZImageResponseContent( /// Default Value: 1 /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.g.cs index 5328c632..89423e09 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesGenerateClient.g.cs @@ -7,7 +7,7 @@ namespace Ideogram /// Generate images with a specific model contract. Requests are JSON
/// (Ideogram 3.0 also accepts multipart for style reference bytes) and
/// return a generation id that can be polled via
- /// `GET /v1/generations/{generation_id}`.
+ /// `GET /v2/generations/{generation_id}`.
/// If no httpClient is provided, a new one will be created.
/// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesInpaint.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesInpaint.JsonSerializerContext.g.cs index 5196bdc5..345d79df 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesInpaint.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesInpaint.JsonSerializerContext.g.cs @@ -19,10 +19,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(byte[]))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.MagicPromptMode), TypeInfoPropertyName = "MagicPromptMode2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.IdeogramV3StyleType), TypeInfoPropertyName = "IdeogramV3StyleType2")] diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3.g.cs index 5cfc4680..6854ca92 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3.g.cs @@ -44,31 +44,13 @@ partial void ProcessPostInpaintImageV2IdeogramV3ResponseContent( ref string content); /// - /// Repaint a masked region with Ideogram 3.0, by asset id or by uploaded bytes
- /// Repaint the masked region of a source image from a text prompt with
- /// Ideogram 3.0. For each of the source image and the mask, supply either
- /// an `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or the raw image bytes directly (`image` /
- /// `mask`, multipart requests only). If both a reference and bytes are
- /// supplied for the same input, the reference wins and the bytes are
- /// ignored.
- /// Optional style controls: style codes, a style preset, or style
- /// reference images.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0, guided
+ /// by a text prompt. Upload the source `image` and its `mask` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -95,31 +77,13 @@ partial void ProcessPostInpaintImageV2IdeogramV3ResponseContent( return __response.Body; } /// - /// Repaint a masked region with Ideogram 3.0, by asset id or by uploaded bytes
- /// Repaint the masked region of a source image from a text prompt with
- /// Ideogram 3.0. For each of the source image and the mask, supply either
- /// an `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or the raw image bytes directly (`image` /
- /// `mask`, multipart requests only). If both a reference and bytes are
- /// supplied for the same input, the reference wins and the bytes are
- /// ignored.
- /// Optional style controls: style codes, a style preset, or style
- /// reference images.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0, guided
+ /// by a text prompt. Upload the source `image` and its `mask` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1003,31 +967,13 @@ request.Maskname is null } } /// - /// Repaint a masked region with Ideogram 3.0, by asset id or by uploaded bytes
- /// Repaint the masked region of a source image from a text prompt with
- /// Ideogram 3.0. For each of the source image and the mask, supply either
- /// an `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or the raw image bytes directly (`image` /
- /// `mask`, multipart requests only). If both a reference and bytes are
- /// supplied for the same input, the reference wins and the bytes are
- /// ignored.
- /// Optional style controls: style codes, a style preset, or style
- /// reference images.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references (images already stored
- /// with Ideogram), or as raw `style_reference_images` bytes (multipart
- /// requests only). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0, guided
+ /// by a text prompt. Upload the source `image` and its `mask` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1040,20 +986,20 @@ request.Maskname is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -1084,7 +1030,7 @@ request.Maskname is null /// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -1093,13 +1039,13 @@ request.Maskname is null /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3Character.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3Character.g.cs index 6b45b872..96664339 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3Character.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3Character.g.cs @@ -44,40 +44,14 @@ partial void ProcessPostInpaintImageV2IdeogramV3CharacterResponseContent( ref string content); /// - /// Repaint a masked region with a consistent character with Ideogram 3.0
- /// Repaint the masked region of a source image so it features a
- /// consistent character, with Ideogram 3.0. For each of the source image
- /// and the mask, supply either an `AssetIdentifier` reference
- /// (`image_asset_identifier` / `mask_asset_identifier`) or the raw image
- /// bytes directly (`image` / `mask`, multipart requests only). If both a
- /// reference and bytes are supplied for the same input, the reference
- /// wins and the bytes are ignored.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Optional style controls may be combined with the character when
- /// `style_type` is `auto`. Supply either style codes or style references.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes (multipart requests only). If more than
- /// one reference form is supplied, the collection wins over the
- /// identifiers, and the identifiers win over the bytes. API-key callers
- /// also need access to the style-with-character API rollout.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint a consistent character with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0 so it
+ /// features a consistent character. Upload the source `image`, its
+ /// `mask`, and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -104,40 +78,14 @@ partial void ProcessPostInpaintImageV2IdeogramV3CharacterResponseContent( return __response.Body; } /// - /// Repaint a masked region with a consistent character with Ideogram 3.0
- /// Repaint the masked region of a source image so it features a
- /// consistent character, with Ideogram 3.0. For each of the source image
- /// and the mask, supply either an `AssetIdentifier` reference
- /// (`image_asset_identifier` / `mask_asset_identifier`) or the raw image
- /// bytes directly (`image` / `mask`, multipart requests only). If both a
- /// reference and bytes are supplied for the same input, the reference
- /// wins and the bytes are ignored.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Optional style controls may be combined with the character when
- /// `style_type` is `auto`. Supply either style codes or style references.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes (multipart requests only). If more than
- /// one reference form is supplied, the collection wins over the
- /// identifiers, and the identifiers win over the bytes. API-key callers
- /// also need access to the style-with-character API rollout.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint a consistent character with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0 so it
+ /// features a consistent character. Upload the source `image`, its
+ /// `mask`, and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1097,40 +1045,14 @@ request.CharacterReferenceMaskname is null } } /// - /// Repaint a masked region with a consistent character with Ideogram 3.0
- /// Repaint the masked region of a source image so it features a
- /// consistent character, with Ideogram 3.0. For each of the source image
- /// and the mask, supply either an `AssetIdentifier` reference
- /// (`image_asset_identifier` / `mask_asset_identifier`) or the raw image
- /// bytes directly (`image` / `mask`, multipart requests only). If both a
- /// reference and bytes are supplied for the same input, the reference
- /// wins and the bytes are ignored.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references (an image already
- /// stored with Ideogram), or as raw `character_reference_images` bytes
- /// (multipart requests only, with an optional
- /// `character_reference_mask` marking where the character is in the
- /// reference). If more than one form is supplied, the collection wins
- /// over the identifiers, and the identifiers win over the bytes.
- /// Optional style controls may be combined with the character when
- /// `style_type` is `auto`. Supply either style codes or style references.
- /// Supply style references as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes (multipart requests only). If more than
- /// one reference form is supplied, the collection wins over the
- /// identifiers, and the identifiers win over the bytes. API-key callers
- /// also need access to the style-with-character API rollout.
- /// The output matches the size of the source image (snapped to the
- /// nearest resolution the model renders). By default the request blocks
- /// until the images are ready and returns them in `data`. Set `async` to
- /// true to return immediately after the request is accepted, then poll
- /// for completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Inpaint a consistent character with Ideogram 3.0
+ /// Repaint the masked region of a source image with Ideogram 3.0 so it
+ /// features a consistent character. Upload the source `image`, its
+ /// `mask`, and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1143,23 +1065,23 @@ request.CharacterReferenceMaskname is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it. @@ -1168,7 +1090,7 @@ request.CharacterReferenceMaskname is null /// An existing upload or generated image asset to use as the character reference, by reference. Takes priority over `character_reference_images` if both are supplied. /// /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported. /// /// /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. @@ -1193,7 +1115,7 @@ request.CharacterReferenceMaskname is null /// Default Value: default /// /// - /// The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references require `auto`.
+ /// The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references (not both) require `auto`. For API-key callers, combining a style with a character requires that feature to be enabled for their account.
/// Default Value: auto /// /// @@ -1201,7 +1123,7 @@ request.CharacterReferenceMaskname is null /// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. Cannot be combined with `style_codes`. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. Cannot be combined with `style_codes`. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -1210,13 +1132,13 @@ request.CharacterReferenceMaskname is null /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. Cannot be combined with `style_codes`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. Cannot be combined with `style_codes`. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Cannot be combined with `style_codes`. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3CustomModel.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3CustomModel.g.cs index 4c2e1950..a2b2805e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3CustomModel.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.PostInpaintImageV2IdeogramV3CustomModel.g.cs @@ -44,22 +44,12 @@ partial void ProcessPostInpaintImageV2IdeogramV3CustomModelResponseContent( ref string content); /// - /// Repaint a masked region with a custom Ideogram 3.0 model
+ /// Inpaint with a custom Ideogram 3.0 model
/// Repaint the masked region of a source image with a custom Ideogram 3.0
- /// model the authenticated user or organization can access. Supply the
- /// model URI returned by the custom-model API as `custom_model_uri`.
- /// For each of the source image and mask, supply either an
- /// `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or raw bytes (`image` / `mask`, multipart
- /// requests only). A reference wins if both forms are supplied.
- /// Optional style controls are style codes, a style preset, or style
- /// reference images. Supply style references as a saved style, existing
- /// asset identifiers, or raw image bytes. Only one style control may be
- /// used; when multiple reference forms are supplied, the collection wins
- /// over identifiers, and identifiers win over bytes.
- /// By default the request blocks until the images are ready. Set `async`
- /// to true to return after dispatch and poll
- /// `GET /v1/generations/{generation_id}`. + /// model, passed as `custom_model_uri`. Upload the source `image` and its
+ /// `mask` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -86,22 +76,12 @@ partial void ProcessPostInpaintImageV2IdeogramV3CustomModelResponseContent( return __response.Body; } /// - /// Repaint a masked region with a custom Ideogram 3.0 model
+ /// Inpaint with a custom Ideogram 3.0 model
/// Repaint the masked region of a source image with a custom Ideogram 3.0
- /// model the authenticated user or organization can access. Supply the
- /// model URI returned by the custom-model API as `custom_model_uri`.
- /// For each of the source image and mask, supply either an
- /// `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or raw bytes (`image` / `mask`, multipart
- /// requests only). A reference wins if both forms are supplied.
- /// Optional style controls are style codes, a style preset, or style
- /// reference images. Supply style references as a saved style, existing
- /// asset identifiers, or raw image bytes. Only one style control may be
- /// used; when multiple reference forms are supplied, the collection wins
- /// over identifiers, and identifiers win over bytes.
- /// By default the request blocks until the images are ready. Set `async`
- /// to true to return after dispatch and poll
- /// `GET /v1/generations/{generation_id}`. + /// model, passed as `custom_model_uri`. Upload the source `image` and its
+ /// `mask` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -674,20 +654,24 @@ request.Maskname is null h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -696,11 +680,12 @@ request.Maskname is null } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -802,20 +787,24 @@ request.Maskname is null h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -824,11 +813,12 @@ request.Maskname is null } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -995,22 +985,12 @@ request.Maskname is null } } /// - /// Repaint a masked region with a custom Ideogram 3.0 model
+ /// Inpaint with a custom Ideogram 3.0 model
/// Repaint the masked region of a source image with a custom Ideogram 3.0
- /// model the authenticated user or organization can access. Supply the
- /// model URI returned by the custom-model API as `custom_model_uri`.
- /// For each of the source image and mask, supply either an
- /// `AssetIdentifier` reference (`image_asset_identifier` /
- /// `mask_asset_identifier`) or raw bytes (`image` / `mask`, multipart
- /// requests only). A reference wins if both forms are supplied.
- /// Optional style controls are style codes, a style preset, or style
- /// reference images. Supply style references as a saved style, existing
- /// asset identifiers, or raw image bytes. Only one style control may be
- /// used; when multiple reference forms are supplied, the collection wins
- /// over identifiers, and identifiers win over bytes.
- /// By default the request blocks until the images are ready. Set `async`
- /// to true to return after dispatch and poll
- /// `GET /v1/generations/{generation_id}`. + /// model, passed as `custom_model_uri`. Upload the source `image` and its
+ /// `mask` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1026,19 +1006,19 @@ request.Maskname is null /// The source image asset to repaint. Takes priority over `image`. /// /// - /// The source image to repaint (max size 25MB), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored when `image_asset_identifier` is supplied. + /// The source image to repaint (max 25MB), as JPEG, PNG, or WEBP. Multipart requests only. /// /// - /// The source image to repaint (max size 25MB), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored when `image_asset_identifier` is supplied. + /// The source image to repaint (max 25MB), as JPEG, PNG, or WEBP. Multipart requests only. /// /// /// A black-and-white mask asset the same size as the source image. Black marks the region to repaint. Takes priority over `mask`. /// /// - /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP bytes. Black marks the region to repaint. Multipart requests only; ignored when `mask_asset_identifier` is supplied. + /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP. Black marks the region to repaint. Multipart requests only. /// /// - /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP bytes. Black marks the region to repaint. Multipart requests only; ignored when `mask_asset_identifier` is supplied. + /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP. Black marks the region to repaint. Multipart requests only. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -1063,7 +1043,7 @@ request.Maskname is null /// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// A saved style, by its URL-safe base64 collection id. Takes priority over asset identifiers and raw style reference images. + /// A saved style, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id for the saved style. Ignored without `style_reference_collection_id`. @@ -1072,13 +1052,13 @@ request.Maskname is null /// Existing upload or generated image assets to use as style references. Takes priority over raw style reference images. /// /// - /// Images to use as style references (max 10, max size 25MB each), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored if a collection or asset identifiers are supplied. + /// Images to use as style references (max 10, max 25MB each), as JPEG, PNG, or WEBP. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images return `is_image_safe: false`. /// /// - /// When false, block until the images are ready. When true, return after dispatch and poll `GET /v1/generations/{generation_id}`.
+ /// When false, wait until the images are ready. When true, return as soon as the request is accepted and poll `GET /v2/generations/{generation_id}`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.g.cs index b3651a39..68f24c84 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesInpaintClient.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Repaint a masked region of an image with a specific model contract.
- /// Requests supply the source image and mask by `AssetIdentifier`
- /// reference or as uploaded bytes and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`.
+ /// Repaint a masked region of an image with a specific model.
/// If no httpClient is provided, a new one will be created.
/// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesPreciseEdit.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesPreciseEdit.JsonSerializerContext.g.cs index c597808d..043c6ba5 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesPreciseEdit.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesPreciseEdit.JsonSerializerContext.g.cs @@ -18,10 +18,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(bool))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(byte[]))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GeneratedImageObject))] diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesPreciseEditClient.PostPreciseEditImageV2Ideogram45.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesPreciseEditClient.PostPreciseEditImageV2Ideogram45.g.cs index 759b5211..5fa3554d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesPreciseEditClient.PostPreciseEditImageV2Ideogram45.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesPreciseEditClient.PostPreciseEditImageV2Ideogram45.g.cs @@ -44,44 +44,13 @@ partial void ProcessPostPreciseEditImageV2Ideogram45ResponseContent( ref string content); /// - /// Edit an image with Ideogram 4.5, keeping the source's exact geometry
- /// Edit an image with Ideogram 4.5, returning output at that image's exact
- /// width and height. An image too large for the model is scaled down to
- /// fit while keeping its exact proportion, and one whose aspect ratio is
- /// outside 1:6 to 6:1 is rejected — this endpoint never reshapes, so there
- /// is no size to reshape it to. Unlike
- /// `POST /v2/image/generate/ideogram-4-5`, this endpoint takes no `size`:
- /// the output always matches the image being edited, so the edit drops
- /// back into whatever it came from without reframing.
- /// When the output is delivered at the image's own size (every image the
- /// model can hold), pixels the edit did not meaningfully change are
- /// restored exactly from the image being edited, with the edited region
- /// blended smoothly into its surroundings — untouched areas stay
- /// identical across repeated edits. An image too large for the model is
- /// delivered at the scaled-down size, where every pixel is resampled, so
- /// it is returned as rendered.
- /// Supply the image to edit as an `image_asset_identifier` reference or as
- /// raw `image` bytes (multipart requests only); if both are supplied, the
- /// reference wins and the bytes are ignored. Add up to four more images
- /// via `reference_image_asset_identifiers` or `reference_images` to guide
- /// the edit — those are never edited themselves.
- /// Supply a `mask` to confine the edit to part of the image being edited.
- /// The mask is optional — without one the prompt is applied to the whole
- /// image. Masks are read as an additional reference image, so a masked
- /// request may carry at most three `reference_images`.
- /// The `prompt` is the edit instruction. It accepts either natural
- /// language or a structured JSON prompt; the server detects which was
- /// supplied. A natural-language instruction is automatically rewritten
- /// into the model's structured edit contract, while a prompt that is
- /// already valid structured JSON is consumed directly.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Precise edit with Ideogram 4.5
+ /// Edit an image with Ideogram 4.5 and get the result back at that image's
+ /// exact width and height. Upload the image as `image` using
+ /// `multipart/form-data`, with optional `reference_images` and a `mask`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -108,44 +77,13 @@ partial void ProcessPostPreciseEditImageV2Ideogram45ResponseContent( return __response.Body; } /// - /// Edit an image with Ideogram 4.5, keeping the source's exact geometry
- /// Edit an image with Ideogram 4.5, returning output at that image's exact
- /// width and height. An image too large for the model is scaled down to
- /// fit while keeping its exact proportion, and one whose aspect ratio is
- /// outside 1:6 to 6:1 is rejected — this endpoint never reshapes, so there
- /// is no size to reshape it to. Unlike
- /// `POST /v2/image/generate/ideogram-4-5`, this endpoint takes no `size`:
- /// the output always matches the image being edited, so the edit drops
- /// back into whatever it came from without reframing.
- /// When the output is delivered at the image's own size (every image the
- /// model can hold), pixels the edit did not meaningfully change are
- /// restored exactly from the image being edited, with the edited region
- /// blended smoothly into its surroundings — untouched areas stay
- /// identical across repeated edits. An image too large for the model is
- /// delivered at the scaled-down size, where every pixel is resampled, so
- /// it is returned as rendered.
- /// Supply the image to edit as an `image_asset_identifier` reference or as
- /// raw `image` bytes (multipart requests only); if both are supplied, the
- /// reference wins and the bytes are ignored. Add up to four more images
- /// via `reference_image_asset_identifiers` or `reference_images` to guide
- /// the edit — those are never edited themselves.
- /// Supply a `mask` to confine the edit to part of the image being edited.
- /// The mask is optional — without one the prompt is applied to the whole
- /// image. Masks are read as an additional reference image, so a masked
- /// request may carry at most three `reference_images`.
- /// The `prompt` is the edit instruction. It accepts either natural
- /// language or a structured JSON prompt; the server detects which was
- /// supplied. A natural-language instruction is automatically rewritten
- /// into the model's structured edit contract, while a prompt that is
- /// already valid structured JSON is consumed directly.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Precise edit with Ideogram 4.5
+ /// Edit an image with Ideogram 4.5 and get the result back at that image's
+ /// exact width and height. Upload the image as `image` using
+ /// `multipart/form-data`, with optional `reference_images` and a `mask`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -941,75 +879,42 @@ request.Maskname is null } } /// - /// Edit an image with Ideogram 4.5, keeping the source's exact geometry
- /// Edit an image with Ideogram 4.5, returning output at that image's exact
- /// width and height. An image too large for the model is scaled down to
- /// fit while keeping its exact proportion, and one whose aspect ratio is
- /// outside 1:6 to 6:1 is rejected — this endpoint never reshapes, so there
- /// is no size to reshape it to. Unlike
- /// `POST /v2/image/generate/ideogram-4-5`, this endpoint takes no `size`:
- /// the output always matches the image being edited, so the edit drops
- /// back into whatever it came from without reframing.
- /// When the output is delivered at the image's own size (every image the
- /// model can hold), pixels the edit did not meaningfully change are
- /// restored exactly from the image being edited, with the edited region
- /// blended smoothly into its surroundings — untouched areas stay
- /// identical across repeated edits. An image too large for the model is
- /// delivered at the scaled-down size, where every pixel is resampled, so
- /// it is returned as rendered.
- /// Supply the image to edit as an `image_asset_identifier` reference or as
- /// raw `image` bytes (multipart requests only); if both are supplied, the
- /// reference wins and the bytes are ignored. Add up to four more images
- /// via `reference_image_asset_identifiers` or `reference_images` to guide
- /// the edit — those are never edited themselves.
- /// Supply a `mask` to confine the edit to part of the image being edited.
- /// The mask is optional — without one the prompt is applied to the whole
- /// image. Masks are read as an additional reference image, so a masked
- /// request may carry at most three `reference_images`.
- /// The `prompt` is the edit instruction. It accepts either natural
- /// language or a structured JSON prompt; the server detects which was
- /// supplied. A natural-language instruction is automatically rewritten
- /// into the model's structured edit contract, while a prompt that is
- /// already valid structured JSON is consumed directly.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Precise edit with Ideogram 4.5
+ /// Edit an image with Ideogram 4.5 and get the result back at that image's
+ /// exact width and height. Upload the image as `image` using
+ /// `multipart/form-data`, with optional `reference_images` and a `mask`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The edit instruction to apply to the sources. Accepts either
- /// natural language or a structured JSON prompt; the server detects
- /// which was supplied. Natural language is automatically rewritten
- /// into the model's structured edit contract, while structured JSON
- /// is consumed directly. + /// The edit instruction, in natural language or as a structured JSON
+ /// prompt. Natural language is automatically converted into a
+ /// structured prompt; valid structured JSON is used as is. /// /// /// The image to edit, as an existing upload or generated image asset. Supply this or `image`, never both. Takes priority over `image` if both are supplied. Cannot be combined with `mask`. /// /// - /// The image to edit, as raw bytes (max size 25MB; JPEG, PNG, or WEBP only). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask`. + /// The image to edit (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it. Images too large for the model are scaled down, keeping their proportions, and returned as rendered. Images with an aspect ratio outside 1:6 to 6:1 are rejected. /// /// - /// The image to edit, as raw bytes (max size 25MB; JPEG, PNG, or WEBP only). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask`. + /// The image to edit (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it. Images too large for the model are scaled down, keeping their proportions, and returned as rendered. Images with an aspect ratio outside 1:6 to 6:1 are rejected. /// /// /// Optional additional images to guide the edit, by reference. These are never edited themselves; only `image_asset_identifier` or `image` is. Requires the image being edited to be supplied by reference too, and cannot be combined with `mask`. /// /// - /// Optional additional images to guide the edit (max 4, max size 25MB each), as raw bytes; only JPEG, PNG, and WEBP formats are supported. These are never edited themselves; only `image` is. Multipart requests only; ignored if `reference_image_asset_identifiers` is also supplied. A masked request may carry at most three, because the mask occupies one of the model's reference slots. + /// Optional images to guide the edit (max 4, max 25MB each; JPEG, PNG, or WEBP). They are never edited themselves; only `image` is. Multipart requests only. A request with a `mask` can include at most three, because the mask takes up one reference slot. /// /// - /// An optional mask confining the edit to part of `image`, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as `image`, and must contain both black and white areas. Requires the image being edited to be uploaded as raw `image` bytes in the same request; masks cannot be combined with asset references. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three `reference_images`. + /// An optional mask that limits the edit to part of `image` (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. A masked request can include at most three `reference_images`. /// /// - /// An optional mask confining the edit to part of `image`, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as `image`, and must contain both black and white areas. Requires the image being edited to be uploaded as raw `image` bytes in the same request; masks cannot be combined with asset references. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three `reference_images`. + /// An optional mask that limits the edit to part of `image` (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. A masked request can include at most three `reference_images`. /// /// /// The rendering quality to use. `very_low` is the fastest and cheapest, and `high` takes longer and is priced higher.
@@ -1024,10 +929,10 @@ request.Maskname is null /// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesReframe.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesReframe.JsonSerializerContext.g.cs index 5d94f57c..6ccb74fe 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesReframe.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesReframe.JsonSerializerContext.g.cs @@ -20,10 +20,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ResolutionV3), TypeInfoPropertyName = "ResolutionV32")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GeneratedImageObject))] diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesReframeClient.IdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesReframeClient.IdeogramV3.g.cs index a119a5d8..1a9acfae 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesReframeClient.IdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesReframeClient.IdeogramV3.g.cs @@ -44,19 +44,12 @@ partial void ProcessIdeogramV3ResponseContent( ref string content); /// - /// Reframe an image with Ideogram 3.0, by asset id or by uploaded bytes
- /// Expand an image to a new Ideogram 3.0 resolution. The source pixels
- /// are preserved in the center and Ideogram fills the new area. Supply
- /// exactly one source: an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or raw image bytes (`image`, multipart
- /// requests only). Supplying both forms, or neither, is rejected.
- /// Optional style controls are mutually exclusive. Supply at most one of
- /// `style_preset`, `style_codes`, `style_reference_asset_identifiers`, or
- /// raw `style_reference_images` (multipart requests only). Each style
- /// reference transport accepts at most 10 images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately, then poll
- /// `GET /v1/generations/{generation_id}`. + /// Reframe with Ideogram 3.0
+ /// Expand an image to a new Ideogram 3.0 resolution, keeping the source
+ /// pixels in the center and filling the new area. Upload the source
+ /// `image` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -83,19 +76,12 @@ partial void ProcessIdeogramV3ResponseContent( return __response.Body; } /// - /// Reframe an image with Ideogram 3.0, by asset id or by uploaded bytes
- /// Expand an image to a new Ideogram 3.0 resolution. The source pixels
- /// are preserved in the center and Ideogram fills the new area. Supply
- /// exactly one source: an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or raw image bytes (`image`, multipart
- /// requests only). Supplying both forms, or neither, is rejected.
- /// Optional style controls are mutually exclusive. Supply at most one of
- /// `style_preset`, `style_codes`, `style_reference_asset_identifiers`, or
- /// raw `style_reference_images` (multipart requests only). Each style
- /// reference transport accepts at most 10 images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately, then poll
- /// `GET /v1/generations/{generation_id}`. + /// Reframe with Ideogram 3.0
+ /// Expand an image to a new Ideogram 3.0 resolution, keeping the source
+ /// pixels in the center and filling the new area. Upload the source
+ /// `image` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -841,19 +827,12 @@ request.Imagename is null } } /// - /// Reframe an image with Ideogram 3.0, by asset id or by uploaded bytes
- /// Expand an image to a new Ideogram 3.0 resolution. The source pixels
- /// are preserved in the center and Ideogram fills the new area. Supply
- /// exactly one source: an `AssetIdentifier` reference
- /// (`image_asset_identifier`) or raw image bytes (`image`, multipart
- /// requests only). Supplying both forms, or neither, is rejected.
- /// Optional style controls are mutually exclusive. Supply at most one of
- /// `style_preset`, `style_codes`, `style_reference_asset_identifiers`, or
- /// raw `style_reference_images` (multipart requests only). Each style
- /// reference transport accepts at most 10 images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately, then poll
- /// `GET /v1/generations/{generation_id}`. + /// Reframe with Ideogram 3.0
+ /// Expand an image to a new Ideogram 3.0 resolution, keeping the source
+ /// pixels in the center and filling the new area. Upload the source
+ /// `image` using `multipart/form-data`. Returns results directly by
+ /// default; set `async` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -863,10 +842,10 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The JPEG, PNG, or WEBP image to reframe (max 25MB), as raw bytes. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only. /// /// - /// The JPEG, PNG, or WEBP image to reframe (max 25MB), as raw bytes. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only. /// /// /// The resolutions supported for Ideogram 3.0.
@@ -898,7 +877,7 @@ request.Imagename is null /// Existing upload or generated image assets to use as style references. Cannot be combined with a style preset, style codes, or uploaded style reference images. /// /// - /// JPEG, PNG, or WEBP style reference images (max 10, max 25MB each), as raw bytes. Multipart requests only. Cannot be combined with a style preset, style codes, or referenced style assets. + /// JPEG, PNG, or WEBP style reference images (max 10, max 25MB each). Multipart requests only. Cannot be combined with `style_preset` or `style_codes`. /// /// /// Return immediately instead of waiting for reframed images.
diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesReframeClient.NanoBanana2.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesReframeClient.NanoBanana2.g.cs index e55097c7..de750330 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesReframeClient.NanoBanana2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesReframeClient.NanoBanana2.g.cs @@ -44,14 +44,11 @@ partial void ProcessNanoBanana2ResponseContent( ref string content); /// - /// Reframe an image with Nano Banana 2
- /// Expand one image to a new aspect ratio with Nano Banana 2.
- /// Supply either an existing Ideogram image asset or raw image bytes,
- /// but not both. The requested aspect ratio is resolved to the closest
- /// supported 1K output dimensions.
- /// This operation is asynchronous. It returns as soon as the request is
- /// accepted; poll `GET /v1/generations/{generation_id}` for completion
- /// and results. + /// Reframe with Nano Banana 2
+ /// Expand an image to a new aspect ratio with Nano Banana 2. Upload the
+ /// source `image` using `multipart/form-data`. Always asynchronous:
+ /// returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// for results. ///
/// /// Default Value: false @@ -78,14 +75,11 @@ partial void ProcessNanoBanana2ResponseContent( return __response.Body; } /// - /// Reframe an image with Nano Banana 2
- /// Expand one image to a new aspect ratio with Nano Banana 2.
- /// Supply either an existing Ideogram image asset or raw image bytes,
- /// but not both. The requested aspect ratio is resolved to the closest
- /// supported 1K output dimensions.
- /// This operation is asynchronous. It returns as soon as the request is
- /// accepted; poll `GET /v1/generations/{generation_id}` for completion
- /// and results. + /// Reframe with Nano Banana 2
+ /// Expand an image to a new aspect ratio with Nano Banana 2. Upload the
+ /// source `image` using `multipart/form-data`. Always asynchronous:
+ /// returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// for results. ///
/// /// Default Value: false @@ -773,14 +767,11 @@ request.Imagename is null } } /// - /// Reframe an image with Nano Banana 2
- /// Expand one image to a new aspect ratio with Nano Banana 2.
- /// Supply either an existing Ideogram image asset or raw image bytes,
- /// but not both. The requested aspect ratio is resolved to the closest
- /// supported 1K output dimensions.
- /// This operation is asynchronous. It returns as soon as the request is
- /// accepted; poll `GET /v1/generations/{generation_id}` for completion
- /// and results. + /// Reframe with Nano Banana 2
+ /// Expand an image to a new aspect ratio with Nano Banana 2. Upload the
+ /// source `image` using `multipart/form-data`. Always asynchronous:
+ /// returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// for results. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesRemix.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesRemix.JsonSerializerContext.g.cs index ca1f3a98..c60d8c00 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesRemix.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesRemix.JsonSerializerContext.g.cs @@ -22,10 +22,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ResolutionV3), TypeInfoPropertyName = "ResolutionV32")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.MagicPromptMode), TypeInfoPropertyName = "MagicPromptMode2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.IdeogramColorPalette), TypeInfoPropertyName = "IdeogramColorPalette2")] diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3.g.cs index 8d6eb232..c145326b 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3.g.cs @@ -44,29 +44,12 @@ partial void ProcessPostRemixImageV2IdeogramV3ResponseContent( ref string content); /// - /// Remix an existing image with Ideogram 3.0, guided by a prompt
+ /// Remix with Ideogram 3.0
/// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Optional style controls work as on the Ideogram 3.0 generate
- /// endpoint: style codes, a style preset, a color palette, or style
- /// reference images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -93,29 +76,12 @@ partial void ProcessPostRemixImageV2IdeogramV3ResponseContent( return __response.Body; } /// - /// Remix an existing image with Ideogram 3.0, guided by a prompt
+ /// Remix with Ideogram 3.0
/// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Optional style controls work as on the Ideogram 3.0 generate
- /// endpoint: style codes, a style preset, a color palette, or style
- /// reference images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -989,29 +955,12 @@ request.Imagename is null } } /// - /// Remix an existing image with Ideogram 3.0, guided by a prompt
+ /// Remix with Ideogram 3.0
/// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Optional style controls work as on the Ideogram 3.0 generate
- /// endpoint: style codes, a style preset, a color palette, or style
- /// reference images.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1023,10 +972,10 @@ request.Imagename is null /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. @@ -1073,7 +1022,7 @@ request.Imagename is null /// A predefined style preset to apply to the remixed images. Cannot be combined with style codes or style references. /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_asset_identifiers` or `style_reference_images`. + /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_images`. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -1082,13 +1031,13 @@ request.Imagename is null /// Existing upload or generated image assets to use as style references, by reference. Cannot be combined with `style_reference_collection_id` or `style_reference_images`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `style_reference_collection_id` or `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3Character.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3Character.g.cs index 7644de26..5c5c3e53 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3Character.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3Character.g.cs @@ -44,38 +44,14 @@ partial void ProcessPostRemixImageV2IdeogramV3CharacterResponseContent( ref string content); /// - /// Remix an existing image with Ideogram 3.0, featuring a consistent character
- /// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt and featuring a consistent character. Supply the source either
- /// as an `image_asset_identifier` reference (an image already stored
- /// with Ideogram) or as raw `image` bytes (multipart requests only).
- /// Supplying both is rejected rather than one being ignored.
- /// `image_weight` controls how closely the result follows the source;
- /// when omitted the server picks a value from your prompt.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references, or as raw
- /// `character_reference_images` bytes (multipart requests only, with an
- /// optional `character_reference_mask` marking where the character is in
- /// the reference). If more than one form is supplied, the collection
- /// wins over the identifiers, and the identifiers win over the bytes.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Style references may be supplied as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix a consistent character with Ideogram 3.0
+ /// Transform an existing image with Ideogram 3.0 so it features a
+ /// consistent character, guided by a text prompt. Upload the source
+ /// `image` and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -102,38 +78,14 @@ partial void ProcessPostRemixImageV2IdeogramV3CharacterResponseContent( return __response.Body; } /// - /// Remix an existing image with Ideogram 3.0, featuring a consistent character
- /// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt and featuring a consistent character. Supply the source either
- /// as an `image_asset_identifier` reference (an image already stored
- /// with Ideogram) or as raw `image` bytes (multipart requests only).
- /// Supplying both is rejected rather than one being ignored.
- /// `image_weight` controls how closely the result follows the source;
- /// when omitted the server picks a value from your prompt.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references, or as raw
- /// `character_reference_images` bytes (multipart requests only, with an
- /// optional `character_reference_mask` marking where the character is in
- /// the reference). If more than one form is supplied, the collection
- /// wins over the identifiers, and the identifiers win over the bytes.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Style references may be supplied as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix a consistent character with Ideogram 3.0
+ /// Transform an existing image with Ideogram 3.0 so it features a
+ /// consistent character, guided by a text prompt. Upload the source
+ /// `image` and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1067,38 +1019,14 @@ request.CharacterReferenceMaskname is null } } /// - /// Remix an existing image with Ideogram 3.0, featuring a consistent character
- /// Transform an existing image with Ideogram 3.0, guided by a text
- /// prompt and featuring a consistent character. Supply the source either
- /// as an `image_asset_identifier` reference (an image already stored
- /// with Ideogram) or as raw `image` bytes (multipart requests only).
- /// Supplying both is rejected rather than one being ignored.
- /// `image_weight` controls how closely the result follows the source;
- /// when omitted the server picks a value from your prompt.
- /// Supply the character as a saved character
- /// (`character_reference_collection_id`), as
- /// `character_reference_asset_identifiers` references, or as raw
- /// `character_reference_images` bytes (multipart requests only, with an
- /// optional `character_reference_mask` marking where the character is in
- /// the reference). If more than one form is supplied, the collection
- /// wins over the identifiers, and the identifiers win over the bytes.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// Style references may be supplied as a saved style
- /// (`style_reference_collection_id`), as
- /// `style_reference_asset_identifiers` references, or as raw
- /// `style_reference_images` bytes, with the same precedence as the
- /// character forms.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix a consistent character with Ideogram 3.0
+ /// Transform an existing image with Ideogram 3.0 so it features a
+ /// consistent character, guided by a text prompt. Upload the source
+ /// `image` and a `character_reference_images` image (or use a saved
+ /// character) using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1110,10 +1038,10 @@ request.CharacterReferenceMaskname is null /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. @@ -1122,7 +1050,7 @@ request.CharacterReferenceMaskname is null /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. /// /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it. @@ -1131,7 +1059,7 @@ request.CharacterReferenceMaskname is null /// An existing upload or generated image asset to use as the character reference, by reference. Takes priority over `character_reference_images` if both are supplied. /// /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported. /// /// /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. @@ -1167,7 +1095,7 @@ request.CharacterReferenceMaskname is null /// Default Value: auto /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -1176,13 +1104,13 @@ request.CharacterReferenceMaskname is null /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3CustomModel.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3CustomModel.g.cs index f3268ae0..66b76132 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3CustomModel.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV3CustomModel.g.cs @@ -44,27 +44,13 @@ partial void ProcessPostRemixImageV2IdeogramV3CustomModelResponseContent( ref string content); /// - /// Remix an existing image with a custom Ideogram 3.0 model
- /// Transform an existing image with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with a custom Ideogram 3.0 model
+ /// Transform an existing image with a custom Ideogram 3.0 model that your
+ /// user or organization can access, guided by a text prompt. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -91,27 +77,13 @@ partial void ProcessPostRemixImageV2IdeogramV3CustomModelResponseContent( return __response.Body; } /// - /// Remix an existing image with a custom Ideogram 3.0 model
- /// Transform an existing image with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with a custom Ideogram 3.0 model
+ /// Transform an existing image with a custom Ideogram 3.0 model that your
+ /// user or organization can access, guided by a text prompt. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -997,27 +969,13 @@ request.Imagename is null } } /// - /// Remix an existing image with a custom Ideogram 3.0 model
- /// Transform an existing image with a custom Ideogram 3.0 model that the
- /// authenticated user or organization can access, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` and `aspect_ratio` to keep the source image's
- /// shape. If you request a different shape, the source is center-cropped
- /// to fit it first, and whatever falls outside the new shape is
- /// discarded.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Remix with a custom Ideogram 3.0 model
+ /// Transform an existing image with a custom Ideogram 3.0 model that your
+ /// user or organization can access, guided by a text prompt. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -1033,10 +991,10 @@ request.Imagename is null /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. @@ -1080,13 +1038,13 @@ request.Imagename is null /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `style_reference_asset_identifiers` is also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV4.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV4.g.cs index 68546150..a193f04b 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV4.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.PostRemixImageV2IdeogramV4.g.cs @@ -44,29 +44,12 @@ partial void ProcessPostRemixImageV2IdeogramV4ResponseContent( ref string content); /// - /// Remix an existing image with Ideogram 4.0, guided by a prompt
+ /// Remix with Ideogram 4.0
/// Transform an existing image with Ideogram 4.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` to keep the source image's shape. A `resolution`
- /// whose aspect ratio differs from the source's cannot be combined with
- /// `image_weight` — that request is rejected with a 400.
- /// The prompt is always interpreted by an instruction-editing model, so
- /// there is no `magic_prompt` option. Remixes are not reproducible, so
- /// no seed is accepted; the response reports the seed the request
- /// resolved to.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -93,29 +76,12 @@ partial void ProcessPostRemixImageV2IdeogramV4ResponseContent( return __response.Body; } /// - /// Remix an existing image with Ideogram 4.0, guided by a prompt
+ /// Remix with Ideogram 4.0
/// Transform an existing image with Ideogram 4.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` to keep the source image's shape. A `resolution`
- /// whose aspect ratio differs from the source's cannot be combined with
- /// `image_weight` — that request is rejected with a 400.
- /// The prompt is always interpreted by an instruction-editing model, so
- /// there is no `magic_prompt` option. Remixes are not reproducible, so
- /// no seed is accepted; the response reports the seed the request
- /// resolved to.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -883,47 +849,30 @@ request.Imagename is null } } /// - /// Remix an existing image with Ideogram 4.0, guided by a prompt
+ /// Remix with Ideogram 4.0
/// Transform an existing image with Ideogram 4.0, guided by a text
- /// prompt. Supply the source either as an `image_asset_identifier`
- /// reference (an image already stored with Ideogram) or as raw `image`
- /// bytes (multipart requests only). Supplying both is rejected rather
- /// than one being ignored. `image_weight` controls how closely the
- /// result follows the source; when omitted the server picks a value from
- /// your prompt.
- /// Omit `resolution` to keep the source image's shape. A `resolution`
- /// whose aspect ratio differs from the source's cannot be combined with
- /// `image_weight` — that request is rejected with a 400.
- /// The prompt is always interpreted by an instruction-editing model, so
- /// there is no `magic_prompt` option. Remixes are not reproducible, so
- /// no seed is accepted; the response reports the seed the request
- /// resolved to.
- /// By default the request blocks until the images are ready and returns
- /// them in `data`. Set `async` to true to return immediately after the
- /// request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// prompt. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// The prompt that guides the remix. + /// The prompt that guides the remix. It is always read as an editing instruction, so there is no `magic_prompt` option. /// /// /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` to keep its shape. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` to keep its shape. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` to keep its shape. /// /// - /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining image_weight with a resolution whose aspect ratio differs from the source's is rejected with a 400. + /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining `image_weight` with a `resolution` whose aspect ratio differs from the source's is rejected with a 400. /// /// /// The number of images to generate.
@@ -933,7 +882,7 @@ request.Imagename is null /// Optional. When supplied, the images are generated at this
/// resolution. When omitted, the source image's shape is kept. A
/// resolution whose aspect ratio differs from the source's cannot
- /// be combined with image_weight. + /// be combined with `image_weight`. /// /// /// The rendering speed to use.
@@ -943,7 +892,7 @@ request.Imagename is null /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.g.cs index eabe2f79..a475837f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesRemixClient.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Transform an existing image with a specific model contract, guided by
- /// a prompt. Requests supply the source by `AssetIdentifier` reference or
- /// as uploaded bytes, and return a generation id that can be polled via
- /// `GET /v1/generations/{generation_id}`.
+ /// Transform an image with a specific model, guided by a prompt.
/// If no httpClient is provided, a new one will be created.
/// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscale.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscale.JsonSerializerContext.g.cs index 5ea72113..e45a3f29 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscale.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscale.JsonSerializerContext.g.cs @@ -18,10 +18,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(bool))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(byte[]))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(float))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.UpscaleImageTopazTextRefineResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.UpscaleImageObject))] diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageNanoBananaPro.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageNanoBananaPro.g.cs index 7d1664a9..8d1b6f81 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageNanoBananaPro.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageNanoBananaPro.g.cs @@ -44,27 +44,13 @@ partial void ProcessPostUpscaleImageNanoBananaProResponseContent( ref string content); /// - /// Upscale an image with Nano Banana Pro, by asset id or by uploaded bytes
- /// Regenerate the source image at a higher resolution tier (1K, 2K, or
- /// 4K) while preserving its content, composition, and style. Supply the
- /// source either as an `image_asset_identifier` reference (an image
- /// already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only) — callers are never required to upload the asset
- /// first. If both are supplied, the reference wins and the bytes are
- /// ignored. Uploaded bytes are used for this request only and are not
- /// stored as an asset; upscales of a referenced asset keep a visible
- /// link to their source image.
- /// An optional `prompt` adds short guidance for the enhancement; the
- /// image is otherwise upscaled as-is. The source must be smaller than
- /// the requested `resolution_tier`.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Nano Banana Pro
+ /// Regenerate an image at a higher `resolution_tier` (1K, 2K, or 4K) while
+ /// preserving its content, composition, and style. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -91,27 +77,13 @@ partial void ProcessPostUpscaleImageNanoBananaProResponseContent( return __response.Body; } /// - /// Upscale an image with Nano Banana Pro, by asset id or by uploaded bytes
- /// Regenerate the source image at a higher resolution tier (1K, 2K, or
- /// 4K) while preserving its content, composition, and style. Supply the
- /// source either as an `image_asset_identifier` reference (an image
- /// already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only) — callers are never required to upload the asset
- /// first. If both are supplied, the reference wins and the bytes are
- /// ignored. Uploaded bytes are used for this request only and are not
- /// stored as an asset; upscales of a referenced asset keep a visible
- /// link to their source image.
- /// An optional `prompt` adds short guidance for the enhancement; the
- /// image is otherwise upscaled as-is. The source must be smaller than
- /// the requested `resolution_tier`.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Nano Banana Pro
+ /// Regenerate an image at a higher `resolution_tier` (1K, 2K, or 4K) while
+ /// preserving its content, composition, and style. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -859,27 +831,13 @@ request.Imagename is null } } /// - /// Upscale an image with Nano Banana Pro, by asset id or by uploaded bytes
- /// Regenerate the source image at a higher resolution tier (1K, 2K, or
- /// 4K) while preserving its content, composition, and style. Supply the
- /// source either as an `image_asset_identifier` reference (an image
- /// already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only) — callers are never required to upload the asset
- /// first. If both are supplied, the reference wins and the bytes are
- /// ignored. Uploaded bytes are used for this request only and are not
- /// stored as an asset; upscales of a referenced asset keep a visible
- /// link to their source image.
- /// An optional `prompt` adds short guidance for the enhancement; the
- /// image is otherwise upscaled as-is. The source must be smaller than
- /// the requested `resolution_tier`.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Nano Banana Pro
+ /// Regenerate an image at a higher `resolution_tier` (1K, 2K, or 4K) while
+ /// preserving its content, composition, and style. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -889,10 +847,10 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// Optional short guidance for the enhancement, appended to the model's upscaling instruction. When omitted, the image is upscaled as-is. @@ -906,7 +864,7 @@ request.Imagename is null /// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazBloom2.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazBloom2.g.cs index dcb7f7b0..6e02a35c 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazBloom2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazBloom2.g.cs @@ -44,26 +44,13 @@ partial void ProcessPostUpscaleImageTopazBloom2ResponseContent( ref string content); /// - /// Upscale an image with Topaz Bloom 2, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, and `creativity`
- /// controls how strongly the model reinterprets the source while
- /// enlarging it.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Bloom 2
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// optionally guided by a `prompt`. Upload the source `image` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -90,26 +77,13 @@ partial void ProcessPostUpscaleImageTopazBloom2ResponseContent( return __response.Body; } /// - /// Upscale an image with Topaz Bloom 2, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, and `creativity`
- /// controls how strongly the model reinterprets the source while
- /// enlarging it.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Bloom 2
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// optionally guided by a `prompt`. Upload the source `image` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -873,26 +847,13 @@ request.Imagename is null } } /// - /// Upscale an image with Topaz Bloom 2, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, and `creativity`
- /// controls how strongly the model reinterprets the source while
- /// enlarging it.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Bloom 2
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// optionally guided by a `prompt`. Upload the source `image` using
+ /// `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -902,10 +863,10 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -927,7 +888,7 @@ request.Imagename is null /// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazRedefine.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazRedefine.g.cs index 90461bed..b364b050 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazRedefine.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazRedefine.g.cs @@ -44,28 +44,13 @@ partial void ProcessPostUpscaleImageTopazRedefineResponseContent( ref string content); /// - /// Upscale an image with Topaz Redefine, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, or `autoprompt`
- /// lets the model describe the image itself. `creativity` controls how
- /// strongly the model reinterprets the source, `texture` how much fine
- /// texture it adds, and the precision knobs (sharpen, denoise, detail,
- /// face enhancement, subject detection) refine the result.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Redefine
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// guided by an optional `prompt` or `autoprompt`. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -92,28 +77,13 @@ partial void ProcessPostUpscaleImageTopazRedefineResponseContent( return __response.Body; } /// - /// Upscale an image with Topaz Redefine, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, or `autoprompt`
- /// lets the model describe the image itself. `creativity` controls how
- /// strongly the model reinterprets the source, `texture` how much fine
- /// texture it adds, and the precision knobs (sharpen, denoise, detail,
- /// face enhancement, subject detection) refine the result.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Redefine
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// guided by an optional `prompt` or `autoprompt`. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -949,28 +919,13 @@ request.Imagename is null } } /// - /// Upscale an image with Topaz Redefine, by asset id or by uploaded bytes
- /// Creatively upscale one image to 2x, 4x, or 8x its original resolution,
- /// up to a maximum output of 8192px per side. Supply the source either as
- /// an `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// An optional `prompt` guides the regenerated detail, or `autoprompt`
- /// lets the model describe the image itself. `creativity` controls how
- /// strongly the model reinterprets the source, `texture` how much fine
- /// texture it adds, and the precision knobs (sharpen, denoise, detail,
- /// face enhancement, subject detection) refine the result.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Redefine
+ /// Creatively upscale an image to 2x, 4x, or 8x its original resolution,
+ /// guided by an optional `prompt` or `autoprompt`. Upload the source
+ /// `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -980,10 +935,10 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -1012,10 +967,10 @@ request.Imagename is null /// Detail adjustment intensity, from 0 to 10. /// /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// /// /// Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required. @@ -1027,14 +982,14 @@ request.Imagename is null /// How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative). /// /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// /// /// Random seed. Set for reproducible generation.
/// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazStandardV2.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazStandardV2.g.cs index 68d672eb..d1a470f1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazStandardV2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazStandardV2.g.cs @@ -44,24 +44,12 @@ partial void ProcessPostUpscaleImageTopazStandardV2ResponseContent( ref string content); /// - /// Upscale an image with Topaz Standard V2, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Standard V2
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -88,24 +76,12 @@ partial void ProcessPostUpscaleImageTopazStandardV2ResponseContent( return __response.Body; } /// - /// Upscale an image with Topaz Standard V2, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Standard V2
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -869,24 +845,12 @@ request.Imagename is null } } /// - /// Upscale an image with Topaz Standard V2, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Standard V2
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -896,26 +860,26 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
/// Default Value: x2 /// /// - /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let Topaz choose per image. + /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let the model choose per image. /// /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// /// - /// Compression artifact removal, from 0 to 1. Omit to let Topaz choose per image. + /// Compression artifact removal, from 0 to 1. Omit to let the model choose per image. /// /// /// Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required. @@ -927,10 +891,10 @@ request.Imagename is null /// How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative). /// /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazTextRefine.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazTextRefine.g.cs index 26deb12c..0c90bcb3 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazTextRefine.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazTextRefine.g.cs @@ -44,24 +44,12 @@ partial void ProcessPostUpscaleImageTopazTextRefineResponseContent( ref string content); /// - /// Upscale an image with Topaz Text Refine, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Text Refine
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -88,24 +76,12 @@ partial void ProcessPostUpscaleImageTopazTextRefineResponseContent( return __response.Body; } /// - /// Upscale an image with Topaz Text Refine, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Text Refine
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -877,24 +853,12 @@ request.Imagename is null } } /// - /// Upscale an image with Topaz Text Refine, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Text Refine
+ /// Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -904,26 +868,26 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
/// Default Value: x2 /// /// - /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let Topaz choose per image. + /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let the model choose per image. /// /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// /// - /// Compression artifact removal, from 0 to 1. Omit to let Topaz choose per image. + /// Compression artifact removal, from 0 to 1. Omit to let the model choose per image. /// /// /// Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required. @@ -935,14 +899,14 @@ request.Imagename is null /// How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative). /// /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// /// /// Random seed. Set for reproducible generation.
/// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazWonder35.g.cs b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazWonder35.g.cs index 48c913b2..42abc596 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazWonder35.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ImagesUpscaleClient.PostUpscaleImageTopazWonder35.g.cs @@ -44,26 +44,13 @@ partial void ProcessPostUpscaleImageTopazWonder35ResponseContent( ref string content); /// - /// Upscale an image with Topaz Wonder 3.5, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// Use `enhancement_strength` to control how strongly the generative
- /// model reconstructs detail.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Wonder 3.5
+ /// Upscale an image to 2x, 4x, or 8x its original resolution, with
+ /// `enhancement_strength` controlling how strongly detail is reconstructed.
+ /// Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -90,26 +77,13 @@ partial void ProcessPostUpscaleImageTopazWonder35ResponseContent( return __response.Body; } /// - /// Upscale an image with Topaz Wonder 3.5, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// Use `enhancement_strength` to control how strongly the generative
- /// model reconstructs detail.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Wonder 3.5
+ /// Upscale an image to 2x, 4x, or 8x its original resolution, with
+ /// `enhancement_strength` controlling how strongly detail is reconstructed.
+ /// Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -825,26 +799,13 @@ request.Imagename is null } } /// - /// Upscale an image with Topaz Wonder 3.5, by asset id or by uploaded bytes
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Supply the source either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. If both are supplied,
- /// the reference wins and the bytes are ignored. Uploaded bytes are used
- /// for this request only and are not stored as an asset; upscales of a
- /// referenced asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the model enhances the source image as-is.
- /// Use `enhancement_strength` to control how strongly the generative
- /// model reconstructs detail.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with Topaz Wonder 3.5
+ /// Upscale an image to 2x, 4x, or 8x its original resolution, with
+ /// `enhancement_strength` controlling how strongly detail is reconstructed.
+ /// Upload the source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -854,10 +815,10 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -872,7 +833,7 @@ request.Imagename is null /// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.JsonConverters.LivingImageQuality.g.cs b/src/libs/Ideogram/Generated/Ideogram.JsonConverters.LivingImageQuality.g.cs new file mode 100644 index 00000000..7062499d --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.JsonConverters.LivingImageQuality.g.cs @@ -0,0 +1,53 @@ +#nullable enable + +namespace Ideogram.JsonConverters +{ + /// + public sealed class LivingImageQualityJsonConverter : global::System.Text.Json.Serialization.JsonConverter + { + /// + public override global::Ideogram.LivingImageQuality Read( + ref global::System.Text.Json.Utf8JsonReader reader, + global::System.Type typeToConvert, + global::System.Text.Json.JsonSerializerOptions options) + { + switch (reader.TokenType) + { + case global::System.Text.Json.JsonTokenType.String: + { + var stringValue = reader.GetString(); + if (stringValue != null) + { + return global::Ideogram.LivingImageQualityExtensions.ToEnum(stringValue) ?? default; + } + + break; + } + case global::System.Text.Json.JsonTokenType.Number: + { + var numValue = reader.GetInt32(); + return (global::Ideogram.LivingImageQuality)numValue; + } + case global::System.Text.Json.JsonTokenType.Null: + { + return default(global::Ideogram.LivingImageQuality); + } + default: + throw new global::System.ArgumentOutOfRangeException(nameof(reader)); + } + + return default; + } + + /// + public override void Write( + global::System.Text.Json.Utf8JsonWriter writer, + global::Ideogram.LivingImageQuality value, + global::System.Text.Json.JsonSerializerOptions options) + { + writer = writer ?? throw new global::System.ArgumentNullException(nameof(writer)); + + writer.WriteStringValue(global::Ideogram.LivingImageQualityExtensions.ToValueString(value)); + } + } +} diff --git a/src/libs/Ideogram/Generated/Ideogram.JsonConverters.LivingImageQualityNullable.g.cs b/src/libs/Ideogram/Generated/Ideogram.JsonConverters.LivingImageQualityNullable.g.cs new file mode 100644 index 00000000..ac04defd --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.JsonConverters.LivingImageQualityNullable.g.cs @@ -0,0 +1,60 @@ +#nullable enable + +namespace Ideogram.JsonConverters +{ + /// + public sealed class LivingImageQualityNullableJsonConverter : global::System.Text.Json.Serialization.JsonConverter + { + /// + public override global::Ideogram.LivingImageQuality? Read( + ref global::System.Text.Json.Utf8JsonReader reader, + global::System.Type typeToConvert, + global::System.Text.Json.JsonSerializerOptions options) + { + switch (reader.TokenType) + { + case global::System.Text.Json.JsonTokenType.String: + { + var stringValue = reader.GetString(); + if (stringValue != null) + { + return global::Ideogram.LivingImageQualityExtensions.ToEnum(stringValue); + } + + break; + } + case global::System.Text.Json.JsonTokenType.Number: + { + var numValue = reader.GetInt32(); + return (global::Ideogram.LivingImageQuality)numValue; + } + case global::System.Text.Json.JsonTokenType.Null: + { + return default(global::Ideogram.LivingImageQuality?); + } + default: + throw new global::System.ArgumentOutOfRangeException(nameof(reader)); + } + + return default; + } + + /// + public override void Write( + global::System.Text.Json.Utf8JsonWriter writer, + global::Ideogram.LivingImageQuality? value, + global::System.Text.Json.JsonSerializerOptions options) + { + writer = writer ?? throw new global::System.ArgumentNullException(nameof(writer)); + + if (value == null) + { + writer.WriteNullValue(); + } + else + { + writer.WriteStringValue(global::Ideogram.LivingImageQualityExtensions.ToValueString(value.Value)); + } + } + } +} diff --git a/src/libs/Ideogram/Generated/Ideogram.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.JsonSerializerContext.g.cs index df87fc3e..6d785c6d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.JsonSerializerContext.g.cs @@ -182,6 +182,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.InternalBatchResultsResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.InternalBatchResultsResponseResultsInner))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetReferenceUsageResponse))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetReferenceUsageItem))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance2Response))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance2TextToVideoRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.SeedDance2AspectRatio), TypeInfoPropertyName = "SeedDance2AspectRatio2")] @@ -190,7 +194,6 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance2ImageToVideoRequest))] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance25Response))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance25TextToVideoRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.SeedDance25Resolution), TypeInfoPropertyName = "SeedDance25Resolution2")] @@ -281,6 +284,9 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GhostMannequinQuality), TypeInfoPropertyName = "GhostMannequinQuality2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.Product360VideoRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.Product360VideoDirection), TypeInfoPropertyName = "Product360VideoDirection2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LivingImageResponse))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LivingImageRequest))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LivingImageQuality), TypeInfoPropertyName = "LivingImageQuality2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.PreciseMaskedEditResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.PreciseMaskedEditRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.PreciseMaskedEditModel), TypeInfoPropertyName = "PreciseMaskedEditModel2")] @@ -503,12 +509,6 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ToolUsage))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ToolType), TypeInfoPropertyName = "ToolType2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ModelVersion), TypeInfoPropertyName = "ModelVersion2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.SegmentBy), TypeInfoPropertyName = "SegmentBy2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.UsageSource), TypeInfoPropertyName = "UsageSource2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GetApiProfilesResponse))] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ApiProfile))] internal sealed partial class SourceGenerationContextChunk0 : global::System.Text.Json.Serialization.JsonSerializerContext { } @@ -519,6 +519,12 @@ internal sealed partial class SourceGenerationContextChunk0 : global::System.Tex [global::System.Text.Json.Serialization.JsonSourceGenerationOptions( DefaultIgnoreCondition = global::System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull )] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ModelVersion), TypeInfoPropertyName = "ModelVersion2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.SegmentBy), TypeInfoPropertyName = "SegmentBy2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.UsageSource), TypeInfoPropertyName = "UsageSource2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GetApiProfilesResponse))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ApiProfile))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ApiProfileType), TypeInfoPropertyName = "ApiProfileType2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ApiProfileRole), TypeInfoPropertyName = "ApiProfileRole2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] @@ -725,6 +731,7 @@ internal sealed partial class SourceGenerationContextChunk0 : global::System.Tex [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GhostMannequinRequestView?), TypeInfoPropertyName = "NullableGhostMannequinRequestView2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GhostMannequinQuality?), TypeInfoPropertyName = "NullableGhostMannequinQuality2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.Product360VideoDirection?), TypeInfoPropertyName = "NullableProduct360VideoDirection2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LivingImageQuality?), TypeInfoPropertyName = "NullableLivingImageQuality2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.PreciseMaskedEditModel?), TypeInfoPropertyName = "NullablePreciseMaskedEditModel2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.PreciseMaskedEditQuality?), TypeInfoPropertyName = "NullablePreciseMaskedEditQuality2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.ColorwaysQuality?), TypeInfoPropertyName = "NullableColorwaysQuality2")] @@ -856,6 +863,7 @@ internal sealed partial class SourceGenerationContextChunk0 : global::System.Tex [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] @@ -1178,6 +1186,10 @@ public override bool CanConvert(global::System.Type typeToConvert) || typeToConvert == typeof(global::Ideogram.Product360VideoDirection?) + || typeToConvert == typeof(global::Ideogram.LivingImageQuality) + + || typeToConvert == typeof(global::Ideogram.LivingImageQuality?) + || typeToConvert == typeof(global::Ideogram.PreciseMaskedEditModel) || typeToConvert == typeof(global::Ideogram.PreciseMaskedEditModel?) @@ -1594,6 +1606,10 @@ public override bool CanConvert(global::System.Type typeToConvert) || typeToConvert == typeof(global::Ideogram.DetectedTextBlockRole?) + || typeToConvert == typeof(global::Ideogram.AssetType) + + || typeToConvert == typeof(global::Ideogram.AssetType?) + || typeToConvert == typeof(global::Ideogram.SeedDance2AspectRatio) || typeToConvert == typeof(global::Ideogram.SeedDance2AspectRatio?) @@ -1602,10 +1618,6 @@ public override bool CanConvert(global::System.Type typeToConvert) || typeToConvert == typeof(global::Ideogram.SeedDance2Resolution?) - || typeToConvert == typeof(global::Ideogram.AssetType) - - || typeToConvert == typeof(global::Ideogram.AssetType?) - || typeToConvert == typeof(global::Ideogram.MinimaxH3AspectRatio) || typeToConvert == typeof(global::Ideogram.MinimaxH3AspectRatio?) @@ -2217,6 +2229,16 @@ public override bool CanConvert(global::System.Type typeToConvert) return new global::Ideogram.JsonConverters.Product360VideoDirectionNullableJsonConverter(); } + if (typeToConvert == typeof(global::Ideogram.LivingImageQuality)) + { + return new global::Ideogram.JsonConverters.LivingImageQualityJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.LivingImageQuality?)) + { + return new global::Ideogram.JsonConverters.LivingImageQualityNullableJsonConverter(); + } + if (typeToConvert == typeof(global::Ideogram.PreciseMaskedEditModel)) { return new global::Ideogram.JsonConverters.PreciseMaskedEditModelJsonConverter(); @@ -3257,6 +3279,16 @@ public override bool CanConvert(global::System.Type typeToConvert) return new global::Ideogram.JsonConverters.DetectedTextBlockRoleNullableJsonConverter(); } + if (typeToConvert == typeof(global::Ideogram.AssetType)) + { + return new global::Ideogram.JsonConverters.AssetTypeJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.AssetType?)) + { + return new global::Ideogram.JsonConverters.AssetTypeNullableJsonConverter(); + } + if (typeToConvert == typeof(global::Ideogram.SeedDance2AspectRatio)) { return new global::Ideogram.JsonConverters.SeedDance2AspectRatioJsonConverter(); @@ -3277,16 +3309,6 @@ public override bool CanConvert(global::System.Type typeToConvert) return new global::Ideogram.JsonConverters.SeedDance2ResolutionNullableJsonConverter(); } - if (typeToConvert == typeof(global::Ideogram.AssetType)) - { - return new global::Ideogram.JsonConverters.AssetTypeJsonConverter(); - } - - if (typeToConvert == typeof(global::Ideogram.AssetType?)) - { - return new global::Ideogram.JsonConverters.AssetTypeNullableJsonConverter(); - } - if (typeToConvert == typeof(global::Ideogram.MinimaxH3AspectRatio)) { return new global::Ideogram.JsonConverters.MinimaxH3AspectRatioJsonConverter(); diff --git a/src/libs/Ideogram/Generated/Ideogram.JsonSerializerContextTypes.g.cs b/src/libs/Ideogram/Generated/Ideogram.JsonSerializerContextTypes.g.cs index af6883b9..1eda56f1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.JsonSerializerContextTypes.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.JsonSerializerContextTypes.g.cs @@ -709,1803 +709,1827 @@ public sealed partial class JsonSerializerContextTypes /// /// /// - public global::Ideogram.GenerateVideoSeedDance2Response? Type169 { get; set; } + public global::Ideogram.AssetReferenceUsageResponse? Type169 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoSeedDance2TextToVideoRequest? Type170 { get; set; } + public global::System.Collections.Generic.IList? Type170 { get; set; } /// /// /// - public global::Ideogram.SeedDance2AspectRatio? Type171 { get; set; } + public global::Ideogram.AssetReferenceUsageItem? Type171 { get; set; } /// /// /// - public global::Ideogram.SeedDance2Resolution? Type172 { get; set; } + public global::Ideogram.AssetIdentifier? Type172 { get; set; } /// /// /// - public global::Ideogram.GenerationErrorResponse? Type173 { get; set; } + public global::Ideogram.GenerateVideoSeedDance2Response? Type173 { get; set; } /// /// /// - public global::Ideogram.GenerationRejectReason? Type174 { get; set; } + public global::Ideogram.GenerateVideoSeedDance2TextToVideoRequest? Type174 { get; set; } /// /// /// - public global::Ideogram.GenerationErrorResponseTaskCompletionSpeed? Type175 { get; set; } + public global::Ideogram.SeedDance2AspectRatio? Type175 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoSeedDance2ImageToVideoRequest? Type176 { get; set; } + public global::Ideogram.SeedDance2Resolution? Type176 { get; set; } /// /// /// - public global::Ideogram.AssetIdentifier? Type177 { get; set; } + public global::Ideogram.GenerationErrorResponse? Type177 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoSeedDance25Response? Type178 { get; set; } + public global::Ideogram.GenerationRejectReason? Type178 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoSeedDance25TextToVideoRequest? Type179 { get; set; } + public global::Ideogram.GenerationErrorResponseTaskCompletionSpeed? Type179 { get; set; } /// /// /// - public global::Ideogram.SeedDance25Resolution? Type180 { get; set; } + public global::Ideogram.GenerateVideoSeedDance2ImageToVideoRequest? Type180 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoSeedDance25ImageToVideoRequest? Type181 { get; set; } + public global::Ideogram.GenerateVideoSeedDance25Response? Type181 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoMinimaxH3TextToVideoRequest? Type182 { get; set; } + public global::Ideogram.GenerateVideoSeedDance25TextToVideoRequest? Type182 { get; set; } /// /// /// - public global::Ideogram.MinimaxH3AspectRatio? Type183 { get; set; } + public global::Ideogram.SeedDance25Resolution? Type183 { get; set; } /// /// /// - public global::Ideogram.MinimaxH3Resolution? Type184 { get; set; } + public global::Ideogram.GenerateVideoSeedDance25ImageToVideoRequest? Type184 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoMinimaxH3Response? Type185 { get; set; } + public global::Ideogram.GenerateVideoMinimaxH3TextToVideoRequest? Type185 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoMinimaxH3ImageToVideoRequest? Type186 { get; set; } + public global::Ideogram.MinimaxH3AspectRatio? Type186 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoKlingV3Response? Type187 { get; set; } + public global::Ideogram.MinimaxH3Resolution? Type187 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoKlingV3StandardTextToVideoRequest? Type188 { get; set; } + public global::Ideogram.GenerateVideoMinimaxH3Response? Type188 { get; set; } /// /// /// - public global::Ideogram.KlingV3AspectRatio? Type189 { get; set; } + public global::Ideogram.GenerateVideoMinimaxH3ImageToVideoRequest? Type189 { get; set; } /// /// /// - public global::Ideogram.KlingV3ShotType? Type190 { get; set; } + public global::Ideogram.GenerateVideoKlingV3Response? Type190 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoKlingV3StandardImageToVideoRequest? Type191 { get; set; } + public global::Ideogram.GenerateVideoKlingV3StandardTextToVideoRequest? Type191 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoSeedDance2ReferenceToVideoRequest? Type192 { get; set; } + public global::Ideogram.KlingV3AspectRatio? Type192 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type193 { get; set; } + public global::Ideogram.KlingV3ShotType? Type193 { get; set; } /// /// /// - public global::Ideogram.GenerateVideoSeedDance25ReferenceToVideoRequest? Type194 { get; set; } + public global::Ideogram.GenerateVideoKlingV3StandardImageToVideoRequest? Type194 { get; set; } /// /// /// - public global::Ideogram.EditVideoMinimaxH3ReferenceToVideoRequest? Type195 { get; set; } + public global::Ideogram.GenerateVideoSeedDance2ReferenceToVideoRequest? Type195 { get; set; } /// /// /// - public global::Ideogram.MinimaxH3PromptExpansionMode? Type196 { get; set; } + public global::System.Collections.Generic.IList? Type196 { get; set; } /// /// /// - public global::Ideogram.EditVideoSeedDance2Request? Type197 { get; set; } + public global::Ideogram.GenerateVideoSeedDance25ReferenceToVideoRequest? Type197 { get; set; } /// /// /// - public global::Ideogram.RemoveObjectFromV2AssetsResponse? Type198 { get; set; } + public global::Ideogram.EditVideoMinimaxH3ReferenceToVideoRequest? Type198 { get; set; } /// /// /// - public global::Ideogram.RemoveObjectFromV2AssetsRequest? Type199 { get; set; } + public global::Ideogram.MinimaxH3PromptExpansionMode? Type199 { get; set; } /// /// /// - public global::Ideogram.RemoveBackgroundV2Response? Type200 { get; set; } + public global::Ideogram.EditVideoSeedDance2Request? Type200 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type201 { get; set; } + public global::Ideogram.RemoveObjectFromV2AssetsResponse? Type201 { get; set; } /// /// /// - public global::Ideogram.BackgroundRemovedImageObject? Type202 { get; set; } + public global::Ideogram.RemoveObjectFromV2AssetsRequest? Type202 { get; set; } /// /// /// - public global::Ideogram.RemoveBackgroundV2Request? Type203 { get; set; } + public global::Ideogram.RemoveBackgroundV2Response? Type203 { get; set; } /// /// /// - public global::Ideogram.RemoveBackgroundV2AssetRequest? Type204 { get; set; } + public global::System.Collections.Generic.IList? Type204 { get; set; } /// /// /// - public global::Ideogram.ReplaceBackgroundResponse? Type205 { get; set; } + public global::Ideogram.BackgroundRemovedImageObject? Type205 { get; set; } /// /// /// - public global::Ideogram.ReplaceBackgroundRequest? Type206 { get; set; } + public global::Ideogram.RemoveBackgroundV2Request? Type206 { get; set; } /// /// /// - public global::Ideogram.ReplaceBackgroundQuality? Type207 { get; set; } + public global::Ideogram.RemoveBackgroundV2AssetRequest? Type207 { get; set; } /// /// /// - public global::Ideogram.ReplaceBackgroundIdeogramV3Request? Type208 { get; set; } + public global::Ideogram.ReplaceBackgroundResponse? Type208 { get; set; } /// /// /// - public global::Ideogram.ReplaceBackgroundIdeogramV3RequestRenderingSpeed? Type209 { get; set; } + public global::Ideogram.ReplaceBackgroundRequest? Type209 { get; set; } /// /// /// - public global::Ideogram.ListAccountApiKeysResponse? Type210 { get; set; } + public global::Ideogram.ReplaceBackgroundQuality? Type210 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type211 { get; set; } + public global::Ideogram.ReplaceBackgroundIdeogramV3Request? Type211 { get; set; } /// /// /// - public global::Ideogram.AccountApiKey? Type212 { get; set; } + public global::Ideogram.ReplaceBackgroundIdeogramV3RequestRenderingSpeed? Type212 { get; set; } /// /// /// - public global::Ideogram.AccountApiKeyStatus? Type213 { get; set; } + public global::Ideogram.ListAccountApiKeysResponse? Type213 { get; set; } /// /// /// - public global::Ideogram.GetAccountUsageResponse? Type214 { get; set; } + public global::System.Collections.Generic.IList? Type214 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type215 { get; set; } + public global::Ideogram.AccountApiKey? Type215 { get; set; } /// /// /// - public global::Ideogram.AccountUsageBucket? Type216 { get; set; } + public global::Ideogram.AccountApiKeyStatus? Type216 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type217 { get; set; } + public global::Ideogram.GetAccountUsageResponse? Type217 { get; set; } /// /// /// - public global::Ideogram.AccountUsageLineItem? Type218 { get; set; } + public global::System.Collections.Generic.IList? Type218 { get; set; } /// /// /// - public global::System.Collections.Generic.Dictionary? Type219 { get; set; } + public global::Ideogram.AccountUsageBucket? Type219 { get; set; } /// /// /// - public global::Ideogram.AccountUsageLineItemSource? Type220 { get; set; } + public global::System.Collections.Generic.IList? Type220 { get; set; } /// /// /// - public global::Ideogram.AccountUsageApiKey? Type221 { get; set; } + public global::Ideogram.AccountUsageLineItem? Type221 { get; set; } /// /// /// - public global::Ideogram.AccountUsageBilledUnits? Type222 { get; set; } + public global::System.Collections.Generic.Dictionary? Type222 { get; set; } /// /// /// - public global::Ideogram.ListAccountInvoicesResponse? Type223 { get; set; } + public global::Ideogram.AccountUsageLineItemSource? Type223 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type224 { get; set; } + public global::Ideogram.AccountUsageApiKey? Type224 { get; set; } /// /// /// - public global::Ideogram.AccountInvoice? Type225 { get; set; } + public global::Ideogram.AccountUsageBilledUnits? Type225 { get; set; } /// /// /// - public global::Ideogram.AccountInvoiceStatus? Type226 { get; set; } + public global::Ideogram.ListAccountInvoicesResponse? Type226 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type227 { get; set; } + public global::System.Collections.Generic.IList? Type227 { get; set; } /// /// /// - public global::Ideogram.AccountInvoiceLineItem? Type228 { get; set; } + public global::Ideogram.AccountInvoice? Type228 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazTextRefineResponse? Type229 { get; set; } + public global::Ideogram.AccountInvoiceStatus? Type229 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type230 { get; set; } + public global::System.Collections.Generic.IList? Type230 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageObject? Type231 { get; set; } + public global::Ideogram.AccountInvoiceLineItem? Type231 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazTextRefineRequest? Type232 { get; set; } + public global::Ideogram.UpscaleImageTopazTextRefineResponse? Type232 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazTextRefineRequestUpscaleFactor? Type233 { get; set; } + public global::System.Collections.Generic.IList? Type233 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazTextRefineRequestSubjectDetection? Type234 { get; set; } + public global::Ideogram.UpscaleImageObject? Type234 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazWonder35Response? Type235 { get; set; } + public global::Ideogram.UpscaleImageTopazTextRefineRequest? Type235 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazWonder35Request? Type236 { get; set; } + public global::Ideogram.UpscaleImageTopazTextRefineRequestUpscaleFactor? Type236 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazWonder35RequestUpscaleFactor? Type237 { get; set; } + public global::Ideogram.UpscaleImageTopazTextRefineRequestSubjectDetection? Type237 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazWonder35RequestEnhancementStrength? Type238 { get; set; } + public global::Ideogram.UpscaleImageTopazWonder35Response? Type238 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazStandardV2Response? Type239 { get; set; } + public global::Ideogram.UpscaleImageTopazWonder35Request? Type239 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazStandardV2Request? Type240 { get; set; } + public global::Ideogram.UpscaleImageTopazWonder35RequestUpscaleFactor? Type240 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazStandardV2RequestUpscaleFactor? Type241 { get; set; } + public global::Ideogram.UpscaleImageTopazWonder35RequestEnhancementStrength? Type241 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazStandardV2RequestSubjectDetection? Type242 { get; set; } + public global::Ideogram.UpscaleImageTopazStandardV2Response? Type242 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazBloom2Response? Type243 { get; set; } + public global::Ideogram.UpscaleImageTopazStandardV2Request? Type243 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazBloom2Request? Type244 { get; set; } + public global::Ideogram.UpscaleImageTopazStandardV2RequestUpscaleFactor? Type244 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazBloom2RequestUpscaleFactor? Type245 { get; set; } + public global::Ideogram.UpscaleImageTopazStandardV2RequestSubjectDetection? Type245 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazRedefineResponse? Type246 { get; set; } + public global::Ideogram.UpscaleImageTopazBloom2Response? Type246 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazRedefineRequest? Type247 { get; set; } + public global::Ideogram.UpscaleImageTopazBloom2Request? Type247 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazRedefineRequestUpscaleFactor? Type248 { get; set; } + public global::Ideogram.UpscaleImageTopazBloom2RequestUpscaleFactor? Type248 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageTopazRedefineRequestSubjectDetection? Type249 { get; set; } + public global::Ideogram.UpscaleImageTopazRedefineResponse? Type249 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageNanoBananaProResponse? Type250 { get; set; } + public global::Ideogram.UpscaleImageTopazRedefineRequest? Type250 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageNanoBananaProRequest? Type251 { get; set; } + public global::Ideogram.UpscaleImageTopazRedefineRequestUpscaleFactor? Type251 { get; set; } /// /// /// - public global::Ideogram.UpscaleImageNanoBananaProRequestResolutionTier? Type252 { get; set; } + public global::Ideogram.UpscaleImageTopazRedefineRequestSubjectDetection? Type252 { get; set; } /// /// /// - public global::Ideogram.LookbookResponse? Type253 { get; set; } + public global::Ideogram.UpscaleImageNanoBananaProResponse? Type253 { get; set; } /// /// /// - public global::Ideogram.LookbookRequest? Type254 { get; set; } + public global::Ideogram.UpscaleImageNanoBananaProRequest? Type254 { get; set; } /// /// /// - public global::Ideogram.LookbookRequestCategory? Type255 { get; set; } + public global::Ideogram.UpscaleImageNanoBananaProRequestResolutionTier? Type255 { get; set; } /// /// /// - public global::Ideogram.ModelPoseVariantsResponse? Type256 { get; set; } + public global::Ideogram.LookbookResponse? Type256 { get; set; } /// /// /// - public global::Ideogram.ModelPoseVariantsRequest? Type257 { get; set; } + public global::Ideogram.LookbookRequest? Type257 { get; set; } /// /// /// - public global::Ideogram.ModelPoseVariantsQuality? Type258 { get; set; } + public global::Ideogram.LookbookRequestCategory? Type258 { get; set; } /// /// /// - public global::Ideogram.PackshotsResponse? Type259 { get; set; } + public global::Ideogram.ModelPoseVariantsResponse? Type259 { get; set; } /// /// /// - public global::Ideogram.PackshotsRequest? Type260 { get; set; } + public global::Ideogram.ModelPoseVariantsRequest? Type260 { get; set; } /// /// /// - public global::Ideogram.PackshotView? Type261 { get; set; } + public global::Ideogram.ModelPoseVariantsQuality? Type261 { get; set; } /// /// /// - public global::Ideogram.PackshotsQuality? Type262 { get; set; } + public global::Ideogram.PackshotsResponse? Type262 { get; set; } /// /// /// - public global::Ideogram.GhostMannequinResponse? Type263 { get; set; } + public global::Ideogram.PackshotsRequest? Type263 { get; set; } /// /// /// - public global::Ideogram.GhostMannequinRequest? Type264 { get; set; } + public global::Ideogram.PackshotView? Type264 { get; set; } /// /// /// - public global::Ideogram.GhostMannequinRequestView? Type265 { get; set; } + public global::Ideogram.PackshotsQuality? Type265 { get; set; } /// /// /// - public global::Ideogram.GhostMannequinQuality? Type266 { get; set; } + public global::Ideogram.GhostMannequinResponse? Type266 { get; set; } /// /// /// - public global::Ideogram.Product360VideoRequest? Type267 { get; set; } + public global::Ideogram.GhostMannequinRequest? Type267 { get; set; } /// /// /// - public global::Ideogram.Product360VideoDirection? Type268 { get; set; } + public global::Ideogram.GhostMannequinRequestView? Type268 { get; set; } /// /// /// - public global::Ideogram.PreciseMaskedEditResponse? Type269 { get; set; } + public global::Ideogram.GhostMannequinQuality? Type269 { get; set; } /// /// /// - public global::Ideogram.PreciseMaskedEditRequest? Type270 { get; set; } + public global::Ideogram.Product360VideoRequest? Type270 { get; set; } /// /// /// - public global::Ideogram.PreciseMaskedEditModel? Type271 { get; set; } + public global::Ideogram.Product360VideoDirection? Type271 { get; set; } /// /// /// - public global::Ideogram.PreciseMaskedEditQuality? Type272 { get; set; } + public global::Ideogram.LivingImageResponse? Type272 { get; set; } /// /// /// - public global::Ideogram.VirtualTryOnResponse? Type273 { get; set; } + public global::Ideogram.LivingImageRequest? Type273 { get; set; } /// /// /// - public global::Ideogram.VirtualTryOnRequest? Type274 { get; set; } + public global::Ideogram.LivingImageQuality? Type274 { get; set; } /// /// /// - public global::Ideogram.ColorwaysResponse? Type275 { get; set; } + public global::Ideogram.PreciseMaskedEditResponse? Type275 { get; set; } /// /// /// - public global::Ideogram.ColorwaysRequest? Type276 { get; set; } + public global::Ideogram.PreciseMaskedEditRequest? Type276 { get; set; } /// /// /// - public global::Ideogram.ColorwaysQuality? Type277 { get; set; } + public global::Ideogram.PreciseMaskedEditModel? Type277 { get; set; } /// /// /// - public global::Ideogram.AdLocalizerResponse? Type278 { get; set; } + public global::Ideogram.PreciseMaskedEditQuality? Type278 { get; set; } /// /// /// - public global::Ideogram.AdLocalizerRequest? Type279 { get; set; } + public global::Ideogram.VirtualTryOnResponse? Type279 { get; set; } /// /// /// - public global::Ideogram.AdLocalizerRequestLanguage? Type280 { get; set; } + public global::Ideogram.VirtualTryOnRequest? Type280 { get; set; } /// /// /// - public global::Ideogram.AdLocalizerQuality? Type281 { get; set; } + public global::Ideogram.ColorwaysResponse? Type281 { get; set; } /// /// /// - public global::Ideogram.AdResizerResponse? Type282 { get; set; } + public global::Ideogram.ColorwaysRequest? Type282 { get; set; } /// /// /// - public global::Ideogram.AdResizerRequest? Type283 { get; set; } + public global::Ideogram.ColorwaysQuality? Type283 { get; set; } /// /// /// - public global::Ideogram.AdResizerRequestResolution? Type284 { get; set; } + public global::Ideogram.AdLocalizerResponse? Type284 { get; set; } /// /// /// - public global::Ideogram.AdResizerRequestPlatform? Type285 { get; set; } + public global::Ideogram.AdLocalizerRequest? Type285 { get; set; } /// /// /// - public global::Ideogram.AdResizerQuality? Type286 { get; set; } + public global::Ideogram.AdLocalizerRequestLanguage? Type286 { get; set; } /// /// /// - public global::Ideogram.AdVariationsResponse? Type287 { get; set; } + public global::Ideogram.AdLocalizerQuality? Type287 { get; set; } /// /// /// - public global::Ideogram.AdVariationsRequest? Type288 { get; set; } + public global::Ideogram.AdResizerResponse? Type288 { get; set; } /// /// /// - public global::Ideogram.AdVariationsRequestVariationType? Type289 { get; set; } + public global::Ideogram.AdResizerRequest? Type289 { get; set; } /// /// /// - public global::Ideogram.AdVariationsQuality? Type290 { get; set; } + public global::Ideogram.AdResizerRequestResolution? Type290 { get; set; } /// /// /// - public global::Ideogram.SketchToRenderResponse? Type291 { get; set; } + public global::Ideogram.AdResizerRequestPlatform? Type291 { get; set; } /// /// /// - public global::Ideogram.SketchToRenderRequest? Type292 { get; set; } + public global::Ideogram.AdResizerQuality? Type292 { get; set; } /// /// /// - public global::Ideogram.SketchToRenderQuality? Type293 { get; set; } + public global::Ideogram.AdVariationsResponse? Type293 { get; set; } /// /// /// - public global::Ideogram.SoleSwapResponse? Type294 { get; set; } + public global::Ideogram.AdVariationsRequest? Type294 { get; set; } /// /// /// - public global::Ideogram.SoleSwapRequest? Type295 { get; set; } + public global::Ideogram.AdVariationsRequestVariationType? Type295 { get; set; } /// /// /// - public global::Ideogram.SoleSwapRequestBaseGenerationSize? Type296 { get; set; } + public global::Ideogram.AdVariationsQuality? Type296 { get; set; } /// /// /// - public global::Ideogram.SoleSwapQuality? Type297 { get; set; } + public global::Ideogram.SketchToRenderResponse? Type297 { get; set; } /// /// /// - public global::Ideogram.SwapProductResponse? Type298 { get; set; } + public global::Ideogram.SketchToRenderRequest? Type298 { get; set; } /// /// /// - public global::Ideogram.SwapProductRequest? Type299 { get; set; } + public global::Ideogram.SketchToRenderQuality? Type299 { get; set; } /// /// /// - public global::Ideogram.SwapProductMode? Type300 { get; set; } + public global::Ideogram.SoleSwapResponse? Type300 { get; set; } /// /// /// - public global::Ideogram.SwapProductQuality? Type301 { get; set; } + public global::Ideogram.SoleSwapRequest? Type301 { get; set; } /// /// /// - public global::Ideogram.SkechersStyleEditResponse? Type302 { get; set; } + public global::Ideogram.SoleSwapRequestBaseGenerationSize? Type302 { get; set; } /// /// /// - public global::Ideogram.SkechersStyleEditRequest? Type303 { get; set; } + public global::Ideogram.SoleSwapQuality? Type303 { get; set; } /// /// /// - public global::Ideogram.SkechersStyleEditRequestAspectRatio? Type304 { get; set; } + public global::Ideogram.SwapProductResponse? Type304 { get; set; } /// /// /// - public global::Ideogram.SkechersStyleEditRequestBaseGenerationSize? Type305 { get; set; } + public global::Ideogram.SwapProductRequest? Type305 { get; set; } /// /// /// - public global::Ideogram.SkechersStyleEditQuality? Type306 { get; set; } + public global::Ideogram.SwapProductMode? Type306 { get; set; } /// /// /// - public global::Ideogram.SwanSLogoDesignResponse? Type307 { get; set; } + public global::Ideogram.SwapProductQuality? Type307 { get; set; } /// /// /// - public global::Ideogram.SwanSLogoDesignRequest? Type308 { get; set; } + public global::Ideogram.SkechersStyleEditResponse? Type308 { get; set; } /// /// /// - public global::Ideogram.SwanSLogoDesignRequestLogoStyle? Type309 { get; set; } + public global::Ideogram.SkechersStyleEditRequest? Type309 { get; set; } /// /// /// - public global::Ideogram.SwanSLogoDesignRequestSourceMode? Type310 { get; set; } + public global::Ideogram.SkechersStyleEditRequestAspectRatio? Type310 { get; set; } /// /// /// - public global::Ideogram.SwanSLogoDesignRequestDesignVariant? Type311 { get; set; } + public global::Ideogram.SkechersStyleEditRequestBaseGenerationSize? Type311 { get; set; } /// /// /// - public global::Ideogram.SwanSLogoQuality? Type312 { get; set; } + public global::Ideogram.SkechersStyleEditQuality? Type312 { get; set; } /// /// /// - public global::Ideogram.SwanSLogoInstallResponse? Type313 { get; set; } + public global::Ideogram.SwanSLogoDesignResponse? Type313 { get; set; } /// /// /// - public global::Ideogram.SwanSLogoInstallRequest? Type314 { get; set; } + public global::Ideogram.SwanSLogoDesignRequest? Type314 { get; set; } /// /// /// - public global::Ideogram.SwanSLogoInstallRequestLogoStyle? Type315 { get; set; } + public global::Ideogram.SwanSLogoDesignRequestLogoStyle? Type315 { get; set; } /// /// /// - public global::Ideogram.ModelSwapResponse? Type316 { get; set; } + public global::Ideogram.SwanSLogoDesignRequestSourceMode? Type316 { get; set; } /// /// /// - public global::Ideogram.ModelSwapRequest? Type317 { get; set; } + public global::Ideogram.SwanSLogoDesignRequestDesignVariant? Type317 { get; set; } /// /// /// - public global::Ideogram.ModelSwapQuality? Type318 { get; set; } + public global::Ideogram.SwanSLogoQuality? Type318 { get; set; } /// /// /// - public global::Ideogram.MaterialSwapResponse? Type319 { get; set; } + public global::Ideogram.SwanSLogoInstallResponse? Type319 { get; set; } /// /// /// - public global::Ideogram.MaterialSwapRequest? Type320 { get; set; } + public global::Ideogram.SwanSLogoInstallRequest? Type320 { get; set; } /// /// /// - public global::Ideogram.MaterialSwapQuality? Type321 { get; set; } + public global::Ideogram.SwanSLogoInstallRequestLogoStyle? Type321 { get; set; } /// /// /// - public global::Ideogram.UpscaleToolResponse? Type322 { get; set; } + public global::Ideogram.ModelSwapResponse? Type322 { get; set; } /// /// /// - public global::Ideogram.UpscaleToolRequest? Type323 { get; set; } + public global::Ideogram.ModelSwapRequest? Type323 { get; set; } /// /// /// - public global::Ideogram.UpscaleToolRequestUpscaleFactor? Type324 { get; set; } + public global::Ideogram.ModelSwapQuality? Type324 { get; set; } /// /// /// - public global::Ideogram.LayerizeDesignIdeogramV3Response? Type325 { get; set; } + public global::Ideogram.MaterialSwapResponse? Type325 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type326 { get; set; } + public global::Ideogram.MaterialSwapRequest? Type326 { get; set; } /// /// /// - public global::Ideogram.LayerizedImageObject? Type327 { get; set; } + public global::Ideogram.MaterialSwapQuality? Type327 { get; set; } /// /// /// - public global::Ideogram.LayerizedImageObjectObjectType? Type328 { get; set; } + public global::Ideogram.UpscaleToolResponse? Type328 { get; set; } /// /// /// - public global::Ideogram.LayerizeDesignIdeogramV3Request? Type329 { get; set; } + public global::Ideogram.UpscaleToolRequest? Type329 { get; set; } /// /// /// - public global::Ideogram.DescribeImageIdeogramV3Response? Type330 { get; set; } + public global::Ideogram.UpscaleToolRequestUpscaleFactor? Type330 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type331 { get; set; } + public global::Ideogram.LayerizeDesignIdeogramV3Response? Type331 { get; set; } /// /// /// - public global::Ideogram.GeneratedDescription? Type332 { get; set; } + public global::System.Collections.Generic.IList? Type332 { get; set; } /// /// /// - public global::Ideogram.DescribeImageIdeogramV3Request? Type333 { get; set; } + public global::Ideogram.LayerizedImageObject? Type333 { get; set; } /// /// /// - public global::Ideogram.ImageSafetyError? Type334 { get; set; } + public global::Ideogram.LayerizedImageObjectObjectType? Type334 { get; set; } /// /// /// - public global::Ideogram.DescribeImageIdeogramV4Response? Type335 { get; set; } + public global::Ideogram.LayerizeDesignIdeogramV3Request? Type335 { get; set; } /// /// /// - public global::Ideogram.DescribeImageIdeogramV4Request? Type336 { get; set; } + public global::Ideogram.DescribeImageIdeogramV3Response? Type336 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3Response? Type337 { get; set; } + public global::System.Collections.Generic.IList? Type337 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type338 { get; set; } + public global::Ideogram.GeneratedDescription? Type338 { get; set; } /// /// /// - public global::Ideogram.GeneratedImageObject? Type339 { get; set; } + public global::Ideogram.DescribeImageIdeogramV3Request? Type339 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3Request? Type340 { get; set; } + public global::Ideogram.ImageSafetyError? Type340 { get; set; } /// /// /// - public global::Ideogram.IdeogramV3AspectRatio? Type341 { get; set; } + public global::Ideogram.DescribeImageIdeogramV4Response? Type341 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3RequestRenderingSpeed? Type342 { get; set; } + public global::Ideogram.DescribeImageIdeogramV4Request? Type342 { get; set; } /// /// /// - public global::Ideogram.MagicPromptMode? Type343 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3Response? Type343 { get; set; } /// /// /// - public global::Ideogram.IdeogramColorPalette? Type344 { get; set; } + public global::System.Collections.Generic.IList? Type344 { get; set; } /// /// /// - public global::Ideogram.IdeogramV3StyleType? Type345 { get; set; } + public global::Ideogram.GeneratedImageObject? Type345 { get; set; } /// /// /// - public global::Ideogram.IdeogramV3StylePreset? Type346 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3Request? Type346 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3CustomModelResponse? Type347 { get; set; } + public global::Ideogram.IdeogramV3AspectRatio? Type347 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3CustomModelRequest? Type348 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3RequestRenderingSpeed? Type348 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3CustomModelRequestRenderingSpeed? Type349 { get; set; } + public global::Ideogram.MagicPromptMode? Type349 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV4Response? Type350 { get; set; } + public global::Ideogram.IdeogramColorPalette? Type350 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV4Request? Type351 { get; set; } + public global::Ideogram.IdeogramV3StyleType? Type351 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV4RequestRenderingSpeed? Type352 { get; set; } + public global::Ideogram.IdeogramV3StylePreset? Type352 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV4CustomModelResponse? Type353 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3CustomModelResponse? Type353 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV4CustomModelRequest? Type354 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3CustomModelRequest? Type354 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type355 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3CustomModelRequestRenderingSpeed? Type355 { get; set; } /// /// /// - public global::Ideogram.StackedCustomModel? Type356 { get; set; } + public global::Ideogram.GenerateImageIdeogramV4Response? Type356 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV4CustomModelRequestRenderingSpeed? Type357 { get; set; } + public global::Ideogram.GenerateImageIdeogramV4Request? Type357 { get; set; } /// /// /// - public double? Type358 { get; set; } + public global::Ideogram.GenerateImageIdeogramV4RequestRenderingSpeed? Type358 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV3Response? Type359 { get; set; } + public global::Ideogram.GenerateImageIdeogramV4CustomModelResponse? Type359 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type360 { get; set; } + public global::Ideogram.GenerateImageIdeogramV4CustomModelRequest? Type360 { get; set; } /// /// /// - public global::Ideogram.RemixedImageObject? Type361 { get; set; } + public global::System.Collections.Generic.IList? Type361 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV3Request? Type362 { get; set; } + public global::Ideogram.StackedCustomModel? Type362 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV3RequestRenderingSpeed? Type363 { get; set; } + public global::Ideogram.GenerateImageIdeogramV4CustomModelRequestRenderingSpeed? Type363 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV3CustomModelResponse? Type364 { get; set; } + public double? Type364 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV3CustomModelRequest? Type365 { get; set; } + public global::Ideogram.RemixImageIdeogramV3Response? Type365 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV3CustomModelRequestRenderingSpeed? Type366 { get; set; } + public global::System.Collections.Generic.IList? Type366 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV4Response? Type367 { get; set; } + public global::Ideogram.RemixedImageObject? Type367 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV4Request? Type368 { get; set; } + public global::Ideogram.RemixImageIdeogramV3Request? Type368 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV4RequestRenderingSpeed? Type369 { get; set; } + public global::Ideogram.RemixImageIdeogramV3RequestRenderingSpeed? Type369 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV3CharacterResponse? Type370 { get; set; } + public global::Ideogram.RemixImageIdeogramV3CustomModelResponse? Type370 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV3CharacterRequest? Type371 { get; set; } + public global::Ideogram.RemixImageIdeogramV3CustomModelRequest? Type371 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV3CharacterRequestRenderingSpeed? Type372 { get; set; } + public global::Ideogram.RemixImageIdeogramV3CustomModelRequestRenderingSpeed? Type372 { get; set; } /// /// /// - public global::Ideogram.RemixImageIdeogramV3CharacterRequestStyleType? Type373 { get; set; } + public global::Ideogram.RemixImageIdeogramV4Response? Type373 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3TransparentResponse? Type374 { get; set; } + public global::Ideogram.RemixImageIdeogramV4Request? Type374 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3TransparentRequest? Type375 { get; set; } + public global::Ideogram.RemixImageIdeogramV4RequestRenderingSpeed? Type375 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3TransparentRequestUpscaleFactor? Type376 { get; set; } + public global::Ideogram.RemixImageIdeogramV3CharacterResponse? Type376 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3TransparentRequestRenderingSpeed? Type377 { get; set; } + public global::Ideogram.RemixImageIdeogramV3CharacterRequest? Type377 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV4TransparentResponse? Type378 { get; set; } + public global::Ideogram.RemixImageIdeogramV3CharacterRequestRenderingSpeed? Type378 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV4TransparentRequest? Type379 { get; set; } + public global::Ideogram.RemixImageIdeogramV3CharacterRequestStyleType? Type379 { get; set; } /// /// /// - public global::Ideogram.IdeogramV4AspectRatio? Type380 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3TransparentResponse? Type380 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV4TransparentRequestOutputResolution? Type381 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3TransparentRequest? Type381 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV4TransparentRequestRenderingSpeed? Type382 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3TransparentRequestUpscaleFactor? Type382 { get; set; } /// /// /// - public global::Ideogram.GenerateImagePImageIdeogramResponse? Type383 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3TransparentRequestRenderingSpeed? Type383 { get; set; } /// /// /// - public global::Ideogram.GenerateImagePImageIdeogramRequest? Type384 { get; set; } + public global::Ideogram.GenerateImageIdeogramV4TransparentResponse? Type384 { get; set; } /// /// /// - public global::Ideogram.GenerationQuality? Type385 { get; set; } + public global::Ideogram.GenerateImageIdeogramV4TransparentRequest? Type385 { get; set; } /// /// /// - public global::Ideogram.GenerateImagePImageIdeogramRequestResolution? Type386 { get; set; } + public global::Ideogram.IdeogramV4AspectRatio? Type386 { get; set; } /// /// /// - public global::Ideogram.GenerateImageZImageResponse? Type387 { get; set; } + public global::Ideogram.GenerateImageIdeogramV4TransparentRequestOutputResolution? Type387 { get; set; } /// /// /// - public global::Ideogram.GenerateImageZImageRequest? Type388 { get; set; } + public global::Ideogram.GenerateImageIdeogramV4TransparentRequestRenderingSpeed? Type388 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogram45Response? Type389 { get; set; } + public global::Ideogram.GenerateImagePImageIdeogramResponse? Type389 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogram45Request? Type390 { get; set; } + public global::Ideogram.GenerateImagePImageIdeogramRequest? Type390 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogram45RequestQuality? Type391 { get; set; } + public global::Ideogram.GenerationQuality? Type391 { get; set; } /// /// /// - public global::Ideogram.PreciseEditImageIdeogram45Response? Type392 { get; set; } + public global::Ideogram.GenerateImagePImageIdeogramRequestResolution? Type392 { get; set; } /// /// /// - public global::Ideogram.PreciseEditImageIdeogram45Request? Type393 { get; set; } + public global::Ideogram.GenerateImageZImageResponse? Type393 { get; set; } /// /// /// - public global::Ideogram.PreciseEditImageIdeogram45RequestQuality? Type394 { get; set; } + public global::Ideogram.GenerateImageZImageRequest? Type394 { get; set; } /// /// /// - public global::Ideogram.GenerateImageNanoBanana2Response? Type395 { get; set; } + public global::Ideogram.GenerateImageIdeogram45Response? Type395 { get; set; } /// /// /// - public global::Ideogram.GenerateImageNanoBanana2Request? Type396 { get; set; } + public global::Ideogram.GenerateImageIdeogram45Request? Type396 { get; set; } /// /// /// - public global::Ideogram.GenerateImageNanoBanana2RequestResolutionTier? Type397 { get; set; } + public global::Ideogram.GenerateImageIdeogram45RequestQuality? Type397 { get; set; } /// /// /// - public global::Ideogram.GenerateImageNanoBananaProResponse? Type398 { get; set; } + public global::Ideogram.PreciseEditImageIdeogram45Response? Type398 { get; set; } /// /// /// - public global::Ideogram.GenerateImageNanoBananaProRequest? Type399 { get; set; } + public global::Ideogram.PreciseEditImageIdeogram45Request? Type399 { get; set; } /// /// /// - public global::Ideogram.GenerateImageNanoBananaProRequestResolutionTier? Type400 { get; set; } + public global::Ideogram.PreciseEditImageIdeogram45RequestQuality? Type400 { get; set; } /// /// /// - public global::Ideogram.GenerateImageGptImage2Response? Type401 { get; set; } + public global::Ideogram.GenerateImageNanoBanana2Response? Type401 { get; set; } /// /// /// - public global::Ideogram.GenerateImageGptImage2Request? Type402 { get; set; } + public global::Ideogram.GenerateImageNanoBanana2Request? Type402 { get; set; } /// /// /// - public global::Ideogram.GenerateImageGptImage25FlareResponse? Type403 { get; set; } + public global::Ideogram.GenerateImageNanoBanana2RequestResolutionTier? Type403 { get; set; } /// /// /// - public global::Ideogram.GenerateImageGptImage25FlareRequest? Type404 { get; set; } + public global::Ideogram.GenerateImageNanoBananaProResponse? Type404 { get; set; } /// /// /// - public global::Ideogram.GenerateImageGptImage25FlareRequestBackground? Type405 { get; set; } + public global::Ideogram.GenerateImageNanoBananaProRequest? Type405 { get; set; } /// /// /// - public global::Ideogram.GenerateImageGptImage25FlareRequestQuality? Type406 { get; set; } + public global::Ideogram.GenerateImageNanoBananaProRequestResolutionTier? Type406 { get; set; } /// /// /// - public global::Ideogram.GenerateImageGptImage25SunburstResponse? Type407 { get; set; } + public global::Ideogram.GenerateImageGptImage2Response? Type407 { get; set; } /// /// /// - public global::Ideogram.GenerateImageGptImage25SunburstRequest? Type408 { get; set; } + public global::Ideogram.GenerateImageGptImage2Request? Type408 { get; set; } /// /// /// - public global::Ideogram.GenerateImageGptImage25SunburstRequestBackground? Type409 { get; set; } + public global::Ideogram.GenerateImageGptImage25FlareResponse? Type409 { get; set; } /// /// /// - public global::Ideogram.GenerateImageGptImage25SunburstRequestQuality? Type410 { get; set; } + public global::Ideogram.GenerateImageGptImage25FlareRequest? Type410 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV2Response? Type411 { get; set; } + public global::Ideogram.GenerateImageGptImage25FlareRequestBackground? Type411 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV2Request? Type412 { get; set; } + public global::Ideogram.GenerateImageGptImage25FlareRequestQuality? Type412 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV2RequestRenderingSpeed? Type413 { get; set; } + public global::Ideogram.GenerateImageGptImage25SunburstResponse? Type413 { get; set; } /// /// /// - public global::Ideogram.IdeogramV2StyleType? Type414 { get; set; } + public global::Ideogram.GenerateImageGptImage25SunburstRequest? Type414 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV2AResponse? Type415 { get; set; } + public global::Ideogram.GenerateImageGptImage25SunburstRequestBackground? Type415 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV2ARequest? Type416 { get; set; } + public global::Ideogram.GenerateImageGptImage25SunburstRequestQuality? Type416 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV2ARequestRenderingSpeed? Type417 { get; set; } + public global::Ideogram.GenerateImageIdeogramV2Response? Type417 { get; set; } /// /// /// - public global::Ideogram.InpaintImageIdeogramV3Response? Type418 { get; set; } + public global::Ideogram.GenerateImageIdeogramV2Request? Type418 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type419 { get; set; } + public global::Ideogram.GenerateImageIdeogramV2RequestRenderingSpeed? Type419 { get; set; } /// /// /// - public global::Ideogram.InpaintedImageObject? Type420 { get; set; } + public global::Ideogram.IdeogramV2StyleType? Type420 { get; set; } /// /// /// - public global::Ideogram.InpaintImageIdeogramV3Request? Type421 { get; set; } + public global::Ideogram.GenerateImageIdeogramV2AResponse? Type421 { get; set; } /// /// /// - public global::Ideogram.InpaintImageIdeogramV3RequestRenderingSpeed? Type422 { get; set; } + public global::Ideogram.GenerateImageIdeogramV2ARequest? Type422 { get; set; } /// /// /// - public global::Ideogram.InpaintImageIdeogramV3CustomModelResponse? Type423 { get; set; } + public global::Ideogram.GenerateImageIdeogramV2ARequestRenderingSpeed? Type423 { get; set; } /// /// /// - public global::Ideogram.InpaintImageIdeogramV3CustomModelRequest? Type424 { get; set; } + public global::Ideogram.InpaintImageIdeogramV3Response? Type424 { get; set; } /// /// /// - public global::Ideogram.InpaintImageIdeogramV3CustomModelRequestRenderingSpeed? Type425 { get; set; } + public global::System.Collections.Generic.IList? Type425 { get; set; } /// /// /// - public global::Ideogram.ReframeImageIdeogramV3Response? Type426 { get; set; } + public global::Ideogram.InpaintedImageObject? Type426 { get; set; } /// /// /// - public global::Ideogram.ReframeImageIdeogramV3Request? Type427 { get; set; } + public global::Ideogram.InpaintImageIdeogramV3Request? Type427 { get; set; } /// /// /// - public global::Ideogram.ReframeImageIdeogramV3RequestRenderingSpeed? Type428 { get; set; } + public global::Ideogram.InpaintImageIdeogramV3RequestRenderingSpeed? Type428 { get; set; } /// /// /// - public global::Ideogram.ReframeImageNanoBanana2Response? Type429 { get; set; } + public global::Ideogram.InpaintImageIdeogramV3CustomModelResponse? Type429 { get; set; } /// /// /// - public global::Ideogram.ReframeImageNanoBanana2Request? Type430 { get; set; } + public global::Ideogram.InpaintImageIdeogramV3CustomModelRequest? Type430 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3CharacterResponse? Type431 { get; set; } + public global::Ideogram.InpaintImageIdeogramV3CustomModelRequestRenderingSpeed? Type431 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3CharacterRequest? Type432 { get; set; } + public global::Ideogram.ReframeImageIdeogramV3Response? Type432 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3CharacterRequestRenderingSpeed? Type433 { get; set; } + public global::Ideogram.ReframeImageIdeogramV3Request? Type433 { get; set; } /// /// /// - public global::Ideogram.GenerateImageIdeogramV3CharacterRequestStyleType? Type434 { get; set; } + public global::Ideogram.ReframeImageIdeogramV3RequestRenderingSpeed? Type434 { get; set; } /// /// /// - public global::Ideogram.InpaintImageIdeogramV3CharacterResponse? Type435 { get; set; } + public global::Ideogram.ReframeImageNanoBanana2Response? Type435 { get; set; } /// /// /// - public global::Ideogram.InpaintImageIdeogramV3CharacterRequest? Type436 { get; set; } + public global::Ideogram.ReframeImageNanoBanana2Request? Type436 { get; set; } /// /// /// - public global::Ideogram.InpaintImageIdeogramV3CharacterRequestRenderingSpeed? Type437 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3CharacterResponse? Type437 { get; set; } /// /// /// - public global::Ideogram.InpaintImageIdeogramV3CharacterRequestStyleType? Type438 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3CharacterRequest? Type438 { get; set; } /// /// /// - public global::Ideogram.GenerateImageV2AutoResponse? Type439 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3CharacterRequestRenderingSpeed? Type439 { get; set; } /// /// /// - public global::Ideogram.GenerateImageV2AutoRequest? Type440 { get; set; } + public global::Ideogram.GenerateImageIdeogramV3CharacterRequestStyleType? Type440 { get; set; } /// /// /// - public global::Ideogram.GenerateImageV2AutoRequestResolutionTier? Type441 { get; set; } + public global::Ideogram.InpaintImageIdeogramV3CharacterResponse? Type441 { get; set; } /// /// /// - public global::Ideogram.ToolRemixResponse? Type442 { get; set; } + public global::Ideogram.InpaintImageIdeogramV3CharacterRequest? Type442 { get; set; } /// /// /// - public global::Ideogram.ToolRemixRequest? Type443 { get; set; } + public global::Ideogram.InpaintImageIdeogramV3CharacterRequestRenderingSpeed? Type443 { get; set; } /// /// /// - public global::Ideogram.ToolRemixRequestResolutionTier? Type444 { get; set; } + public global::Ideogram.InpaintImageIdeogramV3CharacterRequestStyleType? Type444 { get; set; } /// /// /// - public global::Ideogram.ResizeAdImageRequest? Type445 { get; set; } + public global::Ideogram.GenerateImageV2AutoResponse? Type445 { get; set; } /// /// /// - public global::Ideogram.ResizeAdImageRequestResolution? Type446 { get; set; } + public global::Ideogram.GenerateImageV2AutoRequest? Type446 { get; set; } /// /// /// - public global::Ideogram.ResizeAdImageQuality? Type447 { get; set; } + public global::Ideogram.GenerateImageV2AutoRequestResolutionTier? Type447 { get; set; } /// /// /// - public global::Ideogram.WebhookSigningJwks? Type448 { get; set; } + public global::Ideogram.ToolRemixResponse? Type448 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type449 { get; set; } + public global::Ideogram.ToolRemixRequest? Type449 { get; set; } /// /// /// - public global::Ideogram.WebhookSigningJwk? Type450 { get; set; } + public global::Ideogram.ToolRemixRequestResolutionTier? Type450 { get; set; } /// /// /// - public global::Ideogram.ProvenanceVerifyResponse? Type451 { get; set; } + public global::Ideogram.ResizeAdImageRequest? Type451 { get; set; } /// /// /// - public global::Ideogram.ProvenanceVerifyResponseValidationState? Type452 { get; set; } + public global::Ideogram.ResizeAdImageRequestResolution? Type452 { get; set; } /// /// /// - public global::Ideogram.ProvenanceVerifyRequest? Type453 { get; set; } + public global::Ideogram.ResizeAdImageQuality? Type453 { get; set; } /// /// /// - public global::Ideogram.ManageApiSubscriptionResponse? Type454 { get; set; } + public global::Ideogram.WebhookSigningJwks? Type454 { get; set; } /// /// /// - public global::Ideogram.MetronomeLinks? Type455 { get; set; } + public global::System.Collections.Generic.IList? Type455 { get; set; } /// /// /// - public global::Ideogram.RechargeSettingsResponse? Type456 { get; set; } + public global::Ideogram.WebhookSigningJwk? Type456 { get; set; } /// /// /// - public global::Ideogram.Price? Type457 { get; set; } + public global::Ideogram.ProvenanceVerifyResponse? Type457 { get; set; } /// /// /// - public global::Ideogram.RechargeSettings? Type458 { get; set; } + public global::Ideogram.ProvenanceVerifyResponseValidationState? Type458 { get; set; } /// /// /// - public global::Ideogram.PostApiSubscriptionResponse? Type459 { get; set; } + public global::Ideogram.ProvenanceVerifyRequest? Type459 { get; set; } /// /// /// - public global::Ideogram.PostApiSubscriptionError? Type460 { get; set; } + public global::Ideogram.ManageApiSubscriptionResponse? Type460 { get; set; } /// /// /// - public global::Ideogram.PostApiSubscriptionRequest? Type461 { get; set; } + public global::Ideogram.MetronomeLinks? Type461 { get; set; } /// /// /// - public global::Ideogram.ManageApiCreditSummaryResponse? Type462 { get; set; } + public global::Ideogram.RechargeSettingsResponse? Type462 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type463 { get; set; } + public global::Ideogram.Price? Type463 { get; set; } /// /// /// - public global::Ideogram.CreditGrant? Type464 { get; set; } + public global::Ideogram.RechargeSettings? Type464 { get; set; } /// /// /// - public global::Ideogram.GetApiKeysResponse? Type465 { get; set; } + public global::Ideogram.PostApiSubscriptionResponse? Type465 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type466 { get; set; } + public global::Ideogram.PostApiSubscriptionError? Type466 { get; set; } /// /// /// - public global::Ideogram.RedactedApiKey? Type467 { get; set; } + public global::Ideogram.PostApiSubscriptionRequest? Type467 { get; set; } /// /// /// - public global::Ideogram.PostApiKeyResponse? Type468 { get; set; } + public global::Ideogram.ManageApiCreditSummaryResponse? Type468 { get; set; } /// /// /// - public global::Ideogram.CreateApiKeyRequest? Type469 { get; set; } + public global::System.Collections.Generic.IList? Type469 { get; set; } /// /// /// - public global::Ideogram.ApiProfileApiKey? Type470 { get; set; } + public global::Ideogram.CreditGrant? Type470 { get; set; } /// /// /// - public global::Ideogram.ApiKeyStatus? Type471 { get; set; } + public global::Ideogram.GetApiKeysResponse? Type471 { get; set; } /// /// /// - public global::Ideogram.PatchApiKeyRequest? Type472 { get; set; } + public global::System.Collections.Generic.IList? Type472 { get; set; } /// /// /// - public global::Ideogram.ManageApiStripeSubscriptionResponse? Type473 { get; set; } + public global::Ideogram.RedactedApiKey? Type473 { get; set; } /// /// /// - public global::Ideogram.ManageApiPaymentResponse? Type474 { get; set; } + public global::Ideogram.PostApiKeyResponse? Type474 { get; set; } /// /// /// - public global::Ideogram.GetApiTermsResponse? Type475 { get; set; } + public global::Ideogram.CreateApiKeyRequest? Type475 { get; set; } /// /// /// - public global::Ideogram.ApiTerms? Type476 { get; set; } + public global::Ideogram.ApiProfileApiKey? Type476 { get; set; } /// /// /// - public global::Ideogram.PostApiTermsRequest? Type477 { get; set; } + public global::Ideogram.ApiKeyStatus? Type477 { get; set; } /// /// /// - public global::Ideogram.PostAddCreditsResponse? Type478 { get; set; } + public global::Ideogram.PatchApiKeyRequest? Type478 { get; set; } /// /// /// - public global::Ideogram.PostAddCreditsError? Type479 { get; set; } + public global::Ideogram.ManageApiStripeSubscriptionResponse? Type479 { get; set; } /// /// /// - public global::Ideogram.PostAddCreditsRequest? Type480 { get; set; } + public global::Ideogram.ManageApiPaymentResponse? Type480 { get; set; } /// /// /// - public global::Ideogram.GetUserCreditsResponse? Type481 { get; set; } + public global::Ideogram.GetApiTermsResponse? Type481 { get; set; } /// /// /// - public global::Ideogram.SpendCommitInfoResponse? Type482 { get; set; } + public global::Ideogram.ApiTerms? Type482 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type483 { get; set; } + public global::Ideogram.PostApiTermsRequest? Type483 { get; set; } /// /// /// - public global::Ideogram.SpendCommitInfo? Type484 { get; set; } + public global::Ideogram.PostAddCreditsResponse? Type484 { get; set; } /// /// /// - public global::Ideogram.GetUsageInfoResponse? Type485 { get; set; } + public global::Ideogram.PostAddCreditsError? Type485 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type486 { get; set; } + public global::Ideogram.PostAddCreditsRequest? Type486 { get; set; } /// /// /// - public global::Ideogram.UsageSegment? Type487 { get; set; } + public global::Ideogram.GetUserCreditsResponse? Type487 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type488 { get; set; } + public global::Ideogram.SpendCommitInfoResponse? Type488 { get; set; } /// /// /// - public global::Ideogram.ToolUsage? Type489 { get; set; } + public global::System.Collections.Generic.IList? Type489 { get; set; } /// /// /// - public global::Ideogram.ToolType? Type490 { get; set; } + public global::Ideogram.SpendCommitInfo? Type490 { get; set; } /// /// /// - public global::Ideogram.ModelVersion? Type491 { get; set; } + public global::Ideogram.GetUsageInfoResponse? Type491 { get; set; } /// /// /// - public global::Ideogram.SegmentBy? Type492 { get; set; } + public global::System.Collections.Generic.IList? Type492 { get; set; } /// /// /// - public global::Ideogram.UsageSource? Type493 { get; set; } + public global::Ideogram.UsageSegment? Type493 { get; set; } /// /// /// - public global::Ideogram.GetApiProfilesResponse? Type494 { get; set; } + public global::System.Collections.Generic.IList? Type494 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type495 { get; set; } + public global::Ideogram.ToolUsage? Type495 { get; set; } /// /// /// - public global::Ideogram.ApiProfile? Type496 { get; set; } + public global::Ideogram.ToolType? Type496 { get; set; } /// /// /// - public global::Ideogram.ApiProfileType? Type497 { get; set; } + public global::Ideogram.ModelVersion? Type497 { get; set; } /// /// /// - public global::Ideogram.ApiProfileRole? Type498 { get; set; } + public global::Ideogram.SegmentBy? Type498 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type499 { get; set; } + public global::Ideogram.UsageSource? Type499 { get; set; } /// /// /// - public global::Ideogram.UpdateOrganizationApiPropertiesResponse? Type500 { get; set; } + public global::Ideogram.GetApiProfilesResponse? Type500 { get; set; } /// /// /// - public global::Ideogram.UpdateOrganizationApiPropertiesRequest? Type501 { get; set; } + public global::System.Collections.Generic.IList? Type501 { get; set; } /// /// /// - public global::Ideogram.GetApiOrganizationUserSuggestionsResponse? Type502 { get; set; } + public global::Ideogram.ApiProfile? Type502 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type503 { get; set; } + public global::Ideogram.ApiProfileType? Type503 { get; set; } /// /// /// - public global::Ideogram.ApiOrganizationUserSuggestion? Type504 { get; set; } + public global::Ideogram.ApiProfileRole? Type504 { get; set; } /// /// /// - public global::Ideogram.GetOrganizationMembersResponse? Type505 { get; set; } + public global::System.Collections.Generic.IList? Type505 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type506 { get; set; } + public global::Ideogram.UpdateOrganizationApiPropertiesResponse? Type506 { get; set; } /// /// /// - public global::Ideogram.OrganizationMember? Type507 { get; set; } + public global::Ideogram.UpdateOrganizationApiPropertiesRequest? Type507 { get; set; } /// /// /// - public global::Ideogram.CreateApiKeyResponse? Type508 { get; set; } + public global::Ideogram.GetApiOrganizationUserSuggestionsResponse? Type508 { get; set; } /// /// /// - public global::Ideogram.GetApiKeysV2Response? Type509 { get; set; } + public global::System.Collections.Generic.IList? Type509 { get; set; } /// /// /// - public global::Ideogram.OrganizationMemberOperationResponse? Type510 { get; set; } + public global::Ideogram.ApiOrganizationUserSuggestion? Type510 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type511 { get; set; } + public global::Ideogram.GetOrganizationMembersResponse? Type511 { get; set; } /// /// /// - public global::Ideogram.OrganizationMemberOperationResult? Type512 { get; set; } + public global::System.Collections.Generic.IList? Type512 { get; set; } /// /// /// - public global::Ideogram.AddOrganizationMembersRequest? Type513 { get; set; } + public global::Ideogram.OrganizationMember? Type513 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type514 { get; set; } + public global::Ideogram.CreateApiKeyResponse? Type514 { get; set; } /// /// /// - public global::Ideogram.LiteOrganizationMember? Type515 { get; set; } + public global::Ideogram.GetApiKeysV2Response? Type515 { get; set; } /// /// /// - public global::Ideogram.RemoveOrganizationMembersRequest? Type516 { get; set; } + public global::Ideogram.OrganizationMemberOperationResponse? Type516 { get; set; } /// /// /// - public global::Ideogram.PromoteOrganizationAdminsRequest? Type517 { get; set; } + public global::System.Collections.Generic.IList? Type517 { get; set; } /// /// /// - public global::Ideogram.DemoteOrganizationAdminsRequest? Type518 { get; set; } + public global::Ideogram.OrganizationMemberOperationResult? Type518 { get; set; } /// /// /// - public global::Ideogram.CancelOrganizationInviteRequest? Type519 { get; set; } + public global::Ideogram.AddOrganizationMembersRequest? Type519 { get; set; } /// /// /// - public global::Ideogram.ResendOrganizationInviteRequest? Type520 { get; set; } + public global::System.Collections.Generic.IList? Type520 { get; set; } /// /// /// - public global::Ideogram.ListOrganizationInvoicesResponse? Type521 { get; set; } + public global::Ideogram.LiteOrganizationMember? Type521 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type522 { get; set; } + public global::Ideogram.RemoveOrganizationMembersRequest? Type522 { get; set; } /// /// /// - public global::Ideogram.Invoice? Type523 { get; set; } + public global::Ideogram.PromoteOrganizationAdminsRequest? Type523 { get; set; } /// /// /// - public global::Ideogram.InvoiceStatus? Type524 { get; set; } + public global::Ideogram.DemoteOrganizationAdminsRequest? Type524 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type525 { get; set; } + public global::Ideogram.CancelOrganizationInviteRequest? Type525 { get; set; } /// /// /// - public global::Ideogram.InvoiceLineItem? Type526 { get; set; } + public global::Ideogram.ResendOrganizationInviteRequest? Type526 { get; set; } /// /// /// - public global::Ideogram.GetOrganizationBillingPortalResponse? Type527 { get; set; } + public global::Ideogram.ListOrganizationInvoicesResponse? Type527 { get; set; } /// /// /// - public global::Ideogram.ListDatasetsResponse? Type528 { get; set; } + public global::System.Collections.Generic.IList? Type528 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type529 { get; set; } + public global::Ideogram.Invoice? Type529 { get; set; } /// /// /// - public global::Ideogram.Dataset? Type530 { get; set; } + public global::Ideogram.InvoiceStatus? Type530 { get; set; } /// /// /// - public global::Ideogram.CreateDatasetRequest? Type531 { get; set; } + public global::System.Collections.Generic.IList? Type531 { get; set; } /// /// /// - public global::Ideogram.GetDatasetResponse? Type532 { get; set; } + public global::Ideogram.InvoiceLineItem? Type532 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type533 { get; set; } + public global::Ideogram.GetOrganizationBillingPortalResponse? Type533 { get; set; } /// /// /// - public global::Ideogram.DatasetFile? Type534 { get; set; } + public global::Ideogram.ListDatasetsResponse? Type534 { get; set; } /// /// /// - public global::Ideogram.UploadDatasetAssetsResponse? Type535 { get; set; } + public global::System.Collections.Generic.IList? Type535 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type536 { get; set; } + public global::Ideogram.Dataset? Type536 { get; set; } /// /// /// - public global::Ideogram.DatasetUploadSucceededAsset? Type537 { get; set; } + public global::Ideogram.CreateDatasetRequest? Type537 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type538 { get; set; } + public global::Ideogram.GetDatasetResponse? Type538 { get; set; } /// /// /// - public global::Ideogram.DatasetUploadFailedAsset? Type539 { get; set; } + public global::System.Collections.Generic.IList? Type539 { get; set; } /// /// /// - public global::Ideogram.DatasetAssetFailureReason? Type540 { get; set; } + public global::Ideogram.DatasetFile? Type540 { get; set; } /// /// /// - public global::Ideogram.UploadDatasetAssetsRequest? Type541 { get; set; } + public global::Ideogram.UploadDatasetAssetsResponse? Type541 { get; set; } /// /// /// - public global::Ideogram.TrainDatasetModelResponse? Type542 { get; set; } + public global::System.Collections.Generic.IList? Type542 { get; set; } /// /// /// - public global::Ideogram.TrainDatasetModelRequest? Type543 { get; set; } + public global::Ideogram.DatasetUploadSucceededAsset? Type543 { get; set; } /// /// /// - public global::Ideogram.ListModelsResponse? Type544 { get; set; } + public global::System.Collections.Generic.IList? Type544 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type545 { get; set; } + public global::Ideogram.DatasetUploadFailedAsset? Type545 { get; set; } /// /// /// - public global::Ideogram.CustomModel? Type546 { get; set; } + public global::Ideogram.DatasetAssetFailureReason? Type546 { get; set; } /// /// /// - public global::Ideogram.ModelStatus? Type547 { get; set; } + public global::Ideogram.UploadDatasetAssetsRequest? Type547 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type548 { get; set; } + public global::Ideogram.TrainDatasetModelResponse? Type548 { get; set; } /// /// /// - public global::Ideogram.TrainingRun? Type549 { get; set; } + public global::Ideogram.TrainDatasetModelRequest? Type549 { get; set; } /// /// /// - public global::Ideogram.TrainingRunStatus? Type550 { get; set; } + public global::Ideogram.ListModelsResponse? Type550 { get; set; } /// /// /// - public global::Ideogram.GetModelResponse? Type551 { get; set; } + public global::System.Collections.Generic.IList? Type551 { get; set; } /// /// /// - public global::Ideogram.TrainModelV3Request? Type552 { get; set; } + public global::Ideogram.CustomModel? Type552 { get; set; } /// /// /// - public global::Ideogram.TrainModelV3AdvancedRequest? Type553 { get; set; } + public global::Ideogram.ModelStatus? Type553 { get; set; } /// /// /// - public global::Ideogram.TrainModelV4Request? Type554 { get; set; } + public global::System.Collections.Generic.IList? Type554 { get; set; } /// /// /// - public global::Ideogram.TrainModelV4AdvancedRequest? Type555 { get; set; } + public global::Ideogram.TrainingRun? Type555 { get; set; } /// /// /// - public global::Ideogram.PublishMiniAppResponse? Type556 { get; set; } + public global::Ideogram.TrainingRunStatus? Type556 { get; set; } /// /// /// - public global::Ideogram.PublishMiniAppRequest? Type557 { get; set; } + public global::Ideogram.GetModelResponse? Type557 { get; set; } /// /// /// - public global::Ideogram.PublishMiniAppRequestEmbed? Type558 { get; set; } + public global::Ideogram.TrainModelV3Request? Type558 { get; set; } /// /// /// - public object? Type559 { get; set; } + public global::Ideogram.TrainModelV3AdvancedRequest? Type559 { get; set; } /// /// /// - public global::Ideogram.MiniAppArtwork? Type560 { get; set; } + public global::Ideogram.TrainModelV4Request? Type560 { get; set; } /// /// /// - public global::Ideogram.PublishMiniAppPreviewResponse? Type561 { get; set; } + public global::Ideogram.TrainModelV4AdvancedRequest? Type561 { get; set; } /// /// /// - public global::Ideogram.PublishMiniAppPreviewRequest? Type562 { get; set; } + public global::Ideogram.PublishMiniAppResponse? Type562 { get; set; } /// /// /// - public global::Ideogram.PublishMiniAppPreviewRequestEmbed? Type563 { get; set; } + public global::Ideogram.PublishMiniAppRequest? Type563 { get; set; } /// /// /// - public global::Ideogram.UnpublishMiniAppPreviewResponse? Type564 { get; set; } + public global::Ideogram.PublishMiniAppRequestEmbed? Type564 { get; set; } /// /// /// - public global::Ideogram.GetStaleMiniAppPreviewsResponse? Type565 { get; set; } + public object? Type565 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type566 { get; set; } + public global::Ideogram.MiniAppArtwork? Type566 { get; set; } /// /// /// - public global::Ideogram.MiniAppMarketingProjectionEntry? Type567 { get; set; } + public global::Ideogram.PublishMiniAppPreviewResponse? Type567 { get; set; } /// /// /// - public global::Ideogram.MiniAppMarketingProjectionEntryEmbed? Type568 { get; set; } + public global::Ideogram.PublishMiniAppPreviewRequest? Type568 { get; set; } /// /// /// - public global::Ideogram.GetIntegrationsResponse? Type569 { get; set; } + public global::Ideogram.PublishMiniAppPreviewRequestEmbed? Type569 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type570 { get; set; } + public global::Ideogram.UnpublishMiniAppPreviewResponse? Type570 { get; set; } /// /// /// - public global::Ideogram.IntegrationType? Type571 { get; set; } + public global::Ideogram.GetStaleMiniAppPreviewsResponse? Type571 { get; set; } /// /// /// - public global::Ideogram.IntegrationErrorResponse? Type572 { get; set; } + public global::System.Collections.Generic.IList? Type572 { get; set; } /// /// /// - public global::Ideogram.IntegrationErrorResponseError? Type573 { get; set; } + public global::Ideogram.MiniAppMarketingProjectionEntry? Type573 { get; set; } /// /// /// - public global::Ideogram.IntegrationAssetSearchResponse? Type574 { get; set; } + public global::Ideogram.MiniAppMarketingProjectionEntryEmbed? Type574 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type575 { get; set; } + public global::Ideogram.GetIntegrationsResponse? Type575 { get; set; } /// /// /// - public global::Ideogram.IntegrationAsset? Type576 { get; set; } + public global::System.Collections.Generic.IList? Type576 { get; set; } /// /// /// - public global::Ideogram.IntegrationAssetDelivery? Type577 { get; set; } + public global::Ideogram.IntegrationType? Type577 { get; set; } /// /// /// - public global::Ideogram.IntegrationAssetSearchRequest? Type578 { get; set; } + public global::Ideogram.IntegrationErrorResponse? Type578 { get; set; } /// /// /// - public global::Ideogram.V4StyleDescription? Type579 { get; set; } + public global::Ideogram.IntegrationErrorResponseError? Type579 { get; set; } /// /// /// - public global::Ideogram.V4CompositionalDeconstruction? Type580 { get; set; } + public global::Ideogram.IntegrationAssetSearchResponse? Type580 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type581 { get; set; } + public global::System.Collections.Generic.IList? Type581 { get; set; } /// /// /// - public global::Ideogram.V4PromptElement? Type582 { get; set; } + public global::Ideogram.IntegrationAsset? Type582 { get; set; } /// /// /// - public global::Ideogram.V4ObjPromptElement? Type583 { get; set; } + public global::Ideogram.IntegrationAssetDelivery? Type583 { get; set; } /// /// /// - public global::Ideogram.V4TextPromptElement? Type584 { get; set; } + public global::Ideogram.IntegrationAssetSearchRequest? Type584 { get; set; } /// /// /// - public global::Ideogram.V4PromptElementDiscriminator? Type585 { get; set; } + public global::Ideogram.V4StyleDescription? Type585 { get; set; } /// /// /// - public global::Ideogram.V4PromptElementDiscriminatorType? Type586 { get; set; } + public global::Ideogram.V4CompositionalDeconstruction? Type586 { get; set; } /// /// /// - public global::Ideogram.V4ObjPromptElementType? Type587 { get; set; } + public global::System.Collections.Generic.IList? Type587 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type588 { get; set; } + public global::Ideogram.V4PromptElement? Type588 { get; set; } /// /// /// - public global::Ideogram.V4TextPromptElementType? Type589 { get; set; } + public global::Ideogram.V4ObjPromptElement? Type589 { get; set; } /// /// /// - public global::Ideogram.ColorPaletteWithPresetName? Type590 { get; set; } + public global::Ideogram.V4TextPromptElement? Type590 { get; set; } /// /// /// - public global::Ideogram.ColorPaletteWithMembers? Type591 { get; set; } + public global::Ideogram.V4PromptElementDiscriminator? Type591 { get; set; } /// /// /// - public global::Ideogram.ColorPalettePresetName? Type592 { get; set; } + public global::Ideogram.V4PromptElementDiscriminatorType? Type592 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type593 { get; set; } + public global::Ideogram.V4ObjPromptElementType? Type593 { get; set; } /// /// /// - public global::Ideogram.ColorPaletteMember? Type594 { get; set; } + public global::System.Collections.Generic.IList? Type594 { get; set; } /// /// /// - public global::Ideogram.VideoObject? Type595 { get; set; } + public global::Ideogram.V4TextPromptElementType? Type595 { get; set; } /// /// /// - public global::Ideogram.VideoObjectObjectType? Type596 { get; set; } + public global::Ideogram.ColorPaletteWithPresetName? Type596 { get; set; } /// /// /// - public global::Ideogram.DetectedTextBlockAlignment? Type597 { get; set; } + public global::Ideogram.ColorPaletteWithMembers? Type597 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type598 { get; set; } + public global::Ideogram.ColorPalettePresetName? Type598 { get; set; } /// /// /// - public global::Ideogram.DetectedTextBlockFormattingItem? Type599 { get; set; } + public global::System.Collections.Generic.IList? Type599 { get; set; } /// /// /// - public global::Ideogram.DetectedTextBlockRole? Type600 { get; set; } + public global::Ideogram.ColorPaletteMember? Type600 { get; set; } /// /// /// - public global::Ideogram.AssetType? Type601 { get; set; } + public global::Ideogram.VideoObject? Type601 { get; set; } /// /// /// - public global::Ideogram.IdeogramColorPaletteWithPresetName? Type602 { get; set; } + public global::Ideogram.VideoObjectObjectType? Type602 { get; set; } /// /// /// - public global::Ideogram.IdeogramColorPalettePresetName? Type603 { get; set; } + public global::Ideogram.DetectedTextBlockAlignment? Type603 { get; set; } /// /// /// - public global::Ideogram.PostGenerateDesignV4200Response? Type604 { get; set; } + public global::System.Collections.Generic.IList? Type604 { get; set; } /// /// /// - public global::Ideogram.PostGenerateDesignV4200ResponseDiscriminator? Type605 { get; set; } + public global::Ideogram.DetectedTextBlockFormattingItem? Type605 { get; set; } /// /// /// - public global::Ideogram.PostGenerateDesignV4200ResponseDiscriminatorResponseType? Type606 { get; set; } + public global::Ideogram.DetectedTextBlockRole? Type606 { get; set; } /// /// /// - public global::Ideogram.PostInternalTesting200Response? Type607 { get; set; } + public global::Ideogram.AssetType? Type607 { get; set; } /// /// /// - public global::Ideogram.GenerationResponseDataInnerDiscriminator? Type608 { get; set; } + public global::Ideogram.IdeogramColorPaletteWithPresetName? Type608 { get; set; } /// /// /// - public global::Ideogram.GenerationResponseDataInnerDiscriminatorObjectType? Type609 { get; set; } + public global::Ideogram.IdeogramColorPalettePresetName? Type609 { get; set; } /// /// /// - public global::Ideogram.MagicPromptRequestMessagesInnerRole? Type610 { get; set; } + public global::Ideogram.PostGenerateDesignV4200Response? Type610 { get; set; } /// /// /// - public global::Ideogram.DatasetCoverAssetIdentifier? Type611 { get; set; } + public global::Ideogram.PostGenerateDesignV4200ResponseDiscriminator? Type611 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type612 { get; set; } + public global::Ideogram.PostGenerateDesignV4200ResponseDiscriminatorResponseType? Type612 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type613 { get; set; } + public global::Ideogram.PostInternalTesting200Response? Type613 { get; set; } /// /// /// - public global::Ideogram.ListCustomModelsScope? Type614 { get; set; } + public global::Ideogram.GenerationResponseDataInnerDiscriminator? Type614 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type615 { get; set; } + public global::Ideogram.GenerationResponseDataInnerDiscriminatorObjectType? Type615 { get; set; } /// /// /// - public global::Ideogram.GetAccountUsageBucketWidth? Type616 { get; set; } + public global::Ideogram.MagicPromptRequestMessagesInnerRole? Type616 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type617 { get; set; } + public global::Ideogram.DatasetCoverAssetIdentifier? Type617 { get; set; } /// /// /// - public global::Ideogram.GetAccountUsageSource? Type618 { get; set; } + public global::System.Collections.Generic.IList? Type618 { get; set; } + /// + /// + /// + public global::System.Collections.Generic.IList? Type619 { get; set; } + /// + /// + /// + public global::Ideogram.ListCustomModelsScope? Type620 { get; set; } + /// + /// + /// + public global::System.Collections.Generic.IList? Type621 { get; set; } + /// + /// + /// + public global::Ideogram.GetAccountUsageBucketWidth? Type622 { get; set; } + /// + /// + /// + public global::System.Collections.Generic.IList? Type623 { get; set; } + /// + /// + /// + public global::Ideogram.GetAccountUsageSource? Type624 { get; set; } /// /// @@ -2606,182 +2630,186 @@ public sealed partial class JsonSerializerContextTypes /// /// /// - public global::System.Collections.Generic.List? ListType24 { get; set; } + public global::System.Collections.Generic.List? ListType24 { get; set; } + /// + /// + /// + public global::System.Collections.Generic.List? ListType25 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType25 { get; set; } + public global::System.Collections.Generic.List? ListType26 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType26 { get; set; } + public global::System.Collections.Generic.List? ListType27 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType27 { get; set; } + public global::System.Collections.Generic.List? ListType28 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType28 { get; set; } + public global::System.Collections.Generic.List? ListType29 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType29 { get; set; } + public global::System.Collections.Generic.List? ListType30 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType30 { get; set; } + public global::System.Collections.Generic.List? ListType31 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType31 { get; set; } + public global::System.Collections.Generic.List? ListType32 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType32 { get; set; } + public global::System.Collections.Generic.List? ListType33 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType33 { get; set; } + public global::System.Collections.Generic.List? ListType34 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType34 { get; set; } + public global::System.Collections.Generic.List? ListType35 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType35 { get; set; } + public global::System.Collections.Generic.List? ListType36 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType36 { get; set; } + public global::System.Collections.Generic.List? ListType37 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType37 { get; set; } + public global::System.Collections.Generic.List? ListType38 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType38 { get; set; } + public global::System.Collections.Generic.List? ListType39 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType39 { get; set; } + public global::System.Collections.Generic.List? ListType40 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType40 { get; set; } + public global::System.Collections.Generic.List? ListType41 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType41 { get; set; } + public global::System.Collections.Generic.List? ListType42 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType42 { get; set; } + public global::System.Collections.Generic.List? ListType43 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType43 { get; set; } + public global::System.Collections.Generic.List? ListType44 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType44 { get; set; } + public global::System.Collections.Generic.List? ListType45 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType45 { get; set; } + public global::System.Collections.Generic.List? ListType46 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType46 { get; set; } + public global::System.Collections.Generic.List? ListType47 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType47 { get; set; } + public global::System.Collections.Generic.List? ListType48 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType48 { get; set; } + public global::System.Collections.Generic.List? ListType49 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType49 { get; set; } + public global::System.Collections.Generic.List? ListType50 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType50 { get; set; } + public global::System.Collections.Generic.List? ListType51 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType51 { get; set; } + public global::System.Collections.Generic.List? ListType52 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType52 { get; set; } + public global::System.Collections.Generic.List? ListType53 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType53 { get; set; } + public global::System.Collections.Generic.List? ListType54 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType54 { get; set; } + public global::System.Collections.Generic.List? ListType55 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType55 { get; set; } + public global::System.Collections.Generic.List? ListType56 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType56 { get; set; } + public global::System.Collections.Generic.List? ListType57 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType57 { get; set; } + public global::System.Collections.Generic.List? ListType58 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType58 { get; set; } + public global::System.Collections.Generic.List? ListType59 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType59 { get; set; } + public global::System.Collections.Generic.List? ListType60 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType60 { get; set; } + public global::System.Collections.Generic.List? ListType61 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType61 { get; set; } + public global::System.Collections.Generic.List? ListType62 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType62 { get; set; } + public global::System.Collections.Generic.List? ListType63 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType63 { get; set; } + public global::System.Collections.Generic.List? ListType64 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType64 { get; set; } + public global::System.Collections.Generic.List? ListType65 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType65 { get; set; } + public global::System.Collections.Generic.List? ListType66 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType66 { get; set; } + public global::System.Collections.Generic.List? ListType67 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType67 { get; set; } + public global::System.Collections.Generic.List? ListType68 { get; set; } /// /// /// - public global::System.Collections.Generic.List? ListType68 { get; set; } + public global::System.Collections.Generic.List? ListType69 { get; set; } } } \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerRequest.g.cs index 1b43cfcf..7abbbfbc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerRequest.g.cs @@ -4,9 +4,7 @@ namespace Ideogram { /// - /// Supply the source advertisement as either an `AssetIdentifier` reference
- /// or (multipart requests only) raw image bytes; provide exactly one of the
- /// two forms. Supplying both, or neither, is rejected with a 400. + /// Upload the source ad as `image` and choose a target `language`. ///
public sealed partial class AdLocalizerRequest { @@ -19,23 +17,25 @@ public sealed partial class AdLocalizerRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source advertisement to localize (max size 25MB), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Multipart requests
- /// only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source ad to localize (max size 25MB). Its layout, logos, brand
+ /// type, and product are preserved, and the output keeps its shape, so
+ /// no size or aspect ratio is needed. JPEG, PNG, and WEBP formats are
+ /// supported. Multipart requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source advertisement to localize (max size 25MB), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Multipart requests
- /// only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source ad to localize (max size 25MB). Its layout, logos, brand
+ /// type, and product are preserved, and the output keeps its shape, so
+ /// no size or aspect ratio is needed. JPEG, PNG, and WEBP formats are
+ /// supported. Multipart requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } /// - /// The target language the copy is rebuilt in. Arabic is rendered right-to-left. + /// The target language for the copy. Arabic is rendered right-to-left. Each request covers one language; send one request per language. /// [global::System.Text.Json.Serialization.JsonPropertyName("language")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.AdLocalizerRequestLanguageJsonConverter))] @@ -49,7 +49,7 @@ public sealed partial class AdLocalizerRequest public string? ExactCopy { get; set; } /// - /// Optional additional direction for the localization, for example "keep the badge in English". It takes priority over the preservation rules for anything it explicitly asks to change. + /// Optional additional direction for the localization, for example "keep the badge in English". Anything it explicitly asks to change takes priority over the preservation rules. /// [global::System.Text.Json.Serialization.JsonPropertyName("prompt")] public string? Prompt { get; set; } @@ -114,27 +114,29 @@ public sealed partial class AdLocalizerRequest /// Initializes a new instance of the class. ///
/// - /// The target language the copy is rebuilt in. Arabic is rendered right-to-left. + /// The target language for the copy. Arabic is rendered right-to-left. Each request covers one language; send one request per language. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source advertisement to localize (max size 25MB), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Multipart requests
- /// only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source ad to localize (max size 25MB). Its layout, logos, brand
+ /// type, and product are preserved, and the output keeps its shape, so
+ /// no size or aspect ratio is needed. JPEG, PNG, and WEBP formats are
+ /// supported. Multipart requests only. /// /// - /// The source advertisement to localize (max size 25MB), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Multipart requests
- /// only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source ad to localize (max size 25MB). Its layout, logos, brand
+ /// type, and product are preserved, and the output keeps its shape, so
+ /// no size or aspect ratio is needed. JPEG, PNG, and WEBP formats are
+ /// supported. Multipart requests only. /// /// /// Pre-approved wording, one `original => replacement` mapping per line. Each mapping names the text element showing `original` and sets it to `replacement`, placed character for character rather than translated. Any text element not listed is left as it is in the source. When omitted, all visible marketing copy is translated. /// /// - /// Optional additional direction for the localization, for example "keep the badge in English". It takes priority over the preservation rules for anything it explicitly asks to change. + /// Optional additional direction for the localization, for example "keep the badge in English". Anything it explicitly asks to change takes priority over the preservation rules. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerRequestLanguage.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerRequestLanguage.g.cs index b7e6763f..b7b8250b 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerRequestLanguage.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerRequestLanguage.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// The target language the copy is rebuilt in. Arabic is rendered right-to-left. + /// The target language for the copy. Arabic is rendered right-to-left. Each request covers one language; send one request per language. /// public enum AdLocalizerRequestLanguage { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerResponse.g.cs index 4d082505..df14f609 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AdLocalizerResponse.g.cs @@ -4,7 +4,8 @@ namespace Ideogram { /// - /// Acknowledgement that the workflow was accepted.
+ /// Acknowledgement that the ad localization was accepted. Poll
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class AdLocalizerResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequest.g.cs index 17cf6d00..2c8f5fd7 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequest.g.cs @@ -4,9 +4,7 @@ namespace Ideogram { /// - /// Supply the source creative as either an `AssetIdentifier` reference or
- /// (multipart requests only) raw image bytes; provide exactly one of the
- /// two forms. Supplying both, or neither, is rejected with a 400. + /// Upload the source creative as `image` and choose a target `resolution`. ///
public sealed partial class AdResizerRequest { @@ -19,26 +17,23 @@ public sealed partial class AdResizerRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source creative to reframe (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to reframe (max size 25MB). JPEG, PNG, and
+ /// WEBP formats are supported. Multipart requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source creative to reframe (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to reframe (max size 25MB). JPEG, PNG, and
+ /// WEBP formats are supported. Multipart requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } /// - /// Target ad resolution, formatted as `WIDTHxHEIGHT`. Must be one of
- /// the supported ad resolutions listed above; any other value is
- /// rejected with a 400. Each returned image has exactly these pixel
- /// dimensions, whether or not a `platform` was supplied. + /// Target ad resolution, formatted as `WIDTHxHEIGHT`. Any value not in
+ /// the list is rejected with a 400. Each output image has exactly these
+ /// pixel dimensions, with or without a `platform`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("resolution")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.AdResizerRequestResolutionJsonConverter))] @@ -46,17 +41,27 @@ public sealed partial class AdResizerRequest public required global::Ideogram.AdResizerRequestResolution Resolution { get; set; } /// - /// The ad platform whose published safe zone the advertisement must
- /// stay inside. `google` covers YouTube and Google Ads placements;
- /// use `meta_stories` or `meta_reels` for the placement-specific Meta
- /// generation bounds. Reels uses the largest rectangle contained by
- /// its notched safe-zone polygon. The legacy `meta` value remains
- /// supported for existing callers with its conservative safe zone.
- /// When supplied, the advertisement is generated inside that
- /// platform's safe zone for the requested aspect ratio and the
- /// remaining space is filled in around it. When omitted, the
- /// advertisement fills the whole frame. Any other value is rejected
- /// with a 400. + /// The ad platform whose published safe zone the ad must stay inside.
+ /// The ad is generated inside the largest rectangle that fits the
+ /// platform's safe zone for the requested aspect ratio, and the space
+ /// around it is filled in so the output is still exactly the requested
+ /// `resolution`. `google` covers YouTube and Google Ads placements.
+ /// Use `meta_stories` or `meta_reels` for Meta placements; Reels uses
+ /// the largest rectangle inside its notched safe zone. The legacy
+ /// `meta` value is still supported and uses a more conservative safe
+ /// zone. When omitted, the ad fills the whole frame and every
+ /// supported `resolution` is accepted. Any other value is rejected
+ /// with a 400.
+ /// Each platform accepts only the resolutions for which it publishes a
+ /// safe zone; any other `resolution` is rejected with a 400:
+ /// | Platform | Accepted resolutions |
+ /// | --- | --- |
+ /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
+ /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
+ /// | `meta_stories` | `1080x1920`, `2160x3840` |
+ /// | `meta_reels` | `1080x1920`, `2160x3840` |
+ /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
+ /// | `snapchat` | `1080x1920`, `2160x3840` | ///
[global::System.Text.Json.Serialization.JsonPropertyName("platform")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.AdResizerRequestPlatformJsonConverter))] @@ -120,37 +125,44 @@ public sealed partial class AdResizerRequest /// Initializes a new instance of the class. ///
/// - /// Target ad resolution, formatted as `WIDTHxHEIGHT`. Must be one of
- /// the supported ad resolutions listed above; any other value is
- /// rejected with a 400. Each returned image has exactly these pixel
- /// dimensions, whether or not a `platform` was supplied. + /// Target ad resolution, formatted as `WIDTHxHEIGHT`. Any value not in
+ /// the list is rejected with a 400. Each output image has exactly these
+ /// pixel dimensions, with or without a `platform`. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source creative to reframe (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to reframe (max size 25MB). JPEG, PNG, and
+ /// WEBP formats are supported. Multipart requests only. /// /// - /// The source creative to reframe (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to reframe (max size 25MB). JPEG, PNG, and
+ /// WEBP formats are supported. Multipart requests only. /// /// - /// The ad platform whose published safe zone the advertisement must
- /// stay inside. `google` covers YouTube and Google Ads placements;
- /// use `meta_stories` or `meta_reels` for the placement-specific Meta
- /// generation bounds. Reels uses the largest rectangle contained by
- /// its notched safe-zone polygon. The legacy `meta` value remains
- /// supported for existing callers with its conservative safe zone.
- /// When supplied, the advertisement is generated inside that
- /// platform's safe zone for the requested aspect ratio and the
- /// remaining space is filled in around it. When omitted, the
- /// advertisement fills the whole frame. Any other value is rejected
- /// with a 400. + /// The ad platform whose published safe zone the ad must stay inside.
+ /// The ad is generated inside the largest rectangle that fits the
+ /// platform's safe zone for the requested aspect ratio, and the space
+ /// around it is filled in so the output is still exactly the requested
+ /// `resolution`. `google` covers YouTube and Google Ads placements.
+ /// Use `meta_stories` or `meta_reels` for Meta placements; Reels uses
+ /// the largest rectangle inside its notched safe zone. The legacy
+ /// `meta` value is still supported and uses a more conservative safe
+ /// zone. When omitted, the ad fills the whole frame and every
+ /// supported `resolution` is accepted. Any other value is rejected
+ /// with a 400.
+ /// Each platform accepts only the resolutions for which it publishes a
+ /// safe zone; any other `resolution` is rejected with a 400:
+ /// | Platform | Accepted resolutions |
+ /// | --- | --- |
+ /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
+ /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
+ /// | `meta_stories` | `1080x1920`, `2160x3840` |
+ /// | `meta_reels` | `1080x1920`, `2160x3840` |
+ /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
+ /// | `snapchat` | `1080x1920`, `2160x3840` | /// /// /// Optional edit instruction to apply while reframing, for example "remove the logo" or "put the price bottom-right". diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequestPlatform.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequestPlatform.g.cs index a761580e..45e5c2ca 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequestPlatform.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequestPlatform.g.cs @@ -4,17 +4,27 @@ namespace Ideogram { /// - /// The ad platform whose published safe zone the advertisement must
- /// stay inside. `google` covers YouTube and Google Ads placements;
- /// use `meta_stories` or `meta_reels` for the placement-specific Meta
- /// generation bounds. Reels uses the largest rectangle contained by
- /// its notched safe-zone polygon. The legacy `meta` value remains
- /// supported for existing callers with its conservative safe zone.
- /// When supplied, the advertisement is generated inside that
- /// platform's safe zone for the requested aspect ratio and the
- /// remaining space is filled in around it. When omitted, the
- /// advertisement fills the whole frame. Any other value is rejected
- /// with a 400. + /// The ad platform whose published safe zone the ad must stay inside.
+ /// The ad is generated inside the largest rectangle that fits the
+ /// platform's safe zone for the requested aspect ratio, and the space
+ /// around it is filled in so the output is still exactly the requested
+ /// `resolution`. `google` covers YouTube and Google Ads placements.
+ /// Use `meta_stories` or `meta_reels` for Meta placements; Reels uses
+ /// the largest rectangle inside its notched safe zone. The legacy
+ /// `meta` value is still supported and uses a more conservative safe
+ /// zone. When omitted, the ad fills the whole frame and every
+ /// supported `resolution` is accepted. Any other value is rejected
+ /// with a 400.
+ /// Each platform accepts only the resolutions for which it publishes a
+ /// safe zone; any other `resolution` is rejected with a 400:
+ /// | Platform | Accepted resolutions |
+ /// | --- | --- |
+ /// | `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
+ /// | `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |
+ /// | `meta_stories` | `1080x1920`, `2160x3840` |
+ /// | `meta_reels` | `1080x1920`, `2160x3840` |
+ /// | `meta` (legacy) | `1080x1920`, `2160x3840` |
+ /// | `snapchat` | `1080x1920`, `2160x3840` | ///
public enum AdResizerRequestPlatform { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequestResolution.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequestResolution.g.cs index dffd1a03..78819a48 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequestResolution.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerRequestResolution.g.cs @@ -4,10 +4,9 @@ namespace Ideogram { /// - /// Target ad resolution, formatted as `WIDTHxHEIGHT`. Must be one of
- /// the supported ad resolutions listed above; any other value is
- /// rejected with a 400. Each returned image has exactly these pixel
- /// dimensions, whether or not a `platform` was supplied. + /// Target ad resolution, formatted as `WIDTHxHEIGHT`. Any value not in
+ /// the list is rejected with a 400. Each output image has exactly these
+ /// pixel dimensions, with or without a `platform`. ///
public enum AdResizerRequestResolution { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerResponse.g.cs index 33c4a9b3..11d08ffd 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AdResizerResponse.g.cs @@ -5,7 +5,7 @@ namespace Ideogram { /// /// Acknowledgement that the ad resize was accepted. Poll
- /// `GET /v1/generations/{generation_id}` for status and results.
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class AdResizerResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsRequest.g.cs index 5de0f775..bd3db3b0 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsRequest.g.cs @@ -4,9 +4,7 @@ namespace Ideogram { /// - /// Supply the source creative as either an `AssetIdentifier` reference or
- /// (multipart requests only) raw image bytes; provide exactly one of the
- /// two forms. Supplying both, or neither, is rejected with a 400. + /// Upload the source creative as `image` and choose a `variation_type`. ///
public sealed partial class AdVariationsRequest { @@ -19,23 +17,25 @@ public sealed partial class AdVariationsRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source creative to vary (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to vary (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. Multipart requests only. Each output keeps
+ /// the source's aspect ratio, capped at 3:1 between the long and short
+ /// sides. ///
[global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source creative to vary (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to vary (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. Multipart requests only. Each output keeps
+ /// the source's aspect ratio, capped at 3:1 between the long and short
+ /// sides. ///
[global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } /// - /// The axis to vary while everything else stays on-brand. `people`
+ /// The axis to vary. `people`
/// replaces the people in the ad with different talent. `setting`
/// moves the same subject and product to a different environment.
/// `group_size` changes how many people appear. `scene` shifts the
@@ -47,7 +47,7 @@ public sealed partial class AdVariationsRequest public required global::Ideogram.AdVariationsRequestVariationType VariationType { get; set; } /// - /// Optional direction to steer the variation, for example "set it on a beach" or "make the models older". Takes priority over the default preservation rules for anything it explicitly asks to change. + /// Optional direction to steer the variation, for example "set it on a beach" or "make the models older". Anything it explicitly asks to change takes priority over the default preservation rules. /// [global::System.Text.Json.Serialization.JsonPropertyName("prompt")] public string? Prompt { get; set; } @@ -98,7 +98,7 @@ public sealed partial class AdVariationsRequest /// Initializes a new instance of the class. ///
/// - /// The axis to vary while everything else stays on-brand. `people`
+ /// The axis to vary. `people`
/// replaces the people in the ad with different talent. `setting`
/// moves the same subject and product to a different environment.
/// `group_size` changes how many people appear. `scene` shifts the
@@ -109,17 +109,19 @@ public sealed partial class AdVariationsRequest /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source creative to vary (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to vary (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. Multipart requests only. Each output keeps
+ /// the source's aspect ratio, capped at 3:1 between the long and short
+ /// sides. /// /// - /// The source creative to vary (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. Multipart requests only.
- /// Provide exactly one of `image_asset_identifier` or `image`. + /// The source creative to vary (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. Multipart requests only. Each output keeps
+ /// the source's aspect ratio, capped at 3:1 between the long and short
+ /// sides. /// /// - /// Optional direction to steer the variation, for example "set it on a beach" or "make the models older". Takes priority over the default preservation rules for anything it explicitly asks to change. + /// Optional direction to steer the variation, for example "set it on a beach" or "make the models older". Anything it explicitly asks to change takes priority over the default preservation rules. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsRequestVariationType.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsRequestVariationType.g.cs index ca785578..6e12d5c6 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsRequestVariationType.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsRequestVariationType.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// The axis to vary while everything else stays on-brand. `people`
+ /// The axis to vary. `people`
/// replaces the people in the ad with different talent. `setting`
/// moves the same subject and product to a different environment.
/// `group_size` changes how many people appear. `scene` shifts the
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsResponse.g.cs index ea2ad7d4..94164564 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AdVariationsResponse.g.cs @@ -5,7 +5,7 @@ namespace Ideogram { /// /// Acknowledgement that the ad variation was accepted. Poll
- /// `GET /v1/generations/{generation_id}` for status and results.
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class AdVariationsResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageItem.Json.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageItem.Json.g.cs new file mode 100644 index 00000000..fc53b021 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageItem.Json.g.cs @@ -0,0 +1,141 @@ +#nullable enable + +namespace Ideogram +{ + public sealed partial class AssetReferenceUsageItem + { + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerContext. + /// + public string ToJson( + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Serialize( + this, + this.GetType(), + jsonSerializerContext); + } + + /// + /// Serializes the current instance to a JSON string using the generated default JsonSerializerContext. + /// + public string ToJson() + { + return ToJson(global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public string ToJson( + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return ToJson(global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.Serialize( + this, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerContext. + /// + public static global::Ideogram.AssetReferenceUsageItem? FromJson( + string json, + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + typeof(global::Ideogram.AssetReferenceUsageItem), + jsonSerializerContext) as global::Ideogram.AssetReferenceUsageItem; + } + + /// + /// Deserializes a JSON string using the generated default JsonSerializerContext. + /// + public static global::Ideogram.AssetReferenceUsageItem? FromJson( + string json) + { + return FromJson( + json, + global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public static global::Ideogram.AssetReferenceUsageItem? FromJson( + string json, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return FromJson( + json, + global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerContext. + /// + public static async global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream, + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return (await global::System.Text.Json.JsonSerializer.DeserializeAsync( + jsonStream, + typeof(global::Ideogram.AssetReferenceUsageItem), + jsonSerializerContext).ConfigureAwait(false)) as global::Ideogram.AssetReferenceUsageItem; + } + + /// + /// Deserializes a JSON stream using the generated default JsonSerializerContext. + /// + public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream) + { + return FromJsonStreamAsync( + jsonStream, + global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return FromJsonStreamAsync( + jsonStream, + global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.DeserializeAsync( + jsonStream, + jsonSerializerOptions); + } + } +} diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageItem.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageItem.g.cs new file mode 100644 index 00000000..7a0dd54f --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageItem.g.cs @@ -0,0 +1,62 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// Example: {"asset_identifier":{"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"},"request_count":1} + /// + public sealed partial class AssetReferenceUsageItem + { + /// + /// An identifier for an ideogram asset.
+ /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} + ///
+ /// {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} + [global::System.Text.Json.Serialization.JsonPropertyName("asset_identifier")] + [global::System.Text.Json.Serialization.JsonRequired] + public required global::Ideogram.AssetIdentifier AssetIdentifier { get; set; } + + /// + /// Completed organization requests using the asset as an edit input within the requested range. + /// + [global::System.Text.Json.Serialization.JsonPropertyName("request_count")] + [global::System.Text.Json.Serialization.JsonRequired] + public required long RequestCount { get; set; } + + /// + /// Additional properties that are not explicitly defined in the schema + /// + [global::System.Text.Json.Serialization.JsonExtensionData] + public global::System.Collections.Generic.IDictionary AdditionalProperties { get; set; } = new global::System.Collections.Generic.Dictionary(); + + /// + /// Initializes a new instance of the class. + /// + /// + /// An identifier for an ideogram asset.
+ /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} + /// + /// + /// Completed organization requests using the asset as an edit input within the requested range. + /// +#if NET7_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] +#endif + public AssetReferenceUsageItem( + global::Ideogram.AssetIdentifier assetIdentifier, + long requestCount) + { + this.AssetIdentifier = assetIdentifier ?? throw new global::System.ArgumentNullException(nameof(assetIdentifier)); + this.RequestCount = requestCount; + } + + /// + /// Initializes a new instance of the class. + /// + public AssetReferenceUsageItem() + { + } + + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageResponse.Json.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageResponse.Json.g.cs new file mode 100644 index 00000000..af5f303d --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageResponse.Json.g.cs @@ -0,0 +1,141 @@ +#nullable enable + +namespace Ideogram +{ + public sealed partial class AssetReferenceUsageResponse + { + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerContext. + /// + public string ToJson( + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Serialize( + this, + this.GetType(), + jsonSerializerContext); + } + + /// + /// Serializes the current instance to a JSON string using the generated default JsonSerializerContext. + /// + public string ToJson() + { + return ToJson(global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public string ToJson( + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return ToJson(global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.Serialize( + this, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerContext. + /// + public static global::Ideogram.AssetReferenceUsageResponse? FromJson( + string json, + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + typeof(global::Ideogram.AssetReferenceUsageResponse), + jsonSerializerContext) as global::Ideogram.AssetReferenceUsageResponse; + } + + /// + /// Deserializes a JSON string using the generated default JsonSerializerContext. + /// + public static global::Ideogram.AssetReferenceUsageResponse? FromJson( + string json) + { + return FromJson( + json, + global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public static global::Ideogram.AssetReferenceUsageResponse? FromJson( + string json, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return FromJson( + json, + global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerContext. + /// + public static async global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream, + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return (await global::System.Text.Json.JsonSerializer.DeserializeAsync( + jsonStream, + typeof(global::Ideogram.AssetReferenceUsageResponse), + jsonSerializerContext).ConfigureAwait(false)) as global::Ideogram.AssetReferenceUsageResponse; + } + + /// + /// Deserializes a JSON stream using the generated default JsonSerializerContext. + /// + public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream) + { + return FromJsonStreamAsync( + jsonStream, + global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return FromJsonStreamAsync( + jsonStream, + global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.DeserializeAsync( + jsonStream, + jsonSerializerOptions); + } + } +} diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageResponse.g.cs new file mode 100644 index 00000000..ac2c4a1a --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.Models.AssetReferenceUsageResponse.g.cs @@ -0,0 +1,54 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// Example: {"next_cursor":"next_cursor","assets":[{"asset_identifier":{"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"},"request_count":1},{"asset_identifier":{"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"},"request_count":1}]} + /// + public sealed partial class AssetReferenceUsageResponse + { + /// + /// + /// + [global::System.Text.Json.Serialization.JsonPropertyName("assets")] + [global::System.Text.Json.Serialization.JsonRequired] + public required global::System.Collections.Generic.IList Assets { get; set; } + + /// + /// + /// + [global::System.Text.Json.Serialization.JsonPropertyName("next_cursor")] + public string? NextCursor { get; set; } + + /// + /// Additional properties that are not explicitly defined in the schema + /// + [global::System.Text.Json.Serialization.JsonExtensionData] + public global::System.Collections.Generic.IDictionary AdditionalProperties { get; set; } = new global::System.Collections.Generic.Dictionary(); + + /// + /// Initializes a new instance of the class. + /// + /// + /// +#if NET7_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] +#endif + public AssetReferenceUsageResponse( + global::System.Collections.Generic.IList assets, + string? nextCursor) + { + this.Assets = assets ?? throw new global::System.ArgumentNullException(nameof(assets)); + this.NextCursor = nextCursor; + } + + /// + /// Initializes a new instance of the class. + /// + public AssetReferenceUsageResponse() + { + } + + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ColorwaysRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ColorwaysRequest.g.cs index c8f10da3..a3f024d2 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ColorwaysRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ColorwaysRequest.g.cs @@ -4,9 +4,9 @@ namespace Ideogram { /// - /// Supply the product photo as raw `image` bytes, and up to 4 masks with
- /// one color per mask; a single-region edit is a one-item `masks` list
- /// with a one-item `colors` list. + /// Upload the product photo as `image` and up to 4 `masks`, with one
+ /// entry in `colors` per mask. For a single region, send one mask and one
+ /// color. ///
public sealed partial class ColorwaysRequest { @@ -19,15 +19,15 @@ public sealed partial class ColorwaysRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The product photo to recolor (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to recolor (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. ///
[global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The product photo to recolor (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to recolor (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. ///
[global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -45,13 +45,12 @@ public sealed partial class ColorwaysRequest public global::System.Collections.Generic.IList? MaskAssetIdentifiers { get; set; } /// - /// The masks marking the regions of the product photo to recolor
- /// (max 4, max size 25MB each), as raw bytes, paired by position with
- /// `colors`; only JPEG, PNG, and WEBP formats are supported. Every
- /// mask must have the same pixel dimensions as the product photo.
- /// White pixels mark the region to recolor; black pixels are
- /// preserved. Alpha-only masks are also supported: opaque pixels
- /// mark the region to recolor and transparent pixels are preserved. + /// Masks marking the regions to recolor (max 4, max size 25MB each),
+ /// paired by position with `colors`. JPEG, PNG, and WEBP formats are
+ /// supported. Every mask must have the same pixel dimensions as the
+ /// product photo. White pixels mark the region to recolor and black
+ /// pixels are preserved; alpha-only masks also work (opaque =
+ /// recolor, transparent = preserve). ///
[global::System.Text.Json.Serialization.JsonPropertyName("masks")] public global::System.Collections.Generic.IList? Masks { get; set; } @@ -66,12 +65,11 @@ public sealed partial class ColorwaysRequest public required global::System.Collections.Generic.IList Colors { get; set; } /// - /// The aspect ratio of the generated image. Defaults to the aspect
- /// ratio of the product photo when omitted, which preserves the
- /// original framing exactly. When a different ratio is requested, the
- /// scene is extended to fill the new shape rather than cropped, so
- /// part of the frame is newly generated. Supported values are `1:1`,
- /// `3:4`, `4:3`, `16:9`, and `9:16`. + /// Output aspect ratio. Defaults to the product photo's aspect ratio,
+ /// which keeps the original framing. A different ratio extends the
+ /// scene to fill the new shape rather than cropping, so part of the
+ /// frame is newly generated. Supported values are `1:1`, `3:4`,
+ /// `4:3`, `16:9`, and `9:16`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("aspect_ratio")] public string? AspectRatio { get; set; } @@ -131,12 +129,12 @@ public sealed partial class ColorwaysRequest /// `image_asset_identifier` or `image`. /// /// - /// The product photo to recolor (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to recolor (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// - /// The product photo to recolor (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to recolor (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// /// The masks marking the regions of the product photo to recolor, by
@@ -148,21 +146,19 @@ public sealed partial class ColorwaysRequest /// exactly one of `mask_asset_identifiers` or `masks`. /// /// - /// The masks marking the regions of the product photo to recolor
- /// (max 4, max size 25MB each), as raw bytes, paired by position with
- /// `colors`; only JPEG, PNG, and WEBP formats are supported. Every
- /// mask must have the same pixel dimensions as the product photo.
- /// White pixels mark the region to recolor; black pixels are
- /// preserved. Alpha-only masks are also supported: opaque pixels
- /// mark the region to recolor and transparent pixels are preserved. + /// Masks marking the regions to recolor (max 4, max size 25MB each),
+ /// paired by position with `colors`. JPEG, PNG, and WEBP formats are
+ /// supported. Every mask must have the same pixel dimensions as the
+ /// product photo. White pixels mark the region to recolor and black
+ /// pixels are preserved; alpha-only masks also work (opaque =
+ /// recolor, transparent = preserve). /// /// - /// The aspect ratio of the generated image. Defaults to the aspect
- /// ratio of the product photo when omitted, which preserves the
- /// original framing exactly. When a different ratio is requested, the
- /// scene is extended to fill the new shape rather than cropped, so
- /// part of the frame is newly generated. Supported values are `1:1`,
- /// `3:4`, `4:3`, `16:9`, and `9:16`. + /// Output aspect ratio. Defaults to the product photo's aspect ratio,
+ /// which keeps the original framing. A different ratio extends the
+ /// scene to fill the new shape rather than cropping, so part of the
+ /// frame is newly generated. Supported values are `1:1`, `3:4`,
+ /// `4:3`, `16:9`, and `9:16`. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ColorwaysResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ColorwaysResponse.g.cs index c97e834f..823c7203 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ColorwaysResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ColorwaysResponse.g.cs @@ -5,7 +5,7 @@ namespace Ideogram { /// /// Acknowledgement that the colorway was accepted. Poll
- /// `GET /v1/generations/{generation_id}` for status and results.
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class ColorwaysResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.DescribeImageIdeogramV3Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.DescribeImageIdeogramV3Request.g.cs index 8bd0fc7f..b56024b1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.DescribeImageIdeogramV3Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.DescribeImageIdeogramV3Request.g.cs @@ -4,10 +4,8 @@ namespace Ideogram { /// - /// Supply the source image either as an `image_asset_identifier`
- /// reference or (multipart requests only) as raw `image` bytes. Provide
- /// exactly one of the two forms; supplying both, or neither, is rejected
- /// with a 400. + /// A request to describe one image. Upload the image as `image` using
+ /// `multipart/form-data`. ///
public sealed partial class DescribeImageIdeogramV3Request { @@ -20,13 +18,13 @@ public sealed partial class DescribeImageIdeogramV3Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -45,10 +43,10 @@ public sealed partial class DescribeImageIdeogramV3Request /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.DescribeImageIdeogramV4Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.DescribeImageIdeogramV4Request.g.cs index 30691703..60a159aa 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.DescribeImageIdeogramV4Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.DescribeImageIdeogramV4Request.g.cs @@ -4,10 +4,8 @@ namespace Ideogram { /// - /// Supply the source image either as an `image_asset_identifier`
- /// reference or (multipart requests only) as raw `image` bytes. Provide
- /// exactly one of the two forms; supplying both, or neither, is rejected
- /// with a 400. + /// A request to describe one image. Upload the image as `image` using
+ /// `multipart/form-data`. ///
public sealed partial class DescribeImageIdeogramV4Request { @@ -20,33 +18,33 @@ public sealed partial class DescribeImageIdeogramV4Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } /// - /// Whether to include bounding boxes on the subjects and texts of the returned `json_prompt`. Defaults to true so the prompt preserves the spatial layout of the described image.
+ /// Whether to include bounding boxes for the subjects and text in the returned `json_prompt`. Defaults to true, so the prompt preserves the layout of the described image.
/// Default Value: true ///
[global::System.Text.Json.Serialization.JsonPropertyName("include_bbox")] public bool? IncludeBbox { get; set; } /// - /// Whether to include a free-form style description on the returned `json_prompt`. Defaults to false.
+ /// Whether to include a free-form style description in the returned `json_prompt`. Defaults to false.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("include_style_descriptions")] public bool? IncludeStyleDescriptions { get; set; } /// - /// Whether to include the captioner's free-form tags on the returned `json_prompt`. Defaults to false.
+ /// Whether to include free-form tags in the returned `json_prompt`. Defaults to false.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("include_tags")] @@ -66,21 +64,21 @@ public sealed partial class DescribeImageIdeogramV4Request /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// - /// The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only. /// /// - /// Whether to include bounding boxes on the subjects and texts of the returned `json_prompt`. Defaults to true so the prompt preserves the spatial layout of the described image.
+ /// Whether to include bounding boxes for the subjects and text in the returned `json_prompt`. Defaults to true, so the prompt preserves the layout of the described image.
/// Default Value: true /// /// - /// Whether to include a free-form style description on the returned `json_prompt`. Defaults to false.
+ /// Whether to include a free-form style description in the returned `json_prompt`. Defaults to false.
/// Default Value: false /// /// - /// Whether to include the captioner's free-form tags on the returned `json_prompt`. Defaults to false.
+ /// Whether to include free-form tags in the returned `json_prompt`. Defaults to false.
/// Default Value: false /// #if NET7_0_OR_GREATER diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.EditVideoMinimaxH3ReferenceToVideoRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.EditVideoMinimaxH3ReferenceToVideoRequest.g.cs index d54e70c9..8d998ec1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.EditVideoMinimaxH3ReferenceToVideoRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.EditVideoMinimaxH3ReferenceToVideoRequest.g.cs @@ -5,13 +5,10 @@ namespace Ideogram { /// /// Request body for MiniMax H3 reference-to-video. The prompt addresses
- /// references by position — `Image 1`, `Video 1`, `Audio 1`, and so on. Reference
- /// images arrive either as `reference_image_asset_identifiers` or
- /// (multipart requests only) as raw `reference_images` bytes, never both.
- /// Reference videos arrive only as
- /// `reference_video_asset_identifiers`, which must reference videos
- /// generated or uploaded with Ideogram. References are optional; audio
- /// requires an image or video alongside it. + /// references by position: `Image 1`, `Audio 1`, and so on. References
+ /// are optional; with none, the video is produced from the prompt alone.
+ /// Audio requires an image alongside it, and audio references must total
+ /// at most 15 seconds. ///
public sealed partial class EditVideoMinimaxH3ReferenceToVideoRequest { @@ -31,7 +28,7 @@ public sealed partial class EditVideoMinimaxH3ReferenceToVideoRequest public global::System.Collections.Generic.IList? ReferenceImageAssetIdentifiers { get; set; } /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Uploaded images are used for this request only and are not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("reference_images")] public global::System.Collections.Generic.IList? ReferenceImages { get; set; } @@ -130,7 +127,7 @@ public sealed partial class EditVideoMinimaxH3ReferenceToVideoRequest /// Images already stored with Ideogram to use as references, by reference, in prompt order. Cannot be combined with `reference_images`. Only image assets are accepted. /// /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Uploaded images are used for this request only and are not stored. /// /// /// Videos generated or uploaded with Ideogram to use as motion references, by reference, in prompt order. Each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds. Raw video uploads are not accepted. diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25FlareRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25FlareRequest.g.cs index 763055fc..06ca4895 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25FlareRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25FlareRequest.g.cs @@ -4,16 +4,14 @@ namespace Ideogram { /// - /// Source images are optional. When supplied (as `image_asset_identifiers`
- /// references, or as raw `images` bytes in multipart requests), the prompt
- /// is applied to the sources as an edit; if both forms are given, the
- /// references are used and the bytes are ignored. Without source images
- /// the prompt alone drives the generation. + /// Source `images` are optional. When supplied, the prompt is applied to
+ /// them as an edit. Without source images, the output is generated from
+ /// the prompt alone. ///
public sealed partial class GenerateImageGptImage25FlareRequest { /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// [global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -26,19 +24,19 @@ public sealed partial class GenerateImageGptImage25FlareRequest public global::System.Collections.Generic.IList? ImageAssetIdentifiers { get; set; } /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("images")] public global::System.Collections.Generic.IList? Images { get; set; } /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// [global::System.Text.Json.Serialization.JsonPropertyName("mask")] public byte[]? Mask { get; set; } /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// [global::System.Text.Json.Serialization.JsonPropertyName("maskname")] public string? Maskname { get; set; } @@ -92,7 +90,7 @@ public sealed partial class GenerateImageGptImage25FlareRequest public string? Resolution { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -135,19 +133,19 @@ public sealed partial class GenerateImageGptImage25FlareRequest /// Initializes a new instance of the class. ///
/// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// /// The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt.
@@ -177,7 +175,7 @@ public sealed partial class GenerateImageGptImage25FlareRequest /// are between 655360 and 8294400 inclusive. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25FlareResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25FlareResponse.g.cs index 55f2421f..1d1fbd46 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25FlareResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25FlareResponse.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/gpt-image-2-5-flare`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageGptImage25FlareResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageGptImage25FlareResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25SunburstRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25SunburstRequest.g.cs index 9df78746..80f04b63 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25SunburstRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25SunburstRequest.g.cs @@ -4,16 +4,14 @@ namespace Ideogram { /// - /// Source images are optional. When supplied (as `image_asset_identifiers`
- /// references, or as raw `images` bytes in multipart requests), the prompt
- /// is applied to the sources as an edit; if both forms are given, the
- /// references are used and the bytes are ignored. Without source images
- /// the prompt alone drives the generation. + /// Source `images` are optional. When supplied, the prompt is applied to
+ /// them as an edit. Without source images, the output is generated from
+ /// the prompt alone. ///
public sealed partial class GenerateImageGptImage25SunburstRequest { /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// [global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -26,19 +24,19 @@ public sealed partial class GenerateImageGptImage25SunburstRequest public global::System.Collections.Generic.IList? ImageAssetIdentifiers { get; set; } /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("images")] public global::System.Collections.Generic.IList? Images { get; set; } /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// [global::System.Text.Json.Serialization.JsonPropertyName("mask")] public byte[]? Mask { get; set; } /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// [global::System.Text.Json.Serialization.JsonPropertyName("maskname")] public string? Maskname { get; set; } @@ -92,7 +90,7 @@ public sealed partial class GenerateImageGptImage25SunburstRequest public string? Resolution { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -135,19 +133,19 @@ public sealed partial class GenerateImageGptImage25SunburstRequest /// Initializes a new instance of the class. /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// - /// An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`. + /// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request. /// /// /// The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt.
@@ -177,7 +175,7 @@ public sealed partial class GenerateImageGptImage25SunburstRequest /// are between 655360 and 8294400 inclusive. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25SunburstResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25SunburstResponse.g.cs index 1fa98713..f7189f08 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25SunburstResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage25SunburstResponse.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/gpt-image-2-5-sunburst`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageGptImage25SunburstResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageGptImage25SunburstResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage2Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage2Request.g.cs index d9f2992c..59006ea8 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage2Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage2Request.g.cs @@ -4,16 +4,14 @@ namespace Ideogram { /// - /// Source images are optional. When supplied (as `image_asset_identifiers`
- /// references, or as raw `images` bytes in multipart requests), the prompt
- /// is applied to the sources as an edit; if both forms are given, the
- /// references are used and the bytes are ignored. Without source images
- /// the prompt alone drives the generation. + /// Source `images` are optional. When supplied, the prompt is applied to
+ /// them as an edit. Without source images, the output is generated from
+ /// the prompt alone. ///
public sealed partial class GenerateImageGptImage2Request { /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// [global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -26,7 +24,7 @@ public sealed partial class GenerateImageGptImage2Request public global::System.Collections.Generic.IList? ImageAssetIdentifiers { get; set; } /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("images")] public global::System.Collections.Generic.IList? Images { get; set; } @@ -64,7 +62,7 @@ public sealed partial class GenerateImageGptImage2Request public string? Resolution { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -107,13 +105,13 @@ public sealed partial class GenerateImageGptImage2Request /// Initializes a new instance of the class. /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// /// The number of images to generate.
@@ -135,7 +133,7 @@ public sealed partial class GenerateImageGptImage2Request /// are between 655360 and 8294400 inclusive. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage2Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage2Response.g.cs index 08d60886..df59dd86 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage2Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageGptImage2Response.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/gpt-image-2`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageGptImage2Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageGptImage2Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45Request.g.cs index 958befbd..e1d9dc0c 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45Request.g.cs @@ -4,17 +4,15 @@ namespace Ideogram { /// - /// Source images are optional. When supplied, the request becomes an
- /// image-to-image transform and `size` defaults to "auto" (derived from
- /// the first source). A prompt is required either way. + /// Source `images` are optional. When supplied, the request edits them
+ /// and `size` defaults to "auto". A prompt is required either way. ///
public sealed partial class GenerateImageIdeogram45Request { /// - /// The prompt to generate images from, or the edit instruction to
- /// apply when source images are supplied. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. + /// The prompt to generate images from, or the edit instruction when
+ /// source images are supplied. Natural language or a structured
+ /// Ideogram 4.0 JSON prompt. ///
[global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -22,13 +20,11 @@ public sealed partial class GenerateImageIdeogram45Request /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`. With source images the
- /// prompt is an edit instruction, and every mode converts it into
- /// the structured edit contract the model consumes.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`. With source images, every mode converts
+ /// the edit instruction into a structured edit prompt.
/// Default Value: auto ///
[global::System.Text.Json.Serialization.JsonPropertyName("magic_prompt")] @@ -42,19 +38,19 @@ public sealed partial class GenerateImageIdeogram45Request public global::System.Collections.Generic.IList? ImageAssetIdentifiers { get; set; } /// - /// The source images to transform (max 5, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 5, max 25MB each; JPEG, PNG, or WEBP). The first image is the one being edited; any others are extra references. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("images")] public global::System.Collections.Generic.IList? Images { get; set; } /// - /// An optional mask confining the edit to part of the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as the first source image, and must contain both black and white areas. Requires source images uploaded as raw `images` bytes; masks cannot be combined with `image_asset_identifiers`. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three other source images. Supplying a mask fixes the output to the first source's own size, so `size` is rejected alongside it. + /// An optional mask that limits the edit to part of the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the first source image and contain both black and white areas. A masked request can include at most three other source images. With a mask, the output is always the first source image's own size, so `size` cannot be set. /// [global::System.Text.Json.Serialization.JsonPropertyName("mask")] public byte[]? Mask { get; set; } /// - /// An optional mask confining the edit to part of the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as the first source image, and must contain both black and white areas. Requires source images uploaded as raw `images` bytes; masks cannot be combined with `image_asset_identifiers`. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three other source images. Supplying a mask fixes the output to the first source's own size, so `size` is rejected alongside it. + /// An optional mask that limits the edit to part of the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the first source image and contain both black and white areas. A masked request can include at most three other source images. With a mask, the output is always the first source image's own size, so `size` cannot be set. /// [global::System.Text.Json.Serialization.JsonPropertyName("maskname")] public string? Maskname { get; set; } @@ -63,19 +59,17 @@ public sealed partial class GenerateImageIdeogram45Request /// The output size: "auto", "source" or an exact "WIDTHxHEIGHT".
/// Without source images, an exact size must be one of the supported
/// 1K/2K presets (for example 1024x1024, 2048x2048 or 1440x2880);
- /// "auto" or omitted lets the server pick a supported size based on
- /// the prompt. "source" is rejected because there is no source image
- /// to size from.
- /// With source images, "auto" (the default) lets the server pick a
- /// supported 2K size from the source images and the prompt, and
- /// "source" returns the output at the first source image's own width
- /// and height. With "source", a source too large for the model is
- /// scaled down to fit while keeping its exact proportion. Whatever the
- /// size, every source image's aspect ratio must be between 1:6 and
- /// 6:1; the model does not accept a reference outside that range.
- /// An exact size must have both dimensions multiples of 32 and at least
- /// 256px, the total size at most 2048x2048 pixels, and the aspect ratio
- /// at most 6:1. Naming one reshapes the source to it.
+ /// "auto" or omitted picks a supported size based on the prompt.
+ /// "source" is rejected.
+ /// With source images, "auto" (the default) picks a supported 2K size
+ /// based on the source images and the prompt, and "source" returns the
+ /// output at the first source image's own width and height (scaled
+ /// down, keeping its proportions, if it is too large for the model).
+ /// Every source image's aspect ratio must be between 1:6 and 6:1.
+ /// An exact size must have both sides a multiple of 32 and at least
+ /// 256px, a total of at most 2048x2048 pixels, and an aspect ratio of
+ /// at most 6:1. With source images, an exact size reshapes the source
+ /// to it.
/// Pricing is tiered by the resolved output pixels: up to 1024x1024
/// bills as 1K, above that as 2K. An "auto" size bills as 2K.
/// Default Value: auto
@@ -86,7 +80,7 @@ public sealed partial class GenerateImageIdeogram45Request public string? Size { get; set; } /// - /// The rendering quality to use. Higher quality renders take longer. With source images it defaults to `medium`, and `high` takes longer and is priced higher; `very_low` requires source images and is the fastest and cheapest. Without source images it defaults to `high`. + /// The rendering quality to use. Higher quality takes longer and costs more. Defaults to `medium` with source images and `high` without. `very_low`, the fastest and cheapest, requires source images. /// [global::System.Text.Json.Serialization.JsonPropertyName("quality")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.GenerateImageIdeogram45RequestQualityJsonConverter))] @@ -108,13 +102,13 @@ public sealed partial class GenerateImageIdeogram45Request public int? NumImages { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -157,58 +151,53 @@ public sealed partial class GenerateImageIdeogram45Request /// Initializes a new instance of the class. /// /// - /// The prompt to generate images from, or the edit instruction to
- /// apply when source images are supplied. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. + /// The prompt to generate images from, or the edit instruction when
+ /// source images are supplied. Natural language or a structured
+ /// Ideogram 4.0 JSON prompt. /// /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`. With source images the
- /// prompt is an edit instruction, and every mode converts it into
- /// the structured edit contract the model consumes.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`. With source images, every mode converts
+ /// the edit instruction into a structured edit prompt.
/// Default Value: auto /// /// /// Existing upload or generated image assets to transform, by reference. Takes priority over `images` if both are supplied. The first source is the primary image; any further sources are additional references. Supplying sources turns the request into an image-to-image transform. /// /// - /// The source images to transform (max 5, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 5, max 25MB each; JPEG, PNG, or WEBP). The first image is the one being edited; any others are extra references. Multipart requests only. /// /// - /// An optional mask confining the edit to part of the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as the first source image, and must contain both black and white areas. Requires source images uploaded as raw `images` bytes; masks cannot be combined with `image_asset_identifiers`. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three other source images. Supplying a mask fixes the output to the first source's own size, so `size` is rejected alongside it. + /// An optional mask that limits the edit to part of the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the first source image and contain both black and white areas. A masked request can include at most three other source images. With a mask, the output is always the first source image's own size, so `size` cannot be set. /// /// - /// An optional mask confining the edit to part of the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as the first source image, and must contain both black and white areas. Requires source images uploaded as raw `images` bytes; masks cannot be combined with `image_asset_identifiers`. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three other source images. Supplying a mask fixes the output to the first source's own size, so `size` is rejected alongside it. + /// An optional mask that limits the edit to part of the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the first source image and contain both black and white areas. A masked request can include at most three other source images. With a mask, the output is always the first source image's own size, so `size` cannot be set. /// /// /// The output size: "auto", "source" or an exact "WIDTHxHEIGHT".
/// Without source images, an exact size must be one of the supported
/// 1K/2K presets (for example 1024x1024, 2048x2048 or 1440x2880);
- /// "auto" or omitted lets the server pick a supported size based on
- /// the prompt. "source" is rejected because there is no source image
- /// to size from.
- /// With source images, "auto" (the default) lets the server pick a
- /// supported 2K size from the source images and the prompt, and
- /// "source" returns the output at the first source image's own width
- /// and height. With "source", a source too large for the model is
- /// scaled down to fit while keeping its exact proportion. Whatever the
- /// size, every source image's aspect ratio must be between 1:6 and
- /// 6:1; the model does not accept a reference outside that range.
- /// An exact size must have both dimensions multiples of 32 and at least
- /// 256px, the total size at most 2048x2048 pixels, and the aspect ratio
- /// at most 6:1. Naming one reshapes the source to it.
+ /// "auto" or omitted picks a supported size based on the prompt.
+ /// "source" is rejected.
+ /// With source images, "auto" (the default) picks a supported 2K size
+ /// based on the source images and the prompt, and "source" returns the
+ /// output at the first source image's own width and height (scaled
+ /// down, keeping its proportions, if it is too large for the model).
+ /// Every source image's aspect ratio must be between 1:6 and 6:1.
+ /// An exact size must have both sides a multiple of 32 and at least
+ /// 256px, a total of at most 2048x2048 pixels, and an aspect ratio of
+ /// at most 6:1. With source images, an exact size reshapes the source
+ /// to it.
/// Pricing is tiered by the resolved output pixels: up to 1024x1024
/// bills as 1K, above that as 2K. An "auto" size bills as 2K.
/// Default Value: auto
/// Example: 2048x2048 /// /// - /// The rendering quality to use. Higher quality renders take longer. With source images it defaults to `medium`, and `high` takes longer and is priced higher; `very_low` requires source images and is the fastest and cheapest. Without source images it defaults to `high`. + /// The rendering quality to use. Higher quality takes longer and costs more. Defaults to `medium` with source images and `high` without. `very_low`, the fastest and cheapest, requires source images. /// /// /// Random seed. Set for reproducible generation.
@@ -219,10 +208,10 @@ public sealed partial class GenerateImageIdeogram45Request /// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45RequestQuality.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45RequestQuality.g.cs index 2b6d8a73..e89cb06d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45RequestQuality.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45RequestQuality.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// The rendering quality to use. Higher quality renders take longer. With source images it defaults to `medium`, and `high` takes longer and is priced higher; `very_low` requires source images and is the fastest and cheapest. Without source images it defaults to `high`. + /// The rendering quality to use. Higher quality takes longer and costs more. Defaults to `medium` with source images and `high` without. `very_low`, the fastest and cheapest, requires source images. /// public enum GenerateImageIdeogram45RequestQuality { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45Response.g.cs index 9744d0d2..c3768520 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogram45Response.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/ideogram-4-5`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageIdeogram45Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageIdeogram45Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2ARequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2ARequest.g.cs index 86f480bb..ac6393aa 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2ARequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2ARequest.g.cs @@ -66,13 +66,13 @@ public sealed partial class GenerateImageIdeogramV2ARequest public global::Ideogram.IdeogramV2StyleType? StyleType { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -144,10 +144,10 @@ public sealed partial class GenerateImageIdeogramV2ARequest /// Example: realistic /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2AResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2AResponse.g.cs index 42525368..52e2452e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2AResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2AResponse.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/ideogram-2a`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageIdeogramV2AResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageIdeogramV2AResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2Request.g.cs index 446b4c3c..ff47f820 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2Request.g.cs @@ -16,7 +16,7 @@ public sealed partial class GenerateImageIdeogramV2Request public required string Prompt { get; set; } /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// [global::System.Text.Json.Serialization.JsonPropertyName("negative_prompt")] public string? NegativePrompt { get; set; } @@ -72,13 +72,13 @@ public sealed partial class GenerateImageIdeogramV2Request public global::Ideogram.IdeogramV2StyleType? StyleType { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -124,7 +124,7 @@ public sealed partial class GenerateImageIdeogramV2Request /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -153,10 +153,10 @@ public sealed partial class GenerateImageIdeogramV2Request /// Example: realistic /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2Response.g.cs index 0a5db19e..ca50dd4a 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV2Response.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/ideogram-2`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageIdeogramV2Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageIdeogramV2Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CharacterRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CharacterRequest.g.cs index 0ba3be81..2736ec3d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CharacterRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CharacterRequest.g.cs @@ -4,11 +4,10 @@ namespace Ideogram { /// - /// Supply the character as a saved character collection, as asset
- /// identifiers, or (multipart requests only) as raw image bytes. Exactly
- /// one character is supported per request; if more than one form is
- /// given, the collection is used over the identifiers, and the
- /// identifiers over the bytes. + /// Upload one character reference per request as
+ /// `character_reference_images`. Style references can be
+ /// added only on accounts with access; otherwise combining them with a
+ /// character returns a 400. ///
public sealed partial class GenerateImageIdeogramV3CharacterRequest { @@ -20,19 +19,19 @@ public sealed partial class GenerateImageIdeogramV3CharacterRequest public required string Prompt { get; set; } /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// [global::System.Text.Json.Serialization.JsonPropertyName("negative_prompt")] public string? NegativePrompt { get; set; } /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// [global::System.Text.Json.Serialization.JsonPropertyName("character_reference_collection_id")] public string? CharacterReferenceCollectionId { get; set; } /// - /// Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved character in `character_reference_collection_id`. Ignored without it. /// [global::System.Text.Json.Serialization.JsonPropertyName("character_reference_collection_version_id")] public string? CharacterReferenceCollectionVersionId { get; set; } @@ -44,19 +43,19 @@ public sealed partial class GenerateImageIdeogramV3CharacterRequest public global::System.Collections.Generic.IList? CharacterReferenceAssetIdentifiers { get; set; } /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image of the character to feature (max 25MB; JPEG, PNG, or WEBP). /// [global::System.Text.Json.Serialization.JsonPropertyName("character_reference_images")] public global::System.Collections.Generic.IList? CharacterReferenceImages { get; set; } /// - /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. + /// Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("character_reference_mask")] public byte[]? CharacterReferenceMask { get; set; } /// - /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. + /// Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("character_reference_maskname")] public string? CharacterReferenceMaskname { get; set; } @@ -120,13 +119,13 @@ public sealed partial class GenerateImageIdeogramV3CharacterRequest public global::Ideogram.GenerateImageIdeogramV3CharacterRequestStyleType? StyleType { get; set; } /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_id")] public string? StyleReferenceCollectionId { get; set; } /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_version_id")] public string? StyleReferenceCollectionVersionId { get; set; } @@ -138,19 +137,19 @@ public sealed partial class GenerateImageIdeogramV3CharacterRequest public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_images")] public global::System.Collections.Generic.IList? StyleReferenceImages { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -196,25 +195,25 @@ public sealed partial class GenerateImageIdeogramV3CharacterRequest /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved character in `character_reference_collection_id`. Ignored without it. /// /// /// An existing upload or generated image asset to use as the character reference, by reference. Takes priority over `character_reference_images` if both are supplied. /// /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image of the character to feature (max 25MB; JPEG, PNG, or WEBP). /// /// - /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. + /// Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. + /// Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only. /// /// /// Random seed. Set for reproducible generation.
@@ -247,22 +246,22 @@ public sealed partial class GenerateImageIdeogramV3CharacterRequest /// Default Value: auto /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// /// /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CharacterResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CharacterResponse.g.cs index 868532eb..d81cecfc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CharacterResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CharacterResponse.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/ideogram-3-character`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageIdeogramV3CharacterResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageIdeogramV3CharacterResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelRequest.g.cs index c0102d13..aef49627 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelRequest.g.cs @@ -16,7 +16,7 @@ public sealed partial class GenerateImageIdeogramV3CustomModelRequest public required string Prompt { get; set; } /// - /// The custom model URI returned by the custom-model API, in the form `model/<model_name>/version/<version_name>`. The authenticated user or organization must have access to the model.
+ /// The custom model URI, in the form `model/<model_name>/version/<version_name>`. You or your organization must have access to the model. The model determines which rendering speeds are supported and whether backgrounds are removed automatically.
/// Example: model/my-custom-model/version/1 ///
/// model/my-custom-model/version/1 @@ -25,7 +25,7 @@ public sealed partial class GenerateImageIdeogramV3CustomModelRequest public required string CustomModelUri { get; set; } /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// [global::System.Text.Json.Serialization.JsonPropertyName("negative_prompt")] public string? NegativePrompt { get; set; } @@ -58,7 +58,7 @@ public sealed partial class GenerateImageIdeogramV3CustomModelRequest public global::Ideogram.IdeogramV3AspectRatio? AspectRatio { get; set; } /// - /// The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model. + /// The rendering speed to use. When omitted, a speed supported by the custom model is used. /// [global::System.Text.Json.Serialization.JsonPropertyName("rendering_speed")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.GenerateImageIdeogramV3CustomModelRequestRenderingSpeedJsonConverter))] @@ -108,19 +108,19 @@ public sealed partial class GenerateImageIdeogramV3CustomModelRequest public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only. Cannot be combined with `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_images")] public global::System.Collections.Generic.IList? StyleReferenceImages { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -166,11 +166,11 @@ public sealed partial class GenerateImageIdeogramV3CustomModelRequest /// The prompt to generate images from. /// /// - /// The custom model URI returned by the custom-model API, in the form `model/<model_name>/version/<version_name>`. The authenticated user or organization must have access to the model.
+ /// The custom model URI, in the form `model/<model_name>/version/<version_name>`. You or your organization must have access to the model. The model determines which rendering speeds are supported and whether backgrounds are removed automatically.
/// Example: model/my-custom-model/version/1 /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -187,7 +187,7 @@ public sealed partial class GenerateImageIdeogramV3CustomModelRequest /// it uses `1x1`. /// /// - /// The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model. + /// The rendering speed to use. When omitted, a speed supported by the custom model is used. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -211,13 +211,13 @@ public sealed partial class GenerateImageIdeogramV3CustomModelRequest /// Existing upload or generated image assets to use as style references, by reference. Cannot be combined with `style_reference_images`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only. Cannot be combined with `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelRequestRenderingSpeed.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelRequestRenderingSpeed.g.cs index 6560cbdc..8c9c0b22 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelRequestRenderingSpeed.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelRequestRenderingSpeed.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model. + /// The rendering speed to use. When omitted, a speed supported by the custom model is used. /// public enum GenerateImageIdeogramV3CustomModelRequestRenderingSpeed { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelResponse.g.cs index e3210168..1fd8afde 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3CustomModelResponse.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/ideogram-3-custom-model`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageIdeogramV3CustomModelResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageIdeogramV3CustomModelResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3Request.g.cs index 9ec07a75..e07833f2 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3Request.g.cs @@ -16,7 +16,7 @@ public sealed partial class GenerateImageIdeogramV3Request public required string Prompt { get; set; } /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// [global::System.Text.Json.Serialization.JsonPropertyName("negative_prompt")] public string? NegativePrompt { get; set; } @@ -104,13 +104,13 @@ public sealed partial class GenerateImageIdeogramV3Request public global::Ideogram.IdeogramV3StylePreset? StylePreset { get; set; } /// - /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_asset_identifiers` or `style_reference_images`. + /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_images`. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_id")] public string? StyleReferenceCollectionId { get; set; } /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_version_id")] public string? StyleReferenceCollectionVersionId { get; set; } @@ -122,19 +122,19 @@ public sealed partial class GenerateImageIdeogramV3Request public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `style_reference_collection_id` or `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_images")] public global::System.Collections.Generic.IList? StyleReferenceImages { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -180,7 +180,7 @@ public sealed partial class GenerateImageIdeogramV3Request /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -224,22 +224,22 @@ public sealed partial class GenerateImageIdeogramV3Request /// A predefined style preset to apply to the generated images. Cannot be combined with style codes or style references. /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_asset_identifiers` or `style_reference_images`. + /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_images`. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// /// /// Existing upload or generated image assets to use as style references, by reference. Cannot be combined with `style_reference_collection_id` or `style_reference_images`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `style_reference_collection_id` or `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3Response.g.cs index c1f08033..547864f3 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3Response.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/ideogram-3`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageIdeogramV3Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageIdeogramV3Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3TransparentRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3TransparentRequest.g.cs index bbfdfbcc..c2fde766 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3TransparentRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3TransparentRequest.g.cs @@ -16,7 +16,7 @@ public sealed partial class GenerateImageIdeogramV3TransparentRequest public required string Prompt { get; set; } /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// [global::System.Text.Json.Serialization.JsonPropertyName("negative_prompt")] public string? NegativePrompt { get; set; } @@ -71,13 +71,13 @@ public sealed partial class GenerateImageIdeogramV3TransparentRequest public int? NumImages { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -123,7 +123,7 @@ public sealed partial class GenerateImageIdeogramV3TransparentRequest /// The prompt to generate images from. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. /// /// /// Random seed. Set for reproducible generation.
@@ -152,10 +152,10 @@ public sealed partial class GenerateImageIdeogramV3TransparentRequest /// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3TransparentResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3TransparentResponse.g.cs index e807647d..85336240 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3TransparentResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV3TransparentResponse.g.cs @@ -7,17 +7,17 @@ namespace Ideogram /// Response returned by
/// `POST /v2/image/generate/ideogram-3-transparent`. Synchronous
/// requests (the default) include the generated images in `data`.
- /// Requests with `async` set to true omit `data`; poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`. The seed reports the value the request
- /// resolved to when the caller left it unset.
+ /// Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} /// public sealed partial class GenerateImageIdeogramV3TransparentResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -48,8 +48,8 @@ public sealed partial class GenerateImageIdeogramV3TransparentResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelRequest.g.cs index 46f6bb61..bea23d7f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelRequest.g.cs @@ -9,17 +9,16 @@ namespace Ideogram public sealed partial class GenerateImageIdeogramV4CustomModelRequest { /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt. ///
[global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] public required string Prompt { get; set; } /// - /// The custom model URI returned by the custom-model API, in the form `model/<model_name>/version/<version_name>`. The authenticated user or organization must have access to the model.
+ /// The custom model URI, in the form `model/<model_name>/version/<version_name>`. You or your organization must have access to the model. The model determines which rendering speeds are supported.
/// Example: model/my-custom-v4-model/version/1 ///
/// model/my-custom-v4-model/version/1 @@ -38,9 +37,8 @@ public sealed partial class GenerateImageIdeogramV4CustomModelRequest /// /// Controls how a natural-language prompt is prepared. `auto` (the
/// default) and `on` rewrite and expand the prompt before generation.
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes. A prompt that is already a
- /// valid structured JSON prompt skips magic prompt entirely unless
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
/// `magic_prompt` is `on`.
/// Default Value: auto ///
@@ -65,28 +63,28 @@ public sealed partial class GenerateImageIdeogramV4CustomModelRequest /// /// Optional. When supplied, the images are generated at this
- /// resolution. When omitted, the server picks an aspect ratio
- /// automatically based on the prompt. + /// resolution. When omitted, an aspect ratio is picked automatically
+ /// based on the prompt. ///
[global::System.Text.Json.Serialization.JsonPropertyName("resolution")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.ResolutionV4JsonConverter))] public global::Ideogram.ResolutionV4? Resolution { get; set; } /// - /// The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model. + /// The rendering speed to use. When omitted, a speed supported by the custom model is used. /// [global::System.Text.Json.Serialization.JsonPropertyName("rendering_speed")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.GenerateImageIdeogramV4CustomModelRequestRenderingSpeedJsonConverter))] public global::Ideogram.GenerateImageIdeogramV4CustomModelRequestRenderingSpeed? RenderingSpeed { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -129,13 +127,12 @@ public sealed partial class GenerateImageIdeogramV4CustomModelRequest /// Initializes a new instance of the class. /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt. /// /// - /// The custom model URI returned by the custom-model API, in the form `model/<model_name>/version/<version_name>`. The authenticated user or organization must have access to the model.
+ /// The custom model URI, in the form `model/<model_name>/version/<version_name>`. You or your organization must have access to the model. The model determines which rendering speeds are supported.
/// Example: model/my-custom-v4-model/version/1 /// /// @@ -145,9 +142,8 @@ public sealed partial class GenerateImageIdeogramV4CustomModelRequest /// /// Controls how a natural-language prompt is prepared. `auto` (the
/// default) and `on` rewrite and expand the prompt before generation.
- /// `off` keeps your wording and only converts the prompt into the
- /// structured format the model consumes. A prompt that is already a
- /// valid structured JSON prompt skips magic prompt entirely unless
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
/// `magic_prompt` is `on`.
/// Default Value: auto /// @@ -161,17 +157,17 @@ public sealed partial class GenerateImageIdeogramV4CustomModelRequest /// /// /// Optional. When supplied, the images are generated at this
- /// resolution. When omitted, the server picks an aspect ratio
- /// automatically based on the prompt. + /// resolution. When omitted, an aspect ratio is picked automatically
+ /// based on the prompt. /// /// - /// The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model. + /// The rendering speed to use. When omitted, a speed supported by the custom model is used. /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelRequestRenderingSpeed.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelRequestRenderingSpeed.g.cs index e2f4dd71..713fd1b4 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelRequestRenderingSpeed.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelRequestRenderingSpeed.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model. + /// The rendering speed to use. When omitted, a speed supported by the custom model is used. /// public enum GenerateImageIdeogramV4CustomModelRequestRenderingSpeed { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelResponse.g.cs index 5b033853..ec76f901 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4CustomModelResponse.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/ideogram-4-custom-model`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageIdeogramV4CustomModelResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageIdeogramV4CustomModelResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4Request.g.cs index 3af1cc5a..f3d16d99 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4Request.g.cs @@ -9,10 +9,9 @@ namespace Ideogram public sealed partial class GenerateImageIdeogramV4Request { /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt. ///
[global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -20,11 +19,10 @@ public sealed partial class GenerateImageIdeogramV4Request /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`.
/// Default Value: auto ///
[global::System.Text.Json.Serialization.JsonPropertyName("magic_prompt")] @@ -48,8 +46,8 @@ public sealed partial class GenerateImageIdeogramV4Request /// /// Optional. When supplied, the images are generated at this
- /// resolution. When omitted, the server picks an aspect ratio
- /// automatically based on the prompt. + /// resolution. When omitted, an aspect ratio is picked automatically
+ /// based on the prompt. ///
[global::System.Text.Json.Serialization.JsonPropertyName("resolution")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.ResolutionV4JsonConverter))] @@ -64,13 +62,13 @@ public sealed partial class GenerateImageIdeogramV4Request public global::Ideogram.GenerateImageIdeogramV4RequestRenderingSpeed? RenderingSpeed { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -113,18 +111,16 @@ public sealed partial class GenerateImageIdeogramV4Request /// Initializes a new instance of the class. /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt. /// /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`.
/// Default Value: auto /// /// @@ -137,18 +133,18 @@ public sealed partial class GenerateImageIdeogramV4Request /// /// /// Optional. When supplied, the images are generated at this
- /// resolution. When omitted, the server picks an aspect ratio
- /// automatically based on the prompt. + /// resolution. When omitted, an aspect ratio is picked automatically
+ /// based on the prompt. /// /// /// The rendering speed to use.
/// Default Value: default /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4Response.g.cs index bfbef8a4..c5033b90 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4Response.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/ideogram-4`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageIdeogramV4Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageIdeogramV4Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentRequest.g.cs index 7e81b6a4..6ea6cf92 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentRequest.g.cs @@ -9,12 +9,10 @@ namespace Ideogram public sealed partial class GenerateImageIdeogramV4TransparentRequest { /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt, except that its
- /// background description is replaced with a transparent-background
- /// directive. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt, except that its background
+ /// description is replaced with a transparent background. ///
[global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -22,11 +20,10 @@ public sealed partial class GenerateImageIdeogramV4TransparentRequest /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`.
/// Default Value: auto ///
[global::System.Text.Json.Serialization.JsonPropertyName("magic_prompt")] @@ -60,11 +57,11 @@ public sealed partial class GenerateImageIdeogramV4TransparentRequest public global::Ideogram.IdeogramV4AspectRatio? AspectRatio { get; set; } /// - /// The output resolution tier for the generated images. Tiers are
- /// total-pixel budgets matching a square of the named size (for
- /// example, `8k` delivers at most 8192x8192 total pixels); wide and
- /// tall aspect ratios keep the same pixel budget, so a single
- /// dimension may exceed the named size. Defaults to 1k.
+ /// The output resolution tier. Each tier is a total pixel budget equal
+ /// to a square of the named size (for example, `8k` delivers at most
+ /// 8192x8192 pixels in total). Wide and tall aspect ratios keep the
+ /// same budget, so one side may exceed the named size. Tiers above
+ /// 2k are produced by upscaling after generation. Defaults to 1k.
/// Default Value: 1k ///
[global::System.Text.Json.Serialization.JsonPropertyName("output_resolution")] @@ -80,13 +77,13 @@ public sealed partial class GenerateImageIdeogramV4TransparentRequest public global::Ideogram.GenerateImageIdeogramV4TransparentRequestRenderingSpeed? RenderingSpeed { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -129,20 +126,17 @@ public sealed partial class GenerateImageIdeogramV4TransparentRequest /// Initializes a new instance of the class. /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. A structured JSON prompt is consumed
- /// by the model directly and skips magic prompt, except that its
- /// background description is replaced with a transparent-background
- /// directive. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. A structured JSON prompt is
+ /// used as is and skips magic prompt, except that its background
+ /// description is replaced with a transparent background. /// /// /// Controls how a natural-language prompt is prepared. `auto` (the
- /// default) and `on` rewrite and expand the prompt before
- /// generation. `off` keeps your wording and only converts the prompt
- /// into the structured format the model consumes. A prompt that is
- /// already a valid structured JSON prompt skips magic prompt
- /// entirely unless `magic_prompt` is `on`.
+ /// default) and `on` rewrite and expand the prompt before generation.
+ /// `off` keeps your wording and only converts it into a structured
+ /// prompt. A valid structured JSON prompt skips magic prompt unless
+ /// `magic_prompt` is `on`.
/// Default Value: auto /// /// @@ -161,11 +155,11 @@ public sealed partial class GenerateImageIdeogramV4TransparentRequest /// Default Value: auto /// /// - /// The output resolution tier for the generated images. Tiers are
- /// total-pixel budgets matching a square of the named size (for
- /// example, `8k` delivers at most 8192x8192 total pixels); wide and
- /// tall aspect ratios keep the same pixel budget, so a single
- /// dimension may exceed the named size. Defaults to 1k.
+ /// The output resolution tier. Each tier is a total pixel budget equal
+ /// to a square of the named size (for example, `8k` delivers at most
+ /// 8192x8192 pixels in total). Wide and tall aspect ratios keep the
+ /// same budget, so one side may exceed the named size. Tiers above
+ /// 2k are produced by upscaling after generation. Defaults to 1k.
/// Default Value: 1k /// /// @@ -173,10 +167,10 @@ public sealed partial class GenerateImageIdeogramV4TransparentRequest /// Default Value: default /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentRequestOutputResolution.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentRequestOutputResolution.g.cs index 998a42c4..f74f66f4 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentRequestOutputResolution.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentRequestOutputResolution.g.cs @@ -4,11 +4,11 @@ namespace Ideogram { /// - /// The output resolution tier for the generated images. Tiers are
- /// total-pixel budgets matching a square of the named size (for
- /// example, `8k` delivers at most 8192x8192 total pixels); wide and
- /// tall aspect ratios keep the same pixel budget, so a single
- /// dimension may exceed the named size. Defaults to 1k.
+ /// The output resolution tier. Each tier is a total pixel budget equal
+ /// to a square of the named size (for example, `8k` delivers at most
+ /// 8192x8192 pixels in total). Wide and tall aspect ratios keep the
+ /// same budget, so one side may exceed the named size. Tiers above
+ /// 2k are produced by upscaling after generation. Defaults to 1k.
/// Default Value: 1k ///
public enum GenerateImageIdeogramV4TransparentRequestOutputResolution diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentResponse.g.cs index 00ca4f47..855e5389 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageIdeogramV4TransparentResponse.g.cs @@ -7,17 +7,17 @@ namespace Ideogram /// Response returned by
/// `POST /v2/image/generate/ideogram-4-transparent`. Synchronous
/// requests (the default) include the generated images in `data`.
- /// Requests with `async` set to true omit `data`; poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`. The seed reports the value the request
- /// resolved to when the caller left it unset.
+ /// Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} /// public sealed partial class GenerateImageIdeogramV4TransparentResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -48,8 +48,8 @@ public sealed partial class GenerateImageIdeogramV4TransparentResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBanana2Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBanana2Request.g.cs index 25d66524..72de557d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBanana2Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBanana2Request.g.cs @@ -4,16 +4,14 @@ namespace Ideogram { /// - /// Source images are optional. When supplied (as `image_asset_identifiers`
- /// references, or as raw `images` bytes in multipart requests), the prompt
- /// is applied to the sources as an edit; if both forms are given, the
- /// references are used and the bytes are ignored. Without source images
- /// the prompt alone drives the generation. + /// Source `images` are optional. When supplied, the prompt is applied to
+ /// them as an edit. Without source images, the output is generated from
+ /// the prompt alone. ///
public sealed partial class GenerateImageNanoBanana2Request { /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// [global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -26,7 +24,7 @@ public sealed partial class GenerateImageNanoBanana2Request public global::System.Collections.Generic.IList? ImageAssetIdentifiers { get; set; } /// - /// The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("images")] public global::System.Collections.Generic.IList? Images { get; set; } @@ -61,7 +59,7 @@ public sealed partial class GenerateImageNanoBanana2Request public int? Seed { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -104,13 +102,13 @@ public sealed partial class GenerateImageNanoBanana2Request /// Initializes a new instance of the class. /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// /// The requested output aspect ratio, for example "1:1", "16:9", or "9:16". The output is served at the closest aspect ratio the model supports, at the requested resolution tier. Defaults to "1:1". @@ -128,7 +126,7 @@ public sealed partial class GenerateImageNanoBanana2Request /// Example: 12345 /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBanana2Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBanana2Response.g.cs index ce66c9b3..64306f35 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBanana2Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBanana2Response.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/nano-banana-2`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageNanoBanana2Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageNanoBanana2Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBananaProRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBananaProRequest.g.cs index 33b64914..6dfc92b9 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBananaProRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBananaProRequest.g.cs @@ -4,16 +4,14 @@ namespace Ideogram { /// - /// Source images are optional. When supplied (as `image_asset_identifiers`
- /// references, or as raw `images` bytes in multipart requests), the prompt
- /// is applied to the sources as an edit; if both forms are given, the
- /// references are used and the bytes are ignored. Without source images
- /// the prompt alone drives the generation. + /// Source `images` are optional. When supplied, the prompt is applied to
+ /// them as an edit. Without source images, the output is generated from
+ /// the prompt alone. ///
public sealed partial class GenerateImageNanoBananaProRequest { /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// [global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -26,7 +24,7 @@ public sealed partial class GenerateImageNanoBananaProRequest public global::System.Collections.Generic.IList? ImageAssetIdentifiers { get; set; } /// - /// The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("images")] public global::System.Collections.Generic.IList? Images { get; set; } @@ -61,7 +59,7 @@ public sealed partial class GenerateImageNanoBananaProRequest public int? Seed { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -104,13 +102,13 @@ public sealed partial class GenerateImageNanoBananaProRequest /// Initializes a new instance of the class. /// /// - /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting. + /// The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written. /// /// /// Existing upload or generated image assets to edit, by reference. Takes priority over `images` if both are supplied. /// /// - /// The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// /// The requested output aspect ratio, for example "1:1", "16:9", or "9:16". The output is served at the closest aspect ratio the model supports, at the requested resolution tier. Defaults to "1:1". @@ -128,7 +126,7 @@ public sealed partial class GenerateImageNanoBananaProRequest /// Example: 12345 /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBananaProResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBananaProResponse.g.cs index 8688a1ba..d72c068e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBananaProResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageNanoBananaProResponse.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/nano-banana-pro`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageNanoBananaProResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageNanoBananaProResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramRequest.g.cs index 6a7bef0f..569d98db 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramRequest.g.cs @@ -9,9 +9,8 @@ namespace Ideogram public sealed partial class GenerateImagePImageIdeogramRequest { /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. ///
[global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -49,7 +48,7 @@ public sealed partial class GenerateImagePImageIdeogramRequest public global::Ideogram.GenerationQuality? Quality { get; set; } /// - /// The output-size tier; the server defaults to `1k` when omitted. Cannot be combined with `custom_width`/`custom_height`. + /// The output size tier. Defaults to `1k`. Cannot be combined with `custom_width`/`custom_height`. /// [global::System.Text.Json.Serialization.JsonPropertyName("resolution")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.GenerateImagePImageIdeogramRequestResolutionJsonConverter))] @@ -84,13 +83,13 @@ public sealed partial class GenerateImagePImageIdeogramRequest public int? CustomHeight { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -133,9 +132,8 @@ public sealed partial class GenerateImagePImageIdeogramRequest /// Initializes a new instance of the class. /// /// - /// The prompt to generate images from. Accepts either natural
- /// language or a structured Ideogram 4.0 JSON prompt; the server
- /// detects which was supplied. + /// The prompt to generate images from, in natural language or as a
+ /// structured Ideogram 4.0 JSON prompt. /// /// /// Controls magic prompt (automatic prompt rewriting). `off` disables magic prompt entirely. Defaults to `auto`.
@@ -154,7 +152,7 @@ public sealed partial class GenerateImagePImageIdeogramRequest /// Default Value: medium /// /// - /// The output-size tier; the server defaults to `1k` when omitted. Cannot be combined with `custom_width`/`custom_height`. + /// The output size tier. Defaults to `1k`. Cannot be combined with `custom_width`/`custom_height`. /// /// /// The output aspect ratio. Defaults to `1x1`.
@@ -175,10 +173,10 @@ public sealed partial class GenerateImagePImageIdeogramRequest /// billing behavior. /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramRequestResolution.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramRequestResolution.g.cs index 86a450c2..678207d0 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramRequestResolution.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramRequestResolution.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// The output-size tier; the server defaults to `1k` when omitted. Cannot be combined with `custom_width`/`custom_height`. + /// The output size tier. Defaults to `1k`. Cannot be combined with `custom_width`/`custom_height`. /// public enum GenerateImagePImageIdeogramRequestResolution { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramResponse.g.cs index a4759192..0d47bc2b 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImagePImageIdeogramResponse.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/p-image-ideogram`.
/// Synchronous requests (the default) include the generated images in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImagePImageIdeogramResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImagePImageIdeogramResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoRequest.g.cs index 05b108da..62915009 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoRequest.g.cs @@ -4,17 +4,14 @@ namespace Ideogram { /// - /// Source images are optional. When supplied (as `image_asset_identifiers`
- /// references, or as raw `images` bytes in multipart requests), the server
- /// picks a model that can transform them and the prompt describes the
- /// change; if both forms are given, the references are used and the bytes
- /// are ignored. `negative_prompt` and `style_reference_asset_identifiers`
- /// cannot be combined with source images. + /// Source `images` are optional. When supplied, Ideogram picks a model
+ /// that can edit them and the prompt describes the change.
+ /// `negative_prompt` cannot be combined with source images. ///
public sealed partial class GenerateImageV2AutoRequest { /// - /// The prompt to generate images from, or the instruction describing how to transform the source images when sources are supplied. + /// The prompt to generate images from or, when source images are supplied, the change to make to them. /// [global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -27,13 +24,13 @@ public sealed partial class GenerateImageV2AutoRequest public global::System.Collections.Generic.IList? ImageAssetIdentifiers { get; set; } /// - /// The source images to transform (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("images")] public global::System.Collections.Generic.IList? Images { get; set; } /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. Not every model consults it. Cannot be combined with source images. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it. Cannot be combined with source images. /// [global::System.Text.Json.Serialization.JsonPropertyName("negative_prompt")] public string? NegativePrompt { get; set; } @@ -45,7 +42,7 @@ public sealed partial class GenerateImageV2AutoRequest public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// The output aspect ratio. `auto` (the default) picks the most suitable ratio from the request. Without source images the value must be one of the supported ratio buckets (for example "16x9" or "1x1"); with source images any "WIDTHxHEIGHT" shape hint is accepted and the selected model serves the closest shape it supports. Omit `resolution` when supplying a non-`auto` value.
+ /// The output aspect ratio. `auto` (the default) picks the most suitable ratio for the request. Without source images the value must be a supported ratio (for example "16x9" or "1x1"); with source images any "WIDTHxHEIGHT" value is accepted and the output uses the closest supported shape. Omit `resolution` when supplying a non-`auto` value.
/// Default Value: auto ///
[global::System.Text.Json.Serialization.JsonPropertyName("aspect_ratio")] @@ -58,7 +55,7 @@ public sealed partial class GenerateImageV2AutoRequest public string? Resolution { get; set; } /// - /// The output resolution tier. Influences which model serves the request; not every model offers every tier. When omitted the server uses the selected model's default tier. + /// The output resolution tier. Affects which model serves the request, since not every model offers every tier. When omitted, the selected model's default tier is used. /// [global::System.Text.Json.Serialization.JsonPropertyName("resolution_tier")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.GenerateImageV2AutoRequestResolutionTierJsonConverter))] @@ -106,7 +103,7 @@ public sealed partial class GenerateImageV2AutoRequest public string? CategoryId { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -122,29 +119,29 @@ public sealed partial class GenerateImageV2AutoRequest /// Initializes a new instance of the class. /// /// - /// The prompt to generate images from, or the instruction describing how to transform the source images when sources are supplied. + /// The prompt to generate images from or, when source images are supplied, the change to make to them. /// /// /// Existing upload or generated image assets to transform, by reference. Takes priority over `images` if both are supplied. Supplying sources turns the request into a transform. /// /// - /// The source images to transform (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied. + /// Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. Not every model consults it. Cannot be combined with source images. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it. Cannot be combined with source images. /// /// /// Existing upload or generated image assets whose style should guide the generation, by reference. Cannot be combined with source images. /// /// - /// The output aspect ratio. `auto` (the default) picks the most suitable ratio from the request. Without source images the value must be one of the supported ratio buckets (for example "16x9" or "1x1"); with source images any "WIDTHxHEIGHT" shape hint is accepted and the selected model serves the closest shape it supports. Omit `resolution` when supplying a non-`auto` value.
+ /// The output aspect ratio. `auto` (the default) picks the most suitable ratio for the request. Without source images the value must be a supported ratio (for example "16x9" or "1x1"); with source images any "WIDTHxHEIGHT" value is accepted and the output uses the closest supported shape. Omit `resolution` when supplying a non-`auto` value.
/// Default Value: auto /// /// /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output is served at the closest resolution the selected model supports. Omit `aspect_ratio` (or leave it `auto`) when supplying a resolution. /// /// - /// The output resolution tier. Influences which model serves the request; not every model offers every tier. When omitted the server uses the selected model's default tier. + /// The output resolution tier. Affects which model serves the request, since not every model offers every tier. When omitted, the selected model's default tier is used. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -168,7 +165,7 @@ public sealed partial class GenerateImageV2AutoRequest /// The internal generation category to attribute to the output, as a URL-safe base64 UUID without padding. Only applies when source images are supplied. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// #if NET7_0_OR_GREATER diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoRequestResolutionTier.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoRequestResolutionTier.g.cs index 9391b291..20033d7a 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoRequestResolutionTier.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoRequestResolutionTier.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// The output resolution tier. Influences which model serves the request; not every model offers every tier. When omitted the server uses the selected model's default tier. + /// The output resolution tier. Affects which model serves the request, since not every model offers every tier. When omitted, the selected model's default tier is used. /// public enum GenerateImageV2AutoRequestResolutionTier { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoResponse.g.cs index d81643b7..d968a619 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageV2AutoResponse.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/auto`. Synchronous
/// requests (the default) include the generated images in `data`.
- /// Requests with `async` set to true omit `data`; poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`. The seed reports the value the request
- /// resolved to when the caller left it unset.
+ /// Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageV2AutoResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageV2AutoResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageZImageRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageZImageRequest.g.cs index 9d6cad6a..90a40894 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageZImageRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageZImageRequest.g.cs @@ -26,8 +26,8 @@ public sealed partial class GenerateImageZImageRequest public string? Resolution { get; set; } /// - /// Optional diffusion step count. When omitted, the server uses the
- /// model's default. Higher values trade latency for quality.
+ /// Optional number of diffusion steps. When omitted, the model's
+ /// default is used. Higher values improve quality but take longer.
/// Example: 8 ///
/// 8 @@ -50,7 +50,7 @@ public sealed partial class GenerateImageZImageRequest public int? NumImages { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -101,8 +101,8 @@ public sealed partial class GenerateImageZImageRequest /// Example: 1024x1024 /// /// - /// Optional diffusion step count. When omitted, the server uses the
- /// model's default. Higher values trade latency for quality.
+ /// Optional number of diffusion steps. When omitted, the model's
+ /// default is used. Higher values improve quality but take longer.
/// Example: 8 /// /// @@ -114,7 +114,7 @@ public sealed partial class GenerateImageZImageRequest /// Default Value: 1 /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageZImageResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageZImageResponse.g.cs index e18223b3..320d2ffc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageZImageResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageZImageResponse.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/generate/z-image`. Synchronous
/// requests (the default) include the generated images in `data`.
- /// Requests with `async` set to true omit `data`; poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`. The seed reports the value the request
- /// resolved to when the caller left it unset.
+ /// Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class GenerateImageZImageResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class GenerateImageZImageResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoKlingV3Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoKlingV3Response.g.cs index 863090f6..58468ed4 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoKlingV3Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoKlingV3Response.g.cs @@ -4,18 +4,17 @@ namespace Ideogram { /// - /// Acknowledgement returned by the Kling v3 video generation endpoints.
- /// Video generation always runs asynchronously, so the generated video is
- /// never part of this response: poll for it with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`, or receive it at the `webhook_url` you supplied.
+ /// Acknowledgement that the request was accepted. The generated video is not
+ /// part of this response: poll `GET /v2/generations/{generation_id}` with
+ /// the returned `generation_id`, or receive it at your `webhook_url`.
+ /// Video links expire after a limited time, so download any video you
+ /// want to keep.
/// Example: {"generation_id":"generation_id","created":"2000-01-23T04:56:07\u002B00:00"} ///
public sealed partial class GenerateVideoKlingV3Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -38,8 +37,7 @@ public sealed partial class GenerateVideoKlingV3Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// The time the request was accepted. diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoKlingV3StandardImageToVideoRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoKlingV3StandardImageToVideoRequest.g.cs index 69f36d35..9fa65658 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoKlingV3StandardImageToVideoRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoKlingV3StandardImageToVideoRequest.g.cs @@ -4,12 +4,10 @@ namespace Ideogram { /// - /// Request body for Kling v3 Standard image-to-video generation. Supply the
- /// first frame either as an `image_asset_identifier` reference or
- /// (multipart requests only) as raw `image` bytes. Exactly one source is
- /// required. An optional final frame may be supplied the same way, with
- /// `end_image_asset_identifier` or `end_image`, to generate a transition
- /// between the two stills. + /// Request body for Kling v3 Standard image-to-video generation.
+ /// Upload the first frame as `image`, and optionally a final frame as
+ /// `end_image`, using `multipart/form-data`. The video takes its aspect
+ /// ratio from the first frame, so there is no `aspect_ratio` field. ///
public sealed partial class GenerateVideoKlingV3StandardImageToVideoRequest { @@ -20,13 +18,13 @@ public sealed partial class GenerateVideoKlingV3StandardImageToVideoRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -38,13 +36,13 @@ public sealed partial class GenerateVideoKlingV3StandardImageToVideoRequest public global::Ideogram.AssetIdentifier? EndImageAssetIdentifier { get; set; } /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// [global::System.Text.Json.Serialization.JsonPropertyName("end_image")] public byte[]? EndImage { get; set; } /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// [global::System.Text.Json.Serialization.JsonPropertyName("end_imagename")] public string? EndImagename { get; set; } @@ -143,19 +141,19 @@ public sealed partial class GenerateVideoKlingV3StandardImageToVideoRequest /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// Description of what to keep out of the video. Descriptions in the prompt take precedence over descriptions in the negative prompt. diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoMinimaxH3ImageToVideoRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoMinimaxH3ImageToVideoRequest.g.cs index 73364768..e74afffa 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoMinimaxH3ImageToVideoRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoMinimaxH3ImageToVideoRequest.g.cs @@ -4,12 +4,10 @@ namespace Ideogram { /// - /// Request body for MiniMax H3 image-to-video generation. Supply the first
- /// frame either as an `image_asset_identifier` reference or (multipart
- /// requests only) as raw `image` bytes. Exactly one source is required. An
- /// optional final frame may be supplied the same way, with
- /// `end_image_asset_identifier` or `end_image`, to generate a transition
- /// between the two stills. + /// Request body for MiniMax H3 image-to-video generation.
+ /// Upload the first frame as `image`, and optionally a final frame as
+ /// `end_image`, using `multipart/form-data`. The video takes its aspect
+ /// ratio from the first frame, so there is no `aspect_ratio` field. ///
public sealed partial class GenerateVideoMinimaxH3ImageToVideoRequest { @@ -20,13 +18,13 @@ public sealed partial class GenerateVideoMinimaxH3ImageToVideoRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -38,13 +36,13 @@ public sealed partial class GenerateVideoMinimaxH3ImageToVideoRequest public global::Ideogram.AssetIdentifier? EndImageAssetIdentifier { get; set; } /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// [global::System.Text.Json.Serialization.JsonPropertyName("end_image")] public byte[]? EndImage { get; set; } /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// [global::System.Text.Json.Serialization.JsonPropertyName("end_imagename")] public string? EndImagename { get; set; } @@ -122,19 +120,19 @@ public sealed partial class GenerateVideoMinimaxH3ImageToVideoRequest /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// The resolution tier of the generated video, spelled the way MiniMax
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoMinimaxH3Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoMinimaxH3Response.g.cs index e5de3067..32146cd5 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoMinimaxH3Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoMinimaxH3Response.g.cs @@ -4,18 +4,18 @@ namespace Ideogram { /// - /// Acknowledgement returned by the MiniMax H3 video generation endpoints.
- /// Video generation always runs asynchronously, so the generated video is
- /// never part of this response: poll for it with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`, or receive it at the `webhook_url` you supplied.
+ /// Acknowledgement that the video request was accepted. The video is not
+ /// included in this response: poll `GET /v2/generations/{generation_id}`
+ /// with the returned `generation_id`, or receive it at the `webhook_url`
+ /// you supplied. Video links expire after a limited time, so download any
+ /// video you want to keep.
/// Example: {"generation_id":"generation_id","created":"2000-01-23T04:56:07\u002B00:00"} ///
public sealed partial class GenerateVideoMinimaxH3Response { /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -39,7 +39,7 @@ public sealed partial class GenerateVideoMinimaxH3Response /// /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. /// /// /// The time the request was accepted. diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25ImageToVideoRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25ImageToVideoRequest.g.cs index e71ee08e..d2080bdd 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25ImageToVideoRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25ImageToVideoRequest.g.cs @@ -4,12 +4,10 @@ namespace Ideogram { /// - /// Request body for Seedance 2.5 image-to-video generation. Supply the
- /// first frame either as an `image_asset_identifier` reference or
- /// (multipart requests only) as raw `image` bytes. Exactly one source is
- /// required. An optional final frame may be supplied the same way, with
- /// `end_image_asset_identifier` or `end_image`, to generate a transition
- /// between the two stills. + /// Request body for Seedance 2.5 image-to-video generation.
+ /// Upload the first frame as `image`, and optionally a final frame as
+ /// `end_image`, using `multipart/form-data`. The video takes its aspect
+ /// ratio from the first frame, so there is no `aspect_ratio` field. ///
public sealed partial class GenerateVideoSeedDance25ImageToVideoRequest { @@ -20,13 +18,13 @@ public sealed partial class GenerateVideoSeedDance25ImageToVideoRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -38,13 +36,13 @@ public sealed partial class GenerateVideoSeedDance25ImageToVideoRequest public global::Ideogram.AssetIdentifier? EndImageAssetIdentifier { get; set; } /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// [global::System.Text.Json.Serialization.JsonPropertyName("end_image")] public byte[]? EndImage { get; set; } /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// [global::System.Text.Json.Serialization.JsonPropertyName("end_imagename")] public string? EndImagename { get; set; } @@ -127,19 +125,19 @@ public sealed partial class GenerateVideoSeedDance25ImageToVideoRequest /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// The resolution tier of the generated video.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25ReferenceToVideoRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25ReferenceToVideoRequest.g.cs index 0746bb97..53876e91 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25ReferenceToVideoRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25ReferenceToVideoRequest.g.cs @@ -4,19 +4,15 @@ namespace Ideogram { /// - /// Request body for Seedance 2.5 reference-to-video. The prompt
- /// addresses references by position — `[Image1]`,
- /// `[Video1]`, and so on. Reference images arrive either
- /// as `reference_image_asset_identifiers` or (multipart requests only) as
- /// raw `reference_images` bytes, never both. Reference videos arrive only
- /// as `reference_video_asset_identifiers`, which may reference uploaded or
- /// generated videos. At least one reference image or video is
- /// required. + /// Request body for Seedance 2.5 reference-to-video. Upload
+ /// `reference_images` (at least one is required) and optional
+ /// `reference_audios` using `multipart/form-data`. The prompt refers to
+ /// them by position: `[Image1]`, `[Audio1]`, and so on. ///
public sealed partial class GenerateVideoSeedDance25ReferenceToVideoRequest { /// - /// A natural-language prompt describing the video to produce. Reference media is addressed by position, as in "[Image1] walks toward the camera with the motion of [Video1]".
+ /// A natural-language prompt describing the video to produce. Refer to references by position, as in "[Image1] walks toward the camera".
/// Example: [Image1] walks through the snowy forest at dawn. ///
/// [Image1] walks through the snowy forest at dawn. @@ -31,7 +27,7 @@ public sealed partial class GenerateVideoSeedDance25ReferenceToVideoRequest public global::System.Collections.Generic.IList? ReferenceImageAssetIdentifiers { get; set; } /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Reference images, in prompt order. Common formats such as JPEG, PNG, and WEBP are supported, up to 50MB each. Multipart requests only. Uploaded images are used for this request only and are not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("reference_images")] public global::System.Collections.Generic.IList? ReferenceImages { get; set; } @@ -43,7 +39,7 @@ public sealed partial class GenerateVideoSeedDance25ReferenceToVideoRequest public global::System.Collections.Generic.IList? ReferenceVideoAssetIdentifiers { get; set; } /// - /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 30 seconds; combined duration must not exceed 30 seconds. At least one reference image or video is required. Audio is used for this generation only and is not saved to your library. + /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 30 seconds long, with a combined duration of at most 30 seconds. Requires at least one reference image. Audio is used for this request only and is not saved to your library. /// [global::System.Text.Json.Serialization.JsonPropertyName("reference_audios")] public global::System.Collections.Generic.IList? ReferenceAudios { get; set; } @@ -119,20 +115,20 @@ public sealed partial class GenerateVideoSeedDance25ReferenceToVideoRequest /// Initializes a new instance of the class. /// /// - /// A natural-language prompt describing the video to produce. Reference media is addressed by position, as in "[Image1] walks toward the camera with the motion of [Video1]".
+ /// A natural-language prompt describing the video to produce. Refer to references by position, as in "[Image1] walks toward the camera".
/// Example: [Image1] walks through the snowy forest at dawn. /// /// /// Images already stored with Ideogram to use as references, by reference, in prompt order. Cannot be combined with `reference_images`. Only image assets are accepted. /// /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Reference images, in prompt order. Common formats such as JPEG, PNG, and WEBP are supported, up to 50MB each. Multipart requests only. Uploaded images are used for this request only and are not stored. /// /// /// Uploaded or generated videos to use as references, by reference, in prompt order. Each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds. Upload video files first and pass their asset identifiers. /// /// - /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 30 seconds; combined duration must not exceed 30 seconds. At least one reference image or video is required. Audio is used for this generation only and is not saved to your library. + /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 30 seconds long, with a combined duration of at most 30 seconds. Requires at least one reference image. Audio is used for this request only and is not saved to your library. /// /// /// The aspect ratio of the generated video. `AUTO` lets the model choose the
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25Response.g.cs index 70fa7921..dfccb754 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance25Response.g.cs @@ -4,18 +4,17 @@ namespace Ideogram { /// - /// Acknowledgement returned by the Seedance 2.5 video generation
- /// endpoints. Video generation always runs asynchronously, so the
- /// generated video is never part of this response: poll for it with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`, or receive it at the `webhook_url` you supplied.
+ /// Acknowledgement that the request was accepted. The generated video is not
+ /// part of this response: poll `GET /v2/generations/{generation_id}` with
+ /// the returned `generation_id`, or receive it at your `webhook_url`.
+ /// Video links expire after a limited time, so download any video you
+ /// want to keep.
/// Example: {"generation_id":"generation_id","created":"2000-01-23T04:56:07\u002B00:00"} ///
public sealed partial class GenerateVideoSeedDance25Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -38,8 +37,7 @@ public sealed partial class GenerateVideoSeedDance25Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// The time the request was accepted. diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2ImageToVideoRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2ImageToVideoRequest.g.cs index 02c6fa0c..baad7754 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2ImageToVideoRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2ImageToVideoRequest.g.cs @@ -4,12 +4,9 @@ namespace Ideogram { /// - /// Request body for Seedance 2.0 image-to-video generation. Supply the
- /// first frame either as an `image_asset_identifier` reference or
- /// (multipart requests only) as raw `image` bytes. Exactly one source is
- /// required. An optional final frame may be supplied the same way, with
- /// `end_image_asset_identifier` or `end_image`, to generate a transition
- /// between the two stills. + /// Request body for Seedance 2.0 image-to-video generation.
+ /// Upload the first frame as `image`, and optionally a final frame as
+ /// `end_image`, using `multipart/form-data`. ///
public sealed partial class GenerateVideoSeedDance2ImageToVideoRequest { @@ -20,13 +17,13 @@ public sealed partial class GenerateVideoSeedDance2ImageToVideoRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -38,13 +35,13 @@ public sealed partial class GenerateVideoSeedDance2ImageToVideoRequest public global::Ideogram.AssetIdentifier? EndImageAssetIdentifier { get; set; } /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// [global::System.Text.Json.Serialization.JsonPropertyName("end_image")] public byte[]? EndImage { get; set; } /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// [global::System.Text.Json.Serialization.JsonPropertyName("end_imagename")] public string? EndImagename { get; set; } @@ -136,19 +133,19 @@ public sealed partial class GenerateVideoSeedDance2ImageToVideoRequest /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// The aspect ratio of the generated video. `AUTO` lets the model choose the
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2ReferenceToVideoRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2ReferenceToVideoRequest.g.cs index a98189df..4225d02e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2ReferenceToVideoRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2ReferenceToVideoRequest.g.cs @@ -4,19 +4,15 @@ namespace Ideogram { /// - /// Request body for Seedance 2.0 reference-to-video. The prompt
- /// addresses references by position — `@Image1`,
- /// `@Video1`, and so on. Reference images arrive either
- /// as `reference_image_asset_identifiers` or (multipart requests only) as
- /// raw `reference_images` bytes, never both. Reference videos arrive only
- /// as `reference_video_asset_identifiers`, which may reference uploaded or
- /// generated videos. At least one reference image or video is
- /// required. + /// Request body for Seedance 2.0 reference-to-video. Upload
+ /// `reference_images` (at least one is required) and optional
+ /// `reference_audios` using `multipart/form-data`. The prompt refers to
+ /// them by position: `@Image1`, `@Audio1`, and so on. ///
public sealed partial class GenerateVideoSeedDance2ReferenceToVideoRequest { /// - /// A natural-language prompt describing the video to produce. Reference media is addressed by position, as in "@Image1 walks toward the camera with the motion of @Video1".
+ /// A natural-language prompt describing the video to produce. Refer to references by position, as in "@Image1 walks toward the camera".
/// Example: @Image1 walks through the snowy forest at dawn. ///
/// @Image1 walks through the snowy forest at dawn. @@ -31,7 +27,7 @@ public sealed partial class GenerateVideoSeedDance2ReferenceToVideoRequest public global::System.Collections.Generic.IList? ReferenceImageAssetIdentifiers { get; set; } /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Reference images, in prompt order. Common formats such as JPEG, PNG, and WEBP are supported, up to 50MB each. Multipart requests only. Uploaded images are used for this request only and are not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("reference_images")] public global::System.Collections.Generic.IList? ReferenceImages { get; set; } @@ -43,7 +39,7 @@ public sealed partial class GenerateVideoSeedDance2ReferenceToVideoRequest public global::System.Collections.Generic.IList? ReferenceVideoAssetIdentifiers { get; set; } /// - /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 15 seconds; combined duration must not exceed 15 seconds. At least one reference image or video is required. Audio is used for this generation only and is not saved to your library. + /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 15 seconds long, with a combined duration of at most 15 seconds. Requires at least one reference image. Audio is used for this request only and is not saved to your library. /// [global::System.Text.Json.Serialization.JsonPropertyName("reference_audios")] public global::System.Collections.Generic.IList? ReferenceAudios { get; set; } @@ -119,20 +115,20 @@ public sealed partial class GenerateVideoSeedDance2ReferenceToVideoRequest /// Initializes a new instance of the class. /// /// - /// A natural-language prompt describing the video to produce. Reference media is addressed by position, as in "@Image1 walks toward the camera with the motion of @Video1".
+ /// A natural-language prompt describing the video to produce. Refer to references by position, as in "@Image1 walks toward the camera".
/// Example: @Image1 walks through the snowy forest at dawn. /// /// /// Images already stored with Ideogram to use as references, by reference, in prompt order. Cannot be combined with `reference_images`. Only image assets are accepted. /// /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Reference images, in prompt order. Common formats such as JPEG, PNG, and WEBP are supported, up to 50MB each. Multipart requests only. Uploaded images are used for this request only and are not stored. /// /// /// Uploaded or generated videos to use as references, by reference, in prompt order. Each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds. Upload video files first and pass their asset identifiers. /// /// - /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 15 seconds; combined duration must not exceed 15 seconds. At least one reference image or video is required. Audio is used for this generation only and is not saved to your library. + /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 15 seconds long, with a combined duration of at most 15 seconds. Requires at least one reference image. Audio is used for this request only and is not saved to your library. /// /// /// The aspect ratio of the generated video. `AUTO` lets the model choose the
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2Response.g.cs index 140c6712..c097ccac 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GenerateVideoSeedDance2Response.g.cs @@ -4,18 +4,17 @@ namespace Ideogram { /// - /// Acknowledgement returned by the Seedance 2.0 video endpoints. Video
- /// generation always runs asynchronously, so the
- /// generated videos are never part of this response: poll for them with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`, or receive them at the `webhook_url` you supplied.
+ /// Acknowledgement that the request was accepted. The generated video is not
+ /// part of this response: poll `GET /v2/generations/{generation_id}` with
+ /// the returned `generation_id`, or receive it at your `webhook_url`.
+ /// Video links expire after a limited time, so download any video you
+ /// want to keep.
/// Example: {"generation_id":"generation_id","created":"2000-01-23T04:56:07\u002B00:00"} ///
public sealed partial class GenerateVideoSeedDance2Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -38,8 +37,7 @@ public sealed partial class GenerateVideoSeedDance2Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// The time the request was accepted. diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GhostMannequinRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GhostMannequinRequest.g.cs index 3469213e..ef24cd0d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GhostMannequinRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GhostMannequinRequest.g.cs @@ -4,13 +4,9 @@ namespace Ideogram { /// - /// Supply at least one garment reference. Directional references are
- /// nullable and accept at most one of their asset-identifier or multipart
- /// image fields. Additional unlabeled references can use exactly one of
- /// `garment_asset_identifiers` or multipart `garment_images`. Every
- /// garment image must depict the same primary garment. The total number
- /// of garment references must not exceed 15, and all raw image uploads
- /// combined must not exceed 100 MB. + /// Supply at least one garment image. Every image must show the same
+ /// primary garment. At most 15 garment images are accepted in total, and all
+ /// uploads combined must not exceed 100 MB. ///
public sealed partial class GhostMannequinRequest { @@ -24,10 +20,9 @@ public sealed partial class GhostMannequinRequest public global::System.Collections.Generic.IList? GarmentAssetIdentifiers { get; set; } /// - /// Raw images of the same garment, up to 50 MB each. JPEG, PNG, WEBP,
- /// HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart
- /// requests only. Mutually exclusive with
- /// `garment_asset_identifiers`. + /// Additional photos of the same garment, up to 50 MB each. JPEG,
+ /// PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported.
+ /// Multipart requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("garment_images")] public global::System.Collections.Generic.IList? GarmentImages { get; set; } @@ -41,15 +36,15 @@ public sealed partial class GhostMannequinRequest public global::Ideogram.AssetIdentifier? FrontAssetIdentifier { get; set; } /// - /// Optional raw front-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `front_asset_identifier`. + /// Optional front-view garment photo, up to 50 MB. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("front_image")] public byte[]? FrontImage { get; set; } /// - /// Optional raw front-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `front_asset_identifier`. + /// Optional front-view garment photo, up to 50 MB. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("front_imagename")] public string? FrontImagename { get; set; } @@ -63,15 +58,15 @@ public sealed partial class GhostMannequinRequest public global::Ideogram.AssetIdentifier? BackAssetIdentifier { get; set; } /// - /// Optional raw back-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `back_asset_identifier`. + /// Optional back-view garment photo, up to 50 MB. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("back_image")] public byte[]? BackImage { get; set; } /// - /// Optional raw back-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `back_asset_identifier`. + /// Optional back-view garment photo, up to 50 MB. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("back_imagename")] public string? BackImagename { get; set; } @@ -85,15 +80,15 @@ public sealed partial class GhostMannequinRequest public global::Ideogram.AssetIdentifier? LeftAssetIdentifier { get; set; } /// - /// Optional raw left-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `left_asset_identifier`. + /// Optional left-view garment photo, up to 50 MB. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("left_image")] public byte[]? LeftImage { get; set; } /// - /// Optional raw left-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `left_asset_identifier`. + /// Optional left-view garment photo, up to 50 MB. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("left_imagename")] public string? LeftImagename { get; set; } @@ -107,15 +102,15 @@ public sealed partial class GhostMannequinRequest public global::Ideogram.AssetIdentifier? RightAssetIdentifier { get; set; } /// - /// Optional raw right-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `right_asset_identifier`. + /// Optional right-view garment photo, up to 50 MB. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("right_image")] public byte[]? RightImage { get; set; } /// - /// Optional raw right-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `right_asset_identifier`. + /// Optional right-view garment photo, up to 50 MB. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("right_imagename")] public string? RightImagename { get; set; } @@ -129,15 +124,15 @@ public sealed partial class GhostMannequinRequest public global::Ideogram.AssetIdentifier? TopAssetIdentifier { get; set; } /// - /// Optional raw top-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `top_asset_identifier`. + /// Optional top-view garment photo, up to 50 MB. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("top_image")] public byte[]? TopImage { get; set; } /// - /// Optional raw top-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `top_asset_identifier`. + /// Optional top-view garment photo, up to 50 MB. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("top_imagename")] public string? TopImagename { get; set; } @@ -151,17 +146,15 @@ public sealed partial class GhostMannequinRequest public global::Ideogram.AssetIdentifier? BottomAssetIdentifier { get; set; } /// - /// Optional raw bottom-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with
- /// `bottom_asset_identifier`. + /// Optional bottom-view garment photo, up to 50 MB. Multipart
+ /// requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("bottom_image")] public byte[]? BottomImage { get; set; } /// - /// Optional raw bottom-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with
- /// `bottom_asset_identifier`. + /// Optional bottom-view garment photo, up to 50 MB. Multipart
+ /// requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("bottom_imagename")] public string? BottomImagename { get; set; } @@ -176,8 +169,8 @@ public sealed partial class GhostMannequinRequest /// /// Optional reconstruction guidance or identity-critical garment
- /// details for the analyzer to verify. The output always uses the
- /// workflow's clean white studio presentation. + /// details to check against the photos. The output always uses a clean
+ /// white studio background. ///
[global::System.Text.Json.Serialization.JsonPropertyName("instruction")] public string? Instruction { get; set; } @@ -186,7 +179,7 @@ public sealed partial class GhostMannequinRequest /// Optional JSON object serialized as a string containing factual
/// product context, such as title, brand, category, color, material,
/// item code, and exact printed text. Metadata helps disambiguate the
- /// garment references but does not add unsupported visual features. + /// garment photos but does not add features they do not show. /// [global::System.Text.Json.Serialization.JsonPropertyName("metadata")] public string? Metadata { get; set; } @@ -258,95 +251,92 @@ public sealed partial class GhostMannequinRequest /// `garment_images`. /// /// - /// Raw images of the same garment, up to 50 MB each. JPEG, PNG, WEBP,
- /// HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart
- /// requests only. Mutually exclusive with
- /// `garment_asset_identifiers`. + /// Additional photos of the same garment, up to 50 MB each. JPEG,
+ /// PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported.
+ /// Multipart requests only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw front-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `front_asset_identifier`. + /// Optional front-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw front-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `front_asset_identifier`. + /// Optional front-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw back-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `back_asset_identifier`. + /// Optional back-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw back-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `back_asset_identifier`. + /// Optional back-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw left-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `left_asset_identifier`. + /// Optional left-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw left-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `left_asset_identifier`. + /// Optional left-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw right-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `right_asset_identifier`. + /// Optional right-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw right-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `right_asset_identifier`. + /// Optional right-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw top-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `top_asset_identifier`. + /// Optional top-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// - /// Optional raw top-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with `top_asset_identifier`. + /// Optional top-view garment photo, up to 50 MB. Multipart requests
+ /// only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Optional raw bottom-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with
- /// `bottom_asset_identifier`. + /// Optional bottom-view garment photo, up to 50 MB. Multipart
+ /// requests only. /// /// - /// Optional raw bottom-view garment reference, up to 50 MB. Multipart
- /// requests only. Mutually exclusive with
- /// `bottom_asset_identifier`. + /// Optional bottom-view garment photo, up to 50 MB. Multipart
+ /// requests only. /// /// /// Optional reconstruction guidance or identity-critical garment
- /// details for the analyzer to verify. The output always uses the
- /// workflow's clean white studio presentation. + /// details to check against the photos. The output always uses a clean
+ /// white studio background. /// /// /// Optional JSON object serialized as a string containing factual
/// product context, such as title, brand, category, color, material,
/// item code, and exact printed text. Metadata helps disambiguate the
- /// garment references but does not add unsupported visual features. + /// garment photos but does not add features they do not show. /// /// /// Output aspect ratio. Defaults to `1:1` when omitted. Supported
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.GhostMannequinResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.GhostMannequinResponse.g.cs index 5dae9c17..ec27c620 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.GhostMannequinResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.GhostMannequinResponse.g.cs @@ -4,8 +4,8 @@ namespace Ideogram { /// - /// Acknowledgement that the ghost-mannequin workflow was accepted. Poll
- /// `GET /v1/generations/{generation_id}` for status and results.
+ /// Acknowledgement that the ghost-mannequin request was accepted. Poll
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class GhostMannequinResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterRequest.g.cs index 46141610..5aeeb591 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterRequest.g.cs @@ -4,13 +4,9 @@ namespace Ideogram { /// - /// Supply the source image and the mask each as either an
- /// `AssetIdentifier` reference or (multipart requests only) raw image
- /// bytes; at least one form of each is required. Supply the character as
- /// a saved character collection, as asset identifiers, or (multipart
- /// requests only) as raw image bytes. Exactly one character is supported
- /// per request; when more than one form of an input is given, the
- /// stronger form is used as documented on each field. + /// The source `image` and its `mask` are both required and must be
+ /// uploaded in a multipart request. Upload one character reference as
+ /// `character_reference_images`. ///
public sealed partial class InpaintImageIdeogramV3CharacterRequest { @@ -30,13 +26,13 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -50,19 +46,19 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest public global::Ideogram.AssetIdentifier? MaskAssetIdentifier { get; set; } /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("mask")] public byte[]? Mask { get; set; } /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("maskname")] public string? Maskname { get; set; } /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// [global::System.Text.Json.Serialization.JsonPropertyName("character_reference_collection_id")] public string? CharacterReferenceCollectionId { get; set; } @@ -80,7 +76,7 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest public global::System.Collections.Generic.IList? CharacterReferenceAssetIdentifiers { get; set; } /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported. /// [global::System.Text.Json.Serialization.JsonPropertyName("character_reference_images")] public global::System.Collections.Generic.IList? CharacterReferenceImages { get; set; } @@ -129,7 +125,7 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest public global::Ideogram.InpaintImageIdeogramV3CharacterRequestRenderingSpeed? RenderingSpeed { get; set; } /// - /// The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references require `auto`.
+ /// The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references (not both) require `auto`. For API-key callers, combining a style with a character requires that feature to be enabled for their account.
/// Default Value: auto ///
[global::System.Text.Json.Serialization.JsonPropertyName("style_type")] @@ -145,7 +141,7 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest public global::System.Collections.Generic.IList? StyleCodes { get; set; } /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. Cannot be combined with `style_codes`. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. Cannot be combined with `style_codes`. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_id")] public string? StyleReferenceCollectionId { get; set; } @@ -163,7 +159,7 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. Cannot be combined with `style_codes`. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Cannot be combined with `style_codes`. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_images")] public global::System.Collections.Generic.IList? StyleReferenceImages { get; set; } @@ -175,7 +171,7 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -225,23 +221,23 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it. @@ -250,7 +246,7 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest /// An existing upload or generated image asset to use as the character reference, by reference. Takes priority over `character_reference_images` if both are supplied. /// /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported. /// /// /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. @@ -275,7 +271,7 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest /// Default Value: default /// /// - /// The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references require `auto`.
+ /// The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references (not both) require `auto`. For API-key callers, combining a style with a character requires that feature to be enabled for their account.
/// Default Value: auto /// /// @@ -283,7 +279,7 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest /// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. Cannot be combined with `style_codes`. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. Cannot be combined with `style_codes`. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -292,13 +288,13 @@ public sealed partial class InpaintImageIdeogramV3CharacterRequest /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. Cannot be combined with `style_codes`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. Cannot be combined with `style_codes`. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Cannot be combined with `style_codes`. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterRequestStyleType.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterRequestStyleType.g.cs index 2bff9bca..3a79ae90 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterRequestStyleType.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterRequestStyleType.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references require `auto`.
+ /// The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references (not both) require `auto`. For API-key callers, combining a style with a character requires that feature to be enabled for their account.
/// Default Value: auto ///
public enum InpaintImageIdeogramV3CharacterRequestStyleType diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterResponse.g.cs index ab703f8c..b19e1130 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CharacterResponse.g.cs @@ -7,7 +7,7 @@ namespace Ideogram /// Response returned by `POST /v2/image/inpaint/ideogram-3-character`.
/// Synchronous requests (the default) include the repainted images in
/// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
+ /// completion and results with `GET /v2/generations/{generation_id}`
/// using the returned `generation_id`. The seed, width, and height report
/// the values the request resolved to when the caller left them unset.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id","width":0,"height":6} @@ -16,7 +16,7 @@ public sealed partial class InpaintImageIdeogramV3CharacterResponse { /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -62,7 +62,7 @@ public sealed partial class InpaintImageIdeogramV3CharacterResponse /// /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CustomModelRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CustomModelRequest.g.cs index 7adc2f8c..993b8d60 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CustomModelRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CustomModelRequest.g.cs @@ -4,9 +4,8 @@ namespace Ideogram { /// - /// Supply the source image and mask as either `AssetIdentifier` references
- /// or raw bytes. At least one form of each input is required; references
- /// take priority over bytes when both are supplied. + /// The source `image` and its `mask` are both required and must be
+ /// uploaded in a multipart request. ///
public sealed partial class InpaintImageIdeogramV3CustomModelRequest { @@ -33,13 +32,13 @@ public sealed partial class InpaintImageIdeogramV3CustomModelRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to repaint (max size 25MB), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored when `image_asset_identifier` is supplied. + /// The source image to repaint (max 25MB), as JPEG, PNG, or WEBP. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to repaint (max size 25MB), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored when `image_asset_identifier` is supplied. + /// The source image to repaint (max 25MB), as JPEG, PNG, or WEBP. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -51,13 +50,13 @@ public sealed partial class InpaintImageIdeogramV3CustomModelRequest public global::Ideogram.AssetIdentifier? MaskAssetIdentifier { get; set; } /// - /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP bytes. Black marks the region to repaint. Multipart requests only; ignored when `mask_asset_identifier` is supplied. + /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP. Black marks the region to repaint. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("mask")] public byte[]? Mask { get; set; } /// - /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP bytes. Black marks the region to repaint. Multipart requests only; ignored when `mask_asset_identifier` is supplied. + /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP. Black marks the region to repaint. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("maskname")] public string? Maskname { get; set; } @@ -108,7 +107,7 @@ public sealed partial class InpaintImageIdeogramV3CustomModelRequest public global::System.Collections.Generic.IList? StyleCodes { get; set; } /// - /// A saved style, by its URL-safe base64 collection id. Takes priority over asset identifiers and raw style reference images. + /// A saved style, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_id")] public string? StyleReferenceCollectionId { get; set; } @@ -126,7 +125,7 @@ public sealed partial class InpaintImageIdeogramV3CustomModelRequest public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// Images to use as style references (max 10, max size 25MB each), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored if a collection or asset identifiers are supplied. + /// Images to use as style references (max 10, max 25MB each), as JPEG, PNG, or WEBP. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_images")] public global::System.Collections.Generic.IList? StyleReferenceImages { get; set; } @@ -138,7 +137,7 @@ public sealed partial class InpaintImageIdeogramV3CustomModelRequest public bool? EnableCopyrightDetection { get; set; } /// - /// When false, block until the images are ready. When true, return after dispatch and poll `GET /v1/generations/{generation_id}`.
+ /// When false, wait until the images are ready. When true, return as soon as the request is accepted and poll `GET /v2/generations/{generation_id}`.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -176,19 +175,19 @@ public sealed partial class InpaintImageIdeogramV3CustomModelRequest /// The source image asset to repaint. Takes priority over `image`. /// /// - /// The source image to repaint (max size 25MB), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored when `image_asset_identifier` is supplied. + /// The source image to repaint (max 25MB), as JPEG, PNG, or WEBP. Multipart requests only. /// /// - /// The source image to repaint (max size 25MB), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored when `image_asset_identifier` is supplied. + /// The source image to repaint (max 25MB), as JPEG, PNG, or WEBP. Multipart requests only. /// /// /// A black-and-white mask asset the same size as the source image. Black marks the region to repaint. Takes priority over `mask`. /// /// - /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP bytes. Black marks the region to repaint. Multipart requests only; ignored when `mask_asset_identifier` is supplied. + /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP. Black marks the region to repaint. Multipart requests only. /// /// - /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP bytes. Black marks the region to repaint. Multipart requests only; ignored when `mask_asset_identifier` is supplied. + /// A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP. Black marks the region to repaint. Multipart requests only. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -213,7 +212,7 @@ public sealed partial class InpaintImageIdeogramV3CustomModelRequest /// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// A saved style, by its URL-safe base64 collection id. Takes priority over asset identifiers and raw style reference images. + /// A saved style, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id for the saved style. Ignored without `style_reference_collection_id`. @@ -222,13 +221,13 @@ public sealed partial class InpaintImageIdeogramV3CustomModelRequest /// Existing upload or generated image assets to use as style references. Takes priority over raw style reference images. /// /// - /// Images to use as style references (max 10, max size 25MB each), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored if a collection or asset identifiers are supplied. + /// Images to use as style references (max 10, max 25MB each), as JPEG, PNG, or WEBP. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images return `is_image_safe: false`. /// /// - /// When false, block until the images are ready. When true, return after dispatch and poll `GET /v1/generations/{generation_id}`.
+ /// When false, wait until the images are ready. When true, return as soon as the request is accepted and poll `GET /v2/generations/{generation_id}`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CustomModelResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CustomModelResponse.g.cs index f5467228..4f9e7724 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CustomModelResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3CustomModelResponse.g.cs @@ -8,7 +8,7 @@ namespace Ideogram /// `POST /v2/image/inpaint/ideogram-3-custom-model`. Synchronous
/// requests include the repainted images in `data`; asynchronous requests
/// omit `data` and can be polled with
- /// `GET /v1/generations/{generation_id}`.
+ /// `GET /v2/generations/{generation_id}`.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id","width":0,"height":6} /// public sealed partial class InpaintImageIdeogramV3CustomModelResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3Request.g.cs index 290b6571..20a2daa1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3Request.g.cs @@ -4,12 +4,8 @@ namespace Ideogram { /// - /// Supply the source image and the mask each as either an
- /// `AssetIdentifier` reference or (multipart requests only) raw image
- /// bytes. At least one of `image_asset_identifier` / `image` is required,
- /// and likewise at least one of `mask_asset_identifier` / `mask`; if both
- /// a reference and bytes are given for the same input, the reference is
- /// used and the bytes are ignored. + /// The source `image` and its `mask` are both required and must be
+ /// uploaded in a multipart request. ///
public sealed partial class InpaintImageIdeogramV3Request { @@ -29,13 +25,13 @@ public sealed partial class InpaintImageIdeogramV3Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -49,13 +45,13 @@ public sealed partial class InpaintImageIdeogramV3Request public global::Ideogram.AssetIdentifier? MaskAssetIdentifier { get; set; } /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("mask")] public byte[]? Mask { get; set; } /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("maskname")] public string? Maskname { get; set; } @@ -117,7 +113,7 @@ public sealed partial class InpaintImageIdeogramV3Request public global::System.Collections.Generic.IList? StyleCodes { get; set; } /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_id")] public string? StyleReferenceCollectionId { get; set; } @@ -135,7 +131,7 @@ public sealed partial class InpaintImageIdeogramV3Request public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_images")] public global::System.Collections.Generic.IList? StyleReferenceImages { get; set; } @@ -147,7 +143,7 @@ public sealed partial class InpaintImageIdeogramV3Request public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -197,20 +193,20 @@ public sealed partial class InpaintImageIdeogramV3Request /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// - /// The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.
@@ -241,7 +237,7 @@ public sealed partial class InpaintImageIdeogramV3Request /// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -250,13 +246,13 @@ public sealed partial class InpaintImageIdeogramV3Request /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3Response.g.cs index 39edae18..ccdf87d0 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.InpaintImageIdeogramV3Response.g.cs @@ -7,7 +7,7 @@ namespace Ideogram /// Response returned by `POST /v2/image/inpaint/ideogram-3`.
/// Synchronous requests (the default) include the repainted images in
/// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
+ /// completion and results with `GET /v2/generations/{generation_id}`
/// using the returned `generation_id`. The seed, width, and height report
/// the values the request resolved to when the caller left them unset.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id","width":0,"height":6} @@ -16,7 +16,7 @@ public sealed partial class InpaintImageIdeogramV3Response { /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -62,7 +62,7 @@ public sealed partial class InpaintImageIdeogramV3Response /// /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.LayerizeDesignIdeogramV3Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.LayerizeDesignIdeogramV3Request.g.cs index c11a1e16..7af5b04c 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.LayerizeDesignIdeogramV3Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.LayerizeDesignIdeogramV3Request.g.cs @@ -4,10 +4,8 @@ namespace Ideogram { /// - /// Supply the source image either as an `image_asset_identifier`
- /// reference or (multipart requests only) as raw `image` bytes. Provide
- /// exactly one of the two forms; supplying both, or neither, is rejected
- /// with a 400. + /// A request to layerize the text in one image. Upload the source image
+ /// as `image` using `multipart/form-data`. ///
public sealed partial class LayerizeDesignIdeogramV3Request { @@ -20,13 +18,13 @@ public sealed partial class LayerizeDesignIdeogramV3Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to layerize (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to layerize (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -52,7 +50,7 @@ public sealed partial class LayerizeDesignIdeogramV3Request public global::System.Collections.Generic.IList? FontCandidateFiles { get; set; } /// - /// When false (the default), the request blocks until layerization is complete and returns the result in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until layerization is complete and returns the result in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -99,10 +97,10 @@ public sealed partial class LayerizeDesignIdeogramV3Request /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to layerize (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// - /// The source image to layerize (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// /// A description of the image, used to guide text detection. When omitted, detection runs on the image alone. @@ -115,7 +113,7 @@ public sealed partial class LayerizeDesignIdeogramV3Request /// Candidate font files to make available for text style matching. Supported formats .ttf, .otf, .woff, .woff2 (max 5MB each, maximum 5 files). Multipart requests only. /// /// - /// When false (the default), the request blocks until layerization is complete and returns the result in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until layerization is complete and returns the result in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.LayerizeDesignIdeogramV3Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.LayerizeDesignIdeogramV3Response.g.cs index aff9faa5..d7754341 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.LayerizeDesignIdeogramV3Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.LayerizeDesignIdeogramV3Response.g.cs @@ -6,17 +6,17 @@ namespace Ideogram /// /// Response returned by `POST /v2/design/layerize/ideogram-3`.
/// Synchronous requests (the default) include the layerized design in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset.
+ /// `data`. Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`. `seed` is the seed that was used, including when you
+ /// did not set one.
/// Example: {"data":[{"seed":12345,"object_type":"layerized_image","resolution":"1024x1024","url":"https://openapi-generator.tech","base_image_url":"https://openapi-generator.tech","is_image_safe":true,"text_blocks":[{"role":"heading","color":"#212121","font_alternatives":["font_alternatives","font_alternatives"],"font_size":2,"font_name":"font_name","line_height":7.0614014,"x":0,"width":1,"y":6,"angle":5.637377,"text":"Hello World","alignment":"left","formatting":["bold","bold"],"height":5},{"role":"heading","color":"#212121","font_alternatives":["font_alternatives","font_alternatives"],"font_size":2,"font_name":"font_name","line_height":7.0614014,"x":0,"width":1,"y":6,"angle":5.637377,"text":"Hello World","alignment":"left","formatting":["bold","bold"],"height":5}]},{"seed":12345,"object_type":"layerized_image","resolution":"1024x1024","url":"https://openapi-generator.tech","base_image_url":"https://openapi-generator.tech","is_image_safe":true,"text_blocks":[{"role":"heading","color":"#212121","font_alternatives":["font_alternatives","font_alternatives"],"font_size":2,"font_name":"font_name","line_height":7.0614014,"x":0,"width":1,"y":6,"angle":5.637377,"text":"Hello World","alignment":"left","formatting":["bold","bold"],"height":5},{"role":"heading","color":"#212121","font_alternatives":["font_alternatives","font_alternatives"],"font_size":2,"font_name":"font_name","line_height":7.0614014,"x":0,"width":1,"y":6,"angle":5.637377,"text":"Hello World","alignment":"left","formatting":["bold","bold"],"height":5}]}],"seed":12345,"generation_id":"generation_id"} ///
public sealed partial class LayerizeDesignIdeogramV3Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,8 +47,8 @@ public sealed partial class LayerizeDesignIdeogramV3Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageQuality.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageQuality.g.cs new file mode 100644 index 00000000..67230712 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageQuality.g.cs @@ -0,0 +1,52 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// The output resolution tier. `standard` renders at 768P; `high` renders at 2K. Higher tiers cost more.
+ /// Default Value: standard + ///
+ public enum LivingImageQuality + { + /// + /// + /// + High, + /// + /// + /// + Standard, + } + + /// + /// Enum extensions to do fast conversions without the reflection. + /// + public static class LivingImageQualityExtensions + { + /// + /// Converts an enum to a string. + /// + public static string ToValueString(this LivingImageQuality value) + { + return value switch + { + LivingImageQuality.High => "high", + LivingImageQuality.Standard => "standard", + _ => throw new global::System.ArgumentOutOfRangeException(nameof(value), value, null), + }; + } + /// + /// Converts an string to a enum. + /// + public static LivingImageQuality? ToEnum(string value) + { + return value switch + { + "high" => LivingImageQuality.High, + "standard" => LivingImageQuality.Standard, + _ => null, + }; + } + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageRequest.Json.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageRequest.Json.g.cs new file mode 100644 index 00000000..954d03be --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageRequest.Json.g.cs @@ -0,0 +1,141 @@ +#nullable enable + +namespace Ideogram +{ + public sealed partial class LivingImageRequest + { + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerContext. + /// + public string ToJson( + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Serialize( + this, + this.GetType(), + jsonSerializerContext); + } + + /// + /// Serializes the current instance to a JSON string using the generated default JsonSerializerContext. + /// + public string ToJson() + { + return ToJson(global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public string ToJson( + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return ToJson(global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.Serialize( + this, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerContext. + /// + public static global::Ideogram.LivingImageRequest? FromJson( + string json, + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + typeof(global::Ideogram.LivingImageRequest), + jsonSerializerContext) as global::Ideogram.LivingImageRequest; + } + + /// + /// Deserializes a JSON string using the generated default JsonSerializerContext. + /// + public static global::Ideogram.LivingImageRequest? FromJson( + string json) + { + return FromJson( + json, + global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public static global::Ideogram.LivingImageRequest? FromJson( + string json, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return FromJson( + json, + global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerContext. + /// + public static async global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream, + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return (await global::System.Text.Json.JsonSerializer.DeserializeAsync( + jsonStream, + typeof(global::Ideogram.LivingImageRequest), + jsonSerializerContext).ConfigureAwait(false)) as global::Ideogram.LivingImageRequest; + } + + /// + /// Deserializes a JSON stream using the generated default JsonSerializerContext. + /// + public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream) + { + return FromJsonStreamAsync( + jsonStream, + global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return FromJsonStreamAsync( + jsonStream, + global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.DeserializeAsync( + jsonStream, + jsonSerializerOptions); + } + } +} diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageRequest.g.cs new file mode 100644 index 00000000..e377e810 --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageRequest.g.cs @@ -0,0 +1,91 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// Example: {"duration":8,"target_collection_id":"target_collection_id","image_asset_identifier":{"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"},"quality":null} + /// + public sealed partial class LivingImageRequest + { + /// + /// An identifier for an ideogram asset.
+ /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} + ///
+ /// {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} + [global::System.Text.Json.Serialization.JsonPropertyName("image_asset_identifier")] + [global::System.Text.Json.Serialization.JsonRequired] + public required global::Ideogram.AssetIdentifier ImageAssetIdentifier { get; set; } + + /// + /// The output resolution tier. `standard` renders at 768P; `high` renders at 2K. Higher tiers cost more.
+ /// Default Value: standard + ///
+ [global::System.Text.Json.Serialization.JsonPropertyName("quality")] + [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.LivingImageQualityJsonConverter))] + public global::Ideogram.LivingImageQuality? Quality { get; set; } + + /// + /// The length of the generated video in seconds.
+ /// Default Value: 8
+ /// Example: 8 + ///
+ /// 8 + [global::System.Text.Json.Serialization.JsonPropertyName("duration")] + public int? Duration { get; set; } + + /// + /// A collection you can write to, by its URL-safe base64 collection id. The output video is added to it when the request completes. + /// + [global::System.Text.Json.Serialization.JsonPropertyName("target_collection_id")] + public string? TargetCollectionId { get; set; } + + /// + /// Additional properties that are not explicitly defined in the schema + /// + [global::System.Text.Json.Serialization.JsonExtensionData] + public global::System.Collections.Generic.IDictionary AdditionalProperties { get; set; } = new global::System.Collections.Generic.Dictionary(); + + /// + /// Initializes a new instance of the class. + /// + /// + /// An identifier for an ideogram asset.
+ /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} + /// + /// + /// The output resolution tier. `standard` renders at 768P; `high` renders at 2K. Higher tiers cost more.
+ /// Default Value: standard + /// + /// + /// The length of the generated video in seconds.
+ /// Default Value: 8
+ /// Example: 8 + /// + /// + /// A collection you can write to, by its URL-safe base64 collection id. The output video is added to it when the request completes. + /// +#if NET7_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] +#endif + public LivingImageRequest( + global::Ideogram.AssetIdentifier imageAssetIdentifier, + global::Ideogram.LivingImageQuality? quality, + int? duration, + string? targetCollectionId) + { + this.ImageAssetIdentifier = imageAssetIdentifier ?? throw new global::System.ArgumentNullException(nameof(imageAssetIdentifier)); + this.Quality = quality; + this.Duration = duration; + this.TargetCollectionId = targetCollectionId; + } + + /// + /// Initializes a new instance of the class. + /// + public LivingImageRequest() + { + } + + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageResponse.Json.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageResponse.Json.g.cs new file mode 100644 index 00000000..f161b69f --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageResponse.Json.g.cs @@ -0,0 +1,141 @@ +#nullable enable + +namespace Ideogram +{ + public sealed partial class LivingImageResponse + { + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerContext. + /// + public string ToJson( + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Serialize( + this, + this.GetType(), + jsonSerializerContext); + } + + /// + /// Serializes the current instance to a JSON string using the generated default JsonSerializerContext. + /// + public string ToJson() + { + return ToJson(global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Serializes the current instance to a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public string ToJson( + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return ToJson(global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.Serialize( + this, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerContext. + /// + public static global::Ideogram.LivingImageResponse? FromJson( + string json, + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + typeof(global::Ideogram.LivingImageResponse), + jsonSerializerContext) as global::Ideogram.LivingImageResponse; + } + + /// + /// Deserializes a JSON string using the generated default JsonSerializerContext. + /// + public static global::Ideogram.LivingImageResponse? FromJson( + string json) + { + return FromJson( + json, + global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Deserializes a JSON string using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public static global::Ideogram.LivingImageResponse? FromJson( + string json, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return FromJson( + json, + global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.Deserialize( + json, + jsonSerializerOptions); + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerContext. + /// + public static async global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream, + global::System.Text.Json.Serialization.JsonSerializerContext jsonSerializerContext) + { + return (await global::System.Text.Json.JsonSerializer.DeserializeAsync( + jsonStream, + typeof(global::Ideogram.LivingImageResponse), + jsonSerializerContext).ConfigureAwait(false)) as global::Ideogram.LivingImageResponse; + } + + /// + /// Deserializes a JSON stream using the generated default JsonSerializerContext. + /// + public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream) + { + return FromJsonStreamAsync( + jsonStream, + global::Ideogram.SourceGenerationContext.Default); + } + + /// + /// Deserializes a JSON stream using the provided JsonSerializerOptions. + /// +#if NET8_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")] + [global::System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")] +#endif + public static global::System.Threading.Tasks.ValueTask FromJsonStreamAsync( + global::System.IO.Stream jsonStream, + global::System.Text.Json.JsonSerializerOptions? jsonSerializerOptions = null) + { + if (jsonSerializerOptions is null) + { + return FromJsonStreamAsync( + jsonStream, + global::Ideogram.SourceGenerationContext.Default); + } + + return global::System.Text.Json.JsonSerializer.DeserializeAsync( + jsonStream, + jsonSerializerOptions); + } + } +} diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageResponse.g.cs new file mode 100644 index 00000000..fb69aa5d --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.Models.LivingImageResponse.g.cs @@ -0,0 +1,62 @@ + +#nullable enable + +namespace Ideogram +{ + /// + /// Acknowledgement that the living image was accepted. Video generation always runs asynchronously, so the video is never part of this response: poll for it with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// Example: {"generation_id":"generation_id","created":"2000-01-23T04:56:07\u002B00:00"} + ///
+ public sealed partial class LivingImageResponse + { + /// + /// URL-safe base64 ID of the accepted generation. Accepted by the
+ /// `GET /v1/generations/{generation_id}` polling endpoint. + ///
+ [global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] + [global::System.Text.Json.Serialization.JsonRequired] + public required string GenerationId { get; set; } + + /// + /// The time the request was accepted. + /// + [global::System.Text.Json.Serialization.JsonPropertyName("created")] + [global::System.Text.Json.Serialization.JsonRequired] + public required global::System.DateTime Created { get; set; } + + /// + /// Additional properties that are not explicitly defined in the schema + /// + [global::System.Text.Json.Serialization.JsonExtensionData] + public global::System.Collections.Generic.IDictionary AdditionalProperties { get; set; } = new global::System.Collections.Generic.Dictionary(); + + /// + /// Initializes a new instance of the class. + /// + /// + /// URL-safe base64 ID of the accepted generation. Accepted by the
+ /// `GET /v1/generations/{generation_id}` polling endpoint. + /// + /// + /// The time the request was accepted. + /// +#if NET7_0_OR_GREATER + [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] +#endif + public LivingImageResponse( + string generationId, + global::System.DateTime created) + { + this.GenerationId = generationId ?? throw new global::System.ArgumentNullException(nameof(generationId)); + this.Created = created; + } + + /// + /// Initializes a new instance of the class. + /// + public LivingImageResponse() + { + } + + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.LookbookResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.LookbookResponse.g.cs index 644ad88e..a9fe3c8a 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.LookbookResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.LookbookResponse.g.cs @@ -5,7 +5,7 @@ namespace Ideogram { /// /// Acknowledgement that the Lookbook workflow was accepted. Poll
- /// `GET /v1/generations/{generation_id}` for status and results.
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class LookbookResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.MaterialSwapRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.MaterialSwapRequest.g.cs index 39613fd0..3a827a66 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.MaterialSwapRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.MaterialSwapRequest.g.cs @@ -4,11 +4,9 @@ namespace Ideogram { /// - /// Supply the product photo (`image`), the masks (`masks`), and the
- /// material references (`materials`) as raw image bytes.
- /// Supply up to 4 masks, with either one material for all of them or one
- /// material per mask paired by position. A single-region edit is a
- /// one-item `masks` list with a one-item material list. + /// Upload the product photo as `image`, up to 4 `masks`, and either one
+ /// entry in `materials` for all masks or one per mask, paired by
+ /// position. For a single region, send one mask and one material. ///
public sealed partial class MaterialSwapRequest { @@ -21,15 +19,15 @@ public sealed partial class MaterialSwapRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The product photo to edit (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to edit (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. ///
[global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The product photo to edit (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to edit (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. ///
[global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -47,13 +45,11 @@ public sealed partial class MaterialSwapRequest public global::System.Collections.Generic.IList? MaskAssetIdentifiers { get; set; } /// - /// The masks marking the regions of the product photo to change (max
- /// 4, max size 25MB each), as raw bytes; only JPEG, PNG, and WEBP
- /// formats are supported. Every mask must have the same pixel
- /// dimensions as the product photo. White pixels mark the region to
- /// change; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to change and transparent
- /// pixels are preserved. + /// Masks marking the regions to change (max 4, max size 25MB each).
+ /// JPEG, PNG, and WEBP formats are supported. Every mask must have the
+ /// same pixel dimensions as the product photo. White pixels mark the
+ /// region to change and black pixels are preserved; alpha-only masks
+ /// also work (opaque = change, transparent = preserve). ///
[global::System.Text.Json.Serialization.JsonPropertyName("masks")] public global::System.Collections.Generic.IList? Masks { get; set; } @@ -69,22 +65,21 @@ public sealed partial class MaterialSwapRequest public global::System.Collections.Generic.IList? MaterialAssetIdentifiers { get; set; } /// - /// The material reference images (max size 25MB each), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Only their material
- /// — color, texture, pattern scale, and orientation — is applied to
- /// the masked regions. Send one material, which every mask takes, or
- /// exactly one per mask paired by position. + /// Material reference images (max size 25MB each). JPEG, PNG, and WEBP
+ /// formats are supported. Only their material (color, texture, pattern
+ /// scale, and orientation) is applied to the masked regions. Send one
+ /// material for every mask, or exactly one per mask, paired by
+ /// position. ///
[global::System.Text.Json.Serialization.JsonPropertyName("materials")] public global::System.Collections.Generic.IList? Materials { get; set; } /// - /// The aspect ratio of the generated image. Defaults to the aspect
- /// ratio of the product photo when omitted, which preserves the
- /// original framing exactly. When a different ratio is requested, the
- /// scene is extended to fill the new shape rather than cropped, so
- /// part of the frame is newly generated. Supported values are `1:1`,
- /// `3:4`, `4:3`, `16:9`, and `9:16`. + /// Output aspect ratio. Defaults to the product photo's aspect ratio,
+ /// which keeps the original framing. A different ratio extends the
+ /// scene to fill the new shape rather than cropping, so part of the
+ /// frame is newly generated. Supported values are `1:1`, `3:4`,
+ /// `4:3`, `16:9`, and `9:16`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("aspect_ratio")] public string? AspectRatio { get; set; } @@ -139,12 +134,12 @@ public sealed partial class MaterialSwapRequest /// `image_asset_identifier` or `image`. /// /// - /// The product photo to edit (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to edit (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// - /// The product photo to edit (max size 25MB), as raw bytes; only
- /// JPEG, PNG, and WEBP formats are supported. + /// The product photo to edit (max size 25MB). JPEG, PNG, and WEBP
+ /// formats are supported. /// /// /// The masks marking the regions of the product photo to change, by
@@ -156,13 +151,11 @@ public sealed partial class MaterialSwapRequest /// `masks`. /// /// - /// The masks marking the regions of the product photo to change (max
- /// 4, max size 25MB each), as raw bytes; only JPEG, PNG, and WEBP
- /// formats are supported. Every mask must have the same pixel
- /// dimensions as the product photo. White pixels mark the region to
- /// change; black pixels are preserved. Alpha-only masks are also
- /// supported: opaque pixels mark the region to change and transparent
- /// pixels are preserved. + /// Masks marking the regions to change (max 4, max size 25MB each).
+ /// JPEG, PNG, and WEBP formats are supported. Every mask must have the
+ /// same pixel dimensions as the product photo. White pixels mark the
+ /// region to change and black pixels are preserved; alpha-only masks
+ /// also work (opaque = change, transparent = preserve). /// /// /// The material reference images, by reference. Only their material —
@@ -172,19 +165,18 @@ public sealed partial class MaterialSwapRequest /// `material_asset_identifiers` or `materials`. /// /// - /// The material reference images (max size 25MB each), as raw bytes;
- /// only JPEG, PNG, and WEBP formats are supported. Only their material
- /// — color, texture, pattern scale, and orientation — is applied to
- /// the masked regions. Send one material, which every mask takes, or
- /// exactly one per mask paired by position. + /// Material reference images (max size 25MB each). JPEG, PNG, and WEBP
+ /// formats are supported. Only their material (color, texture, pattern
+ /// scale, and orientation) is applied to the masked regions. Send one
+ /// material for every mask, or exactly one per mask, paired by
+ /// position. /// /// - /// The aspect ratio of the generated image. Defaults to the aspect
- /// ratio of the product photo when omitted, which preserves the
- /// original framing exactly. When a different ratio is requested, the
- /// scene is extended to fill the new shape rather than cropped, so
- /// part of the frame is newly generated. Supported values are `1:1`,
- /// `3:4`, `4:3`, `16:9`, and `9:16`. + /// Output aspect ratio. Defaults to the product photo's aspect ratio,
+ /// which keeps the original framing. A different ratio extends the
+ /// scene to fill the new shape rather than cropping, so part of the
+ /// frame is newly generated. Supported values are `1:1`, `3:4`,
+ /// `4:3`, `16:9`, and `9:16`. /// /// /// The quality tier for the edit. Higher tiers may improve detail and
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.MaterialSwapResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.MaterialSwapResponse.g.cs index 9d712305..abd19937 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.MaterialSwapResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.MaterialSwapResponse.g.cs @@ -5,7 +5,7 @@ namespace Ideogram { /// /// Acknowledgement that the material swap was accepted. Poll
- /// `GET /v1/generations/{generation_id}` for status and results.
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class MaterialSwapResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ModelPoseVariantsRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ModelPoseVariantsRequest.g.cs index 4bc57d45..41540bad 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ModelPoseVariantsRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ModelPoseVariantsRequest.g.cs @@ -4,9 +4,7 @@ namespace Ideogram { /// - /// Provide exactly one of `source_asset_identifier` or `source_image`.
- /// A pose reference can supplement the required instruction but cannot
- /// replace it. The edit is full-frame; scene preservation is best effort. + /// The edit is full-frame; scene preservation is best effort. ///
public sealed partial class ModelPoseVariantsRequest { @@ -19,19 +17,17 @@ public sealed partial class ModelPoseVariantsRequest public global::Ideogram.AssetIdentifier? SourceAssetIdentifier { get; set; } /// - /// Fashion image to edit (max size 50MB), as raw bytes. JPEG, PNG,
- /// WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported.
- /// Multipart requests only. Provide exactly one of
- /// `source_asset_identifier` or `source_image`. + /// Fashion image to edit (max size 50MB). JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart
+ /// requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("source_image")] public byte[]? SourceImage { get; set; } /// - /// Fashion image to edit (max size 50MB), as raw bytes. JPEG, PNG,
- /// WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported.
- /// Multipart requests only. Provide exactly one of
- /// `source_asset_identifier` or `source_image`. + /// Fashion image to edit (max size 50MB). JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart
+ /// requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("source_imagename")] public string? SourceImagename { get; set; } @@ -45,8 +41,8 @@ public sealed partial class ModelPoseVariantsRequest public global::Ideogram.AssetIdentifier? PoseReferenceAssetIdentifier { get; set; } /// - /// Required plain-language pose or camera direction, such as a
- /// front-facing catalog stance or right-facing walking profile. + /// Plain-language pose or camera direction, such as a front-facing
+ /// catalog stance or right-facing walking profile. ///
[global::System.Text.Json.Serialization.JsonPropertyName("instruction")] [global::System.Text.Json.Serialization.JsonRequired] @@ -112,24 +108,22 @@ public sealed partial class ModelPoseVariantsRequest /// Initializes a new instance of the class. /// /// - /// Required plain-language pose or camera direction, such as a
- /// front-facing catalog stance or right-facing walking profile. + /// Plain-language pose or camera direction, such as a front-facing
+ /// catalog stance or right-facing walking profile. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Fashion image to edit (max size 50MB), as raw bytes. JPEG, PNG,
- /// WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported.
- /// Multipart requests only. Provide exactly one of
- /// `source_asset_identifier` or `source_image`. + /// Fashion image to edit (max size 50MB). JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart
+ /// requests only. /// /// - /// Fashion image to edit (max size 50MB), as raw bytes. JPEG, PNG,
- /// WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported.
- /// Multipart requests only. Provide exactly one of
- /// `source_asset_identifier` or `source_image`. + /// Fashion image to edit (max size 50MB). JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart
+ /// requests only. /// /// /// An identifier for an ideogram asset.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ModelPoseVariantsResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ModelPoseVariantsResponse.g.cs index 4ca4dc87..25014759 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ModelPoseVariantsResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ModelPoseVariantsResponse.g.cs @@ -5,7 +5,7 @@ namespace Ideogram { /// /// Acknowledgement that pose-variant generation was accepted. Poll
- /// `GET /v1/generations/{generation_id}` for status and results.
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class ModelPoseVariantsResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ModelSwapRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ModelSwapRequest.g.cs index c00572ed..ac048160 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ModelSwapRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ModelSwapRequest.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// Provide exactly one of `source_asset_identifier` or multipart `source_image`, plus one to four ordered target-model references. + /// The working image (`source_image`) plus one to four ordered target-model references. Results are full-frame edits, so exact pixel preservation is not guaranteed. /// public sealed partial class ModelSwapRequest { @@ -17,13 +17,13 @@ public sealed partial class ModelSwapRequest public global::Ideogram.AssetIdentifier? SourceAssetIdentifier { get; set; } /// - /// Raw working-image bytes. Supported formats and the 50 MB limit match the image upload API. Available only with `multipart/form-data`. + /// The working image whose product, pose, scene, lighting, framing, and camera are preserved. Supported formats and the 50 MB limit match the image upload API. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("source_image")] public byte[]? SourceImage { get; set; } /// - /// Raw working-image bytes. Supported formats and the 50 MB limit match the image upload API. Available only with `multipart/form-data`. + /// The working image whose product, pose, scene, lighting, framing, and camera are preserved. Supported formats and the 50 MB limit match the image upload API. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("source_imagename")] public string? SourceImagename { get; set; } @@ -106,10 +106,10 @@ public sealed partial class ModelSwapRequest /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw working-image bytes. Supported formats and the 50 MB limit match the image upload API. Available only with `multipart/form-data`. + /// The working image whose product, pose, scene, lighting, framing, and camera are preserved. Supported formats and the 50 MB limit match the image upload API. Multipart requests only. /// /// - /// Raw working-image bytes. Supported formats and the 50 MB limit match the image upload API. Available only with `multipart/form-data`. + /// The working image whose product, pose, scene, lighting, framing, and camera are preserved. Supported formats and the 50 MB limit match the image upload API. Multipart requests only. /// /// /// Optional identity details that are not visible in the target-model references. This cannot override the source roles described above. diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ModelSwapResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ModelSwapResponse.g.cs index 723b1f89..2b21b255 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ModelSwapResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ModelSwapResponse.g.cs @@ -4,7 +4,8 @@ namespace Ideogram { /// - /// Acknowledgement that the workflow was accepted.
+ /// Acknowledgement that the model swap was accepted. Poll
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class ModelSwapResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.PackshotsResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.PackshotsResponse.g.cs index f9d442ca..4429ba69 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.PackshotsResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.PackshotsResponse.g.cs @@ -5,7 +5,7 @@ namespace Ideogram { /// /// Acknowledgement that the packshots workflow was accepted. Poll
- /// `GET /v1/generations/{generation_id}` for status and results.
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class PackshotsResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.PreciseEditImageIdeogram45Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.PreciseEditImageIdeogram45Request.g.cs index 747789ae..bc402aaa 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.PreciseEditImageIdeogram45Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.PreciseEditImageIdeogram45Request.g.cs @@ -4,19 +4,16 @@ namespace Ideogram { /// - /// The image being edited is required, as an `image_asset_identifier`
- /// reference or as raw `image` bytes. The output is always returned at
- /// that image's exact width and height, so this request takes no output
- /// size. + /// A request to edit one image. The `image` to edit is required. The
+ /// output is always returned at that image's exact width and height, so
+ /// this request takes no output size. ///
public sealed partial class PreciseEditImageIdeogram45Request { /// - /// The edit instruction to apply to the sources. Accepts either
- /// natural language or a structured JSON prompt; the server detects
- /// which was supplied. Natural language is automatically rewritten
- /// into the model's structured edit contract, while structured JSON
- /// is consumed directly. + /// The edit instruction, in natural language or as a structured JSON
+ /// prompt. Natural language is automatically converted into a
+ /// structured prompt; valid structured JSON is used as is. ///
[global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -29,13 +26,13 @@ public sealed partial class PreciseEditImageIdeogram45Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The image to edit, as raw bytes (max size 25MB; JPEG, PNG, or WEBP only). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask`. + /// The image to edit (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it. Images too large for the model are scaled down, keeping their proportions, and returned as rendered. Images with an aspect ratio outside 1:6 to 6:1 are rejected. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The image to edit, as raw bytes (max size 25MB; JPEG, PNG, or WEBP only). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask`. + /// The image to edit (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it. Images too large for the model are scaled down, keeping their proportions, and returned as rendered. Images with an aspect ratio outside 1:6 to 6:1 are rejected. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -47,19 +44,19 @@ public sealed partial class PreciseEditImageIdeogram45Request public global::System.Collections.Generic.IList? ReferenceImageAssetIdentifiers { get; set; } /// - /// Optional additional images to guide the edit (max 4, max size 25MB each), as raw bytes; only JPEG, PNG, and WEBP formats are supported. These are never edited themselves; only `image` is. Multipart requests only; ignored if `reference_image_asset_identifiers` is also supplied. A masked request may carry at most three, because the mask occupies one of the model's reference slots. + /// Optional images to guide the edit (max 4, max 25MB each; JPEG, PNG, or WEBP). They are never edited themselves; only `image` is. Multipart requests only. A request with a `mask` can include at most three, because the mask takes up one reference slot. /// [global::System.Text.Json.Serialization.JsonPropertyName("reference_images")] public global::System.Collections.Generic.IList? ReferenceImages { get; set; } /// - /// An optional mask confining the edit to part of `image`, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as `image`, and must contain both black and white areas. Requires the image being edited to be uploaded as raw `image` bytes in the same request; masks cannot be combined with asset references. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three `reference_images`. + /// An optional mask that limits the edit to part of `image` (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. A masked request can include at most three `reference_images`. /// [global::System.Text.Json.Serialization.JsonPropertyName("mask")] public byte[]? Mask { get; set; } /// - /// An optional mask confining the edit to part of `image`, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as `image`, and must contain both black and white areas. Requires the image being edited to be uploaded as raw `image` bytes in the same request; masks cannot be combined with asset references. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three `reference_images`. + /// An optional mask that limits the edit to part of `image` (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. A masked request can include at most three `reference_images`. /// [global::System.Text.Json.Serialization.JsonPropertyName("maskname")] public string? Maskname { get; set; } @@ -88,13 +85,13 @@ public sealed partial class PreciseEditImageIdeogram45Request public int? NumImages { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -137,32 +134,30 @@ public sealed partial class PreciseEditImageIdeogram45Request /// Initializes a new instance of the class. /// /// - /// The edit instruction to apply to the sources. Accepts either
- /// natural language or a structured JSON prompt; the server detects
- /// which was supplied. Natural language is automatically rewritten
- /// into the model's structured edit contract, while structured JSON
- /// is consumed directly. + /// The edit instruction, in natural language or as a structured JSON
+ /// prompt. Natural language is automatically converted into a
+ /// structured prompt; valid structured JSON is used as is. /// /// /// The image to edit, as an existing upload or generated image asset. Supply this or `image`, never both. Takes priority over `image` if both are supplied. Cannot be combined with `mask`. /// /// - /// The image to edit, as raw bytes (max size 25MB; JPEG, PNG, or WEBP only). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask`. + /// The image to edit (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it. Images too large for the model are scaled down, keeping their proportions, and returned as rendered. Images with an aspect ratio outside 1:6 to 6:1 are rejected. /// /// - /// The image to edit, as raw bytes (max size 25MB; JPEG, PNG, or WEBP only). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask`. + /// The image to edit (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it. Images too large for the model are scaled down, keeping their proportions, and returned as rendered. Images with an aspect ratio outside 1:6 to 6:1 are rejected. /// /// /// Optional additional images to guide the edit, by reference. These are never edited themselves; only `image_asset_identifier` or `image` is. Requires the image being edited to be supplied by reference too, and cannot be combined with `mask`. /// /// - /// Optional additional images to guide the edit (max 4, max size 25MB each), as raw bytes; only JPEG, PNG, and WEBP formats are supported. These are never edited themselves; only `image` is. Multipart requests only; ignored if `reference_image_asset_identifiers` is also supplied. A masked request may carry at most three, because the mask occupies one of the model's reference slots. + /// Optional images to guide the edit (max 4, max 25MB each; JPEG, PNG, or WEBP). They are never edited themselves; only `image` is. Multipart requests only. A request with a `mask` can include at most three, because the mask takes up one reference slot. /// /// - /// An optional mask confining the edit to part of `image`, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as `image`, and must contain both black and white areas. Requires the image being edited to be uploaded as raw `image` bytes in the same request; masks cannot be combined with asset references. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three `reference_images`. + /// An optional mask that limits the edit to part of `image` (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. A masked request can include at most three `reference_images`. /// /// - /// An optional mask confining the edit to part of `image`, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as `image`, and must contain both black and white areas. Requires the image being edited to be uploaded as raw `image` bytes in the same request; masks cannot be combined with asset references. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three `reference_images`. + /// An optional mask that limits the edit to part of `image` (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. A masked request can include at most three `reference_images`. /// /// /// The rendering quality to use. `very_low` is the fastest and cheapest, and `high` takes longer and is priced higher.
@@ -177,10 +172,10 @@ public sealed partial class PreciseEditImageIdeogram45Request /// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.PreciseEditImageIdeogram45Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.PreciseEditImageIdeogram45Response.g.cs index a55499a8..5ac6c4fc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.PreciseEditImageIdeogram45Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.PreciseEditImageIdeogram45Response.g.cs @@ -6,17 +6,16 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/precise-edit/ideogram-4-5`.
/// Synchronous requests (the default) include the edited images in `data`.
- /// Requests with `async` set to true omit `data`; poll for completion and
- /// results with `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`. The seed reports the value the request resolved to
- /// when the caller left it unset.
+ /// Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":0,"generation_id":"generation_id"} ///
public sealed partial class PreciseEditImageIdeogram45Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] public string? GenerationId { get; set; } @@ -28,7 +27,7 @@ public sealed partial class PreciseEditImageIdeogram45Response public global::System.Collections.Generic.IList? Data { get; set; } /// - /// The seed the request was served with. + /// The seed that was used, including when you did not set one. /// [global::System.Text.Json.Serialization.JsonPropertyName("seed")] public int? Seed { get; set; } @@ -43,14 +42,14 @@ public sealed partial class PreciseEditImageIdeogram45Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// /// The edited images, in generation order. Present only for synchronous requests (`async` omitted or false). /// /// - /// The seed the request was served with. + /// The seed that was used, including when you did not set one. /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageIdeogramV3Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageIdeogramV3Request.g.cs index 15d0c998..44eabeab 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageIdeogramV3Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageIdeogramV3Request.g.cs @@ -4,9 +4,8 @@ namespace Ideogram { /// - /// Provide exactly one of `image_asset_identifier` or `image` for the
- /// source. Style controls are optional; when used, provide only one of
- /// `style_preset`, `style_codes`, `style_reference_asset_identifiers`, or
+ /// Upload the source `image`. Style controls are optional; when used,
+ /// supply only one of `style_preset`, `style_codes`, or
/// `style_reference_images`. ///
public sealed partial class ReframeImageIdeogramV3Request @@ -20,13 +19,13 @@ public sealed partial class ReframeImageIdeogramV3Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The JPEG, PNG, or WEBP image to reframe (max 25MB), as raw bytes. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The JPEG, PNG, or WEBP image to reframe (max 25MB), as raw bytes. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -94,7 +93,7 @@ public sealed partial class ReframeImageIdeogramV3Request public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// JPEG, PNG, or WEBP style reference images (max 10, max 25MB each), as raw bytes. Multipart requests only. Cannot be combined with a style preset, style codes, or referenced style assets. + /// JPEG, PNG, or WEBP style reference images (max 10, max 25MB each). Multipart requests only. Cannot be combined with `style_preset` or `style_codes`. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_images")] public global::System.Collections.Generic.IList? StyleReferenceImages { get; set; } @@ -124,10 +123,10 @@ public sealed partial class ReframeImageIdeogramV3Request /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The JPEG, PNG, or WEBP image to reframe (max 25MB), as raw bytes. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only. /// /// - /// The JPEG, PNG, or WEBP image to reframe (max 25MB), as raw bytes. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. + /// The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only. /// /// /// The number of images to generate.
@@ -155,7 +154,7 @@ public sealed partial class ReframeImageIdeogramV3Request /// Existing upload or generated image assets to use as style references. Cannot be combined with a style preset, style codes, or uploaded style reference images. /// /// - /// JPEG, PNG, or WEBP style reference images (max 10, max 25MB each), as raw bytes. Multipart requests only. Cannot be combined with a style preset, style codes, or referenced style assets. + /// JPEG, PNG, or WEBP style reference images (max 10, max 25MB each). Multipart requests only. Cannot be combined with `style_preset` or `style_codes`. /// /// /// Return immediately instead of waiting for reframed images.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageIdeogramV3Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageIdeogramV3Response.g.cs index 0c81083a..ef88c245 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageIdeogramV3Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageIdeogramV3Response.g.cs @@ -6,7 +6,7 @@ namespace Ideogram /// /// Synchronous requests (the default) include the reframed images in
/// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`.
+ /// completion and results with `GET /v2/generations/{generation_id}`.
/// The seed reports the value the request resolved to when the caller
/// left it unset.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} @@ -15,7 +15,7 @@ public sealed partial class ReframeImageIdeogramV3Response { /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -47,7 +47,7 @@ public sealed partial class ReframeImageIdeogramV3Response ///
/// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageNanoBanana2Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageNanoBanana2Request.g.cs index e342a59d..6ad1c745 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageNanoBanana2Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageNanoBanana2Request.g.cs @@ -4,9 +4,8 @@ namespace Ideogram { /// - /// Supply exactly one source: `image_asset_identifier` for an existing
- /// Ideogram asset, or `image` for a raw upload. Supplying both or neither
- /// is rejected with a 400. + /// Upload the source `image`. Requests without a source image are
+ /// rejected with a 400. ///
public sealed partial class ReframeImageNanoBanana2Request { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageNanoBanana2Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageNanoBanana2Response.g.cs index e575638c..a997f606 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageNanoBanana2Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageNanoBanana2Response.g.cs @@ -5,7 +5,7 @@ namespace Ideogram { /// /// Acknowledges an accepted asynchronous Reframe request. Poll
- /// `GET /v1/generations/{generation_id}` for completion and output
+ /// `GET /v2/generations/{generation_id}` for completion and output
/// images. The seed, width, and height report the values the request
/// resolved to when the caller left them unset.
/// Example: {"seed":12345,"generation_id":"generation_id","width":0,"height":6} @@ -14,7 +14,7 @@ public sealed partial class ReframeImageNanoBanana2Response { /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -54,7 +54,7 @@ public sealed partial class ReframeImageNanoBanana2Response ///
/// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CharacterRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CharacterRequest.g.cs index 7cd9a73a..6e8b4865 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CharacterRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CharacterRequest.g.cs @@ -4,11 +4,8 @@ namespace Ideogram { /// - /// Supply the character as a saved character collection, as asset
- /// identifiers, or (multipart requests only) as raw image bytes. Exactly
- /// one character is supported per request; if more than one form is
- /// given, the collection is used over the identifiers, and the
- /// identifiers over the bytes. + /// Upload one character reference as `character_reference_images` using
+ /// `multipart/form-data`. ///
public sealed partial class RemixImageIdeogramV3CharacterRequest { @@ -26,13 +23,13 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -50,7 +47,7 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest public string? NegativePrompt { get; set; } /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// [global::System.Text.Json.Serialization.JsonPropertyName("character_reference_collection_id")] public string? CharacterReferenceCollectionId { get; set; } @@ -68,7 +65,7 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest public global::System.Collections.Generic.IList? CharacterReferenceAssetIdentifiers { get; set; } /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported. /// [global::System.Text.Json.Serialization.JsonPropertyName("character_reference_images")] public global::System.Collections.Generic.IList? CharacterReferenceImages { get; set; } @@ -141,7 +138,7 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest public global::Ideogram.RemixImageIdeogramV3CharacterRequestStyleType? StyleType { get; set; } /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_id")] public string? StyleReferenceCollectionId { get; set; } @@ -159,7 +156,7 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_images")] public global::System.Collections.Generic.IList? StyleReferenceImages { get; set; } @@ -171,7 +168,7 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -220,10 +217,10 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. @@ -232,7 +229,7 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. /// /// - /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied. + /// A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it. @@ -241,7 +238,7 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest /// An existing upload or generated image asset to use as the character reference, by reference. Takes priority over `character_reference_images` if both are supplied. /// /// - /// An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied. + /// An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported. /// /// /// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`. @@ -277,7 +274,7 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest /// Default Value: auto /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. + /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -286,13 +283,13 @@ public sealed partial class RemixImageIdeogramV3CharacterRequest /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CharacterResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CharacterResponse.g.cs index 349d683d..a5146bce 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CharacterResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CharacterResponse.g.cs @@ -7,7 +7,7 @@ namespace Ideogram /// Response returned by `POST /v2/image/remix/ideogram-3-character`.
/// Synchronous requests (the default) include the remixed images in
/// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
+ /// completion and results with `GET /v2/generations/{generation_id}`
/// using the returned `generation_id`. The seed reports the value the
/// request resolved to when the caller left it unset.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} @@ -16,7 +16,7 @@ public sealed partial class RemixImageIdeogramV3CharacterResponse { /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -48,7 +48,7 @@ public sealed partial class RemixImageIdeogramV3CharacterResponse /// /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CustomModelRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CustomModelRequest.g.cs index 49d30424..91878f02 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CustomModelRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CustomModelRequest.g.cs @@ -31,13 +31,13 @@ public sealed partial class RemixImageIdeogramV3CustomModelRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -129,7 +129,7 @@ public sealed partial class RemixImageIdeogramV3CustomModelRequest public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `style_reference_asset_identifiers` is also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_images")] public global::System.Collections.Generic.IList? StyleReferenceImages { get; set; } @@ -141,7 +141,7 @@ public sealed partial class RemixImageIdeogramV3CustomModelRequest public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -194,10 +194,10 @@ public sealed partial class RemixImageIdeogramV3CustomModelRequest /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. @@ -241,13 +241,13 @@ public sealed partial class RemixImageIdeogramV3CustomModelRequest /// Existing upload or generated image assets to use as style references, by reference. Takes priority over `style_reference_images` if both are supplied. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `style_reference_asset_identifiers` is also supplied. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Multipart requests only. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CustomModelResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CustomModelResponse.g.cs index 9ecf1656..6c93d474 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CustomModelResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3CustomModelResponse.g.cs @@ -7,7 +7,7 @@ namespace Ideogram /// Response returned by `POST /v2/image/remix/ideogram-3-custom-model`.
/// Synchronous requests (the default) include the remixed images in
/// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
+ /// completion and results with `GET /v2/generations/{generation_id}`
/// using the returned `generation_id`. The seed reports the value the
/// request resolved to when the caller left it unset.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} @@ -16,7 +16,7 @@ public sealed partial class RemixImageIdeogramV3CustomModelResponse { /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -48,7 +48,7 @@ public sealed partial class RemixImageIdeogramV3CustomModelResponse /// /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3Request.g.cs index a980eca2..dc740f66 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3Request.g.cs @@ -22,13 +22,13 @@ public sealed partial class RemixImageIdeogramV3Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -125,7 +125,7 @@ public sealed partial class RemixImageIdeogramV3Request public global::Ideogram.IdeogramV3StylePreset? StylePreset { get; set; } /// - /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_asset_identifiers` or `style_reference_images`. + /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_images`. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_id")] public string? StyleReferenceCollectionId { get; set; } @@ -143,7 +143,7 @@ public sealed partial class RemixImageIdeogramV3Request public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `style_reference_collection_id` or `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_images")] public global::System.Collections.Generic.IList? StyleReferenceImages { get; set; } @@ -155,7 +155,7 @@ public sealed partial class RemixImageIdeogramV3Request public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -204,10 +204,10 @@ public sealed partial class RemixImageIdeogramV3Request /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first. /// /// /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. @@ -254,7 +254,7 @@ public sealed partial class RemixImageIdeogramV3Request /// A predefined style preset to apply to the remixed images. Cannot be combined with style codes or style references. /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_asset_identifiers` or `style_reference_images`. + /// A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_images`. /// /// /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. @@ -263,13 +263,13 @@ public sealed partial class RemixImageIdeogramV3Request /// Existing upload or generated image assets to use as style references, by reference. Cannot be combined with `style_reference_collection_id` or `style_reference_images`. /// /// - /// Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `style_reference_collection_id` or `style_reference_asset_identifiers`. + /// Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. /// /// /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3Response.g.cs index 66aab571..36db33be 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV3Response.g.cs @@ -7,7 +7,7 @@ namespace Ideogram /// Response returned by `POST /v2/image/remix/ideogram-3`.
/// Synchronous requests (the default) include the remixed images in
/// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
+ /// completion and results with `GET /v2/generations/{generation_id}`
/// using the returned `generation_id`. The seed reports the value the
/// request resolved to when the caller left it unset.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} @@ -16,7 +16,7 @@ public sealed partial class RemixImageIdeogramV3Response { /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -48,7 +48,7 @@ public sealed partial class RemixImageIdeogramV3Response /// /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV4Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV4Request.g.cs index f759f3a4..f20a56a3 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV4Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV4Request.g.cs @@ -4,12 +4,13 @@ namespace Ideogram { /// - /// + /// Remixes are not reproducible, so no `seed` is accepted; the response
+ /// reports the seed that was used. ///
public sealed partial class RemixImageIdeogramV4Request { /// - /// The prompt that guides the remix. + /// The prompt that guides the remix. It is always read as an editing instruction, so there is no `magic_prompt` option. /// [global::System.Text.Json.Serialization.JsonPropertyName("prompt")] [global::System.Text.Json.Serialization.JsonRequired] @@ -22,19 +23,19 @@ public sealed partial class RemixImageIdeogramV4Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` to keep its shape. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` to keep its shape. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } /// - /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining image_weight with a resolution whose aspect ratio differs from the source's is rejected with a 400. + /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining `image_weight` with a `resolution` whose aspect ratio differs from the source's is rejected with a 400. /// [global::System.Text.Json.Serialization.JsonPropertyName("image_weight")] public int? ImageWeight { get; set; } @@ -50,7 +51,7 @@ public sealed partial class RemixImageIdeogramV4Request /// Optional. When supplied, the images are generated at this
/// resolution. When omitted, the source image's shape is kept. A
/// resolution whose aspect ratio differs from the source's cannot
- /// be combined with image_weight. + /// be combined with `image_weight`. /// [global::System.Text.Json.Serialization.JsonPropertyName("resolution")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.ResolutionV4JsonConverter))] @@ -71,7 +72,7 @@ public sealed partial class RemixImageIdeogramV4Request public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -114,19 +115,19 @@ public sealed partial class RemixImageIdeogramV4Request /// Initializes a new instance of the class. /// /// - /// The prompt that guides the remix. + /// The prompt that guides the remix. It is always read as an editing instruction, so there is no `magic_prompt` option. /// /// /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` to keep its shape. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` to keep its shape. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image. + /// The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` to keep its shape. /// /// - /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining image_weight with a resolution whose aspect ratio differs from the source's is rejected with a 400. + /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining `image_weight` with a `resolution` whose aspect ratio differs from the source's is rejected with a 400. /// /// /// The number of images to generate.
@@ -136,7 +137,7 @@ public sealed partial class RemixImageIdeogramV4Request /// Optional. When supplied, the images are generated at this
/// resolution. When omitted, the source image's shape is kept. A
/// resolution whose aspect ratio differs from the source's cannot
- /// be combined with image_weight. + /// be combined with `image_weight`. /// /// /// The rendering speed to use.
@@ -146,7 +147,7 @@ public sealed partial class RemixImageIdeogramV4Request /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV4Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV4Response.g.cs index b954dbe1..0bb79ee3 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV4Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemixImageIdeogramV4Response.g.cs @@ -7,7 +7,7 @@ namespace Ideogram /// Response returned by `POST /v2/image/remix/ideogram-4`.
/// Synchronous requests (the default) include the remixed images in
/// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
+ /// completion and results with `GET /v2/generations/{generation_id}`
/// using the returned `generation_id`. The seed reports the value the
/// request resolved to.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id"} @@ -16,7 +16,7 @@ public sealed partial class RemixImageIdeogramV4Response { /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -48,7 +48,7 @@ public sealed partial class RemixImageIdeogramV4Response /// /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2AssetRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2AssetRequest.g.cs index ec169449..2226d51c 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2AssetRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2AssetRequest.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// JSON request shape for processing an existing upload or generated image. Raw image bytes are accepted only through multipart form data. + /// JSON request body. To upload an image, use `multipart/form-data`. /// public sealed partial class RemoveBackgroundV2AssetRequest { @@ -30,7 +30,7 @@ public sealed partial class RemoveBackgroundV2AssetRequest public bool? Private { get; set; } /// - /// Return after acceptance and poll by generation ID when true.
+ /// When true, return as soon as the request is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -56,7 +56,7 @@ public sealed partial class RemoveBackgroundV2AssetRequest /// Whether to keep the result out of the public gallery. Enterprise generations are always private. /// /// - /// Return after acceptance and poll by generation ID when true.
+ /// When true, return as soon as the request is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// #if NET7_0_OR_GREATER diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2Request.g.cs index ee46021a..25d310ba 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2Request.g.cs @@ -4,18 +4,18 @@ namespace Ideogram { /// - /// Supply exactly one image source. `image` is available only in multipart requests; `image_asset_identifier` accepts an existing upload or generated image that is readable in the active organization. + /// Upload the source `image` using `multipart/form-data`. /// public sealed partial class RemoveBackgroundV2Request { /// - /// Raw JPEG, PNG, or WebP image bytes (max 25MB). Multipart requests only. + /// The source image. JPEG, PNG, or WebP, up to 25MB. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// Raw JPEG, PNG, or WebP image bytes (max 25MB). Multipart requests only. + /// The source image. JPEG, PNG, or WebP, up to 25MB. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -36,16 +36,14 @@ public sealed partial class RemoveBackgroundV2Request /// /// Whether to keep the result out of the public gallery. When omitted,
- /// Firebase Bearer and Mini App callers inherit their plan entitlement.
- /// Enterprise generations are always private. API keys use their bound
- /// organization and otherwise default to public when no subscription
- /// entitlement is available. + /// defaults to your plan's setting, or public if your plan has none.
+ /// Enterprise generations are always private. ///
[global::System.Text.Json.Serialization.JsonPropertyName("private")] public bool? Private { get; set; } /// - /// When false (the default), wait for and return the foreground image. When true, return after acceptance and poll `GET /v1/generations/{generation_id}`.
+ /// When false (the default), wait for and return the foreground image. When true, return as soon as the request is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -61,10 +59,10 @@ public sealed partial class RemoveBackgroundV2Request /// Initializes a new instance of the class. /// /// - /// Raw JPEG, PNG, or WebP image bytes (max 25MB). Multipart requests only. + /// The source image. JPEG, PNG, or WebP, up to 25MB. Multipart requests only. /// /// - /// Raw JPEG, PNG, or WebP image bytes (max 25MB). Multipart requests only. + /// The source image. JPEG, PNG, or WebP, up to 25MB. Multipart requests only. /// /// /// An identifier for an ideogram asset.
@@ -75,13 +73,11 @@ public sealed partial class RemoveBackgroundV2Request /// /// /// Whether to keep the result out of the public gallery. When omitted,
- /// Firebase Bearer and Mini App callers inherit their plan entitlement.
- /// Enterprise generations are always private. API keys use their bound
- /// organization and otherwise default to public when no subscription
- /// entitlement is available. + /// defaults to your plan's setting, or public if your plan has none.
+ /// Enterprise generations are always private. /// /// - /// When false (the default), wait for and return the foreground image. When true, return after acceptance and poll `GET /v1/generations/{generation_id}`.
+ /// When false (the default), wait for and return the foreground image. When true, return as soon as the request is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// #if NET7_0_OR_GREATER diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2Response.g.cs index a1cf2d08..fed0d2f7 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemoveBackgroundV2Response.g.cs @@ -5,15 +5,16 @@ namespace Ideogram { /// /// Synchronous requests include exactly one foreground image in `data`.
- /// Async requests omit `data`; poll with `generation_id` for completion.
- /// A slow synchronous failure that occurs after heartbeat streaming starts
- /// contains `error` and `status_code` instead of `generation_id`.
+ /// Async requests omit `data`; poll with `generation_id` for the result.
+ /// If a synchronous request fails after the response has started
+ /// streaming, the body contains `error` and `status_code` instead of
+ /// `generation_id`.
/// Example: {"generation_id":"zm6IqQd4RPGnwA8gQYEL5Q","data":[{"url":"https://ideogram.ai/assets/foreground.png","is_image_safe":true}]} ///
public sealed partial class RemoveBackgroundV2Response { /// - /// URL-safe base64 ID accepted by the generation polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// [global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] public string? GenerationId { get; set; } @@ -25,13 +26,13 @@ public sealed partial class RemoveBackgroundV2Response public global::System.Collections.Generic.IList? Data { get; set; } /// - /// Error message for a failure after heartbeat streaming starts. + /// Error message for a failure after the response started streaming. /// [global::System.Text.Json.Serialization.JsonPropertyName("error")] public string? Error { get; set; } /// - /// HTTP status that would have been returned before streaming began. + /// The HTTP status the failure would have returned before streaming began. /// [global::System.Text.Json.Serialization.JsonPropertyName("status_code")] public int? StatusCode { get; set; } @@ -46,16 +47,16 @@ public sealed partial class RemoveBackgroundV2Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID accepted by the generation polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// The single foreground image. Present only for synchronous requests. /// /// - /// Error message for a failure after heartbeat streaming starts. + /// Error message for a failure after the response started streaming. /// /// - /// HTTP status that would have been returned before streaming began. + /// The HTTP status the failure would have returned before streaming began. /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemoveObjectFromV2AssetsRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemoveObjectFromV2AssetsRequest.g.cs index d80e008d..fec5a3bd 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemoveObjectFromV2AssetsRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemoveObjectFromV2AssetsRequest.g.cs @@ -4,11 +4,7 @@ namespace Ideogram { /// - /// Supply the source image and the mask each as either an `AssetIdentifier`
- /// reference or (multipart requests only) raw image bytes. At least one of
- /// `image_asset_identifier` / `image` is required, and likewise at least one of
- /// `mask_asset_identifier` / `mask`; if both a reference and bytes are given for
- /// the same input, the reference is used and the bytes are ignored. + /// Upload both the source `image` and the `mask` using `multipart/form-data`. ///
public sealed partial class RemoveObjectFromV2AssetsRequest { @@ -21,13 +17,13 @@ public sealed partial class RemoveObjectFromV2AssetsRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to remove an object from (max size 50MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to remove an object from. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to remove an object from (max size 50MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to remove an object from. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -41,13 +37,13 @@ public sealed partial class RemoveObjectFromV2AssetsRequest public global::Ideogram.AssetIdentifier? MaskAssetIdentifier { get; set; } /// - /// A binary mask the same size as the image (max size 50MB), as raw bytes; white (>= 128) marks the region to remove. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the image; white (>= 128) marks the region to remove. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("mask")] public byte[]? Mask { get; set; } /// - /// A binary mask the same size as the image (max size 50MB), as raw bytes; white (>= 128) marks the region to remove. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the image; white (>= 128) marks the region to remove. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// [global::System.Text.Json.Serialization.JsonPropertyName("maskname")] public string? Maskname { get; set; } @@ -67,9 +63,8 @@ public sealed partial class RemoveObjectFromV2AssetsRequest public string? TargetCollectionId { get; set; } /// - /// Whether to store resulting generation assets on Ideogram. Defaults to `false` for
- /// API developers; first-party mini-apps should pass `true`. Reserved in the schema for
- /// an upcoming storage-control rollout — currently accepted but not yet enforced.
+ /// Whether to store the resulting images on Ideogram. Defaults to `false`.
+ /// Currently accepted but not yet enforced.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("store_assets")] @@ -89,20 +84,20 @@ public sealed partial class RemoveObjectFromV2AssetsRequest /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to remove an object from (max size 50MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to remove an object from. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// - /// The source image to remove an object from (max size 50MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to remove an object from. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// A binary mask the same size as the image (max size 50MB), as raw bytes; white (>= 128) marks the region to remove. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the image; white (>= 128) marks the region to remove. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// - /// A binary mask the same size as the image (max size 50MB), as raw bytes; white (>= 128) marks the region to remove. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the image; white (>= 128) marks the region to remove. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// /// Random seed. Set for reproducible generation.
@@ -112,9 +107,8 @@ public sealed partial class RemoveObjectFromV2AssetsRequest /// A collection you can write to, by its URL-safe base64 collection id. Completed outputs are added to it automatically. /// /// - /// Whether to store resulting generation assets on Ideogram. Defaults to `false` for
- /// API developers; first-party mini-apps should pass `true`. Reserved in the schema for
- /// an upcoming storage-control rollout — currently accepted but not yet enforced.
+ /// Whether to store the resulting images on Ideogram. Defaults to `false`.
+ /// Currently accepted but not yet enforced.
/// Default Value: false /// #if NET7_0_OR_GREATER diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.RemoveObjectFromV2AssetsResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.RemoveObjectFromV2AssetsResponse.g.cs index c56e49ba..4c5d9eae 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.RemoveObjectFromV2AssetsResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.RemoveObjectFromV2AssetsResponse.g.cs @@ -4,17 +4,16 @@ namespace Ideogram { /// - /// Acknowledgement returned by `POST /v2/image/remove-object/ideogram-1`. The request is
- /// accepted for asynchronous processing; poll for completion and results
- /// using `GET /v1/generations/{generation_id}` with the returned
- /// `generation_id`.
+ /// Acknowledgement that the request was accepted. Poll
+ /// `GET /v2/generations/{generation_id}` with the returned `generation_id`
+ /// for the result.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class RemoveObjectFromV2AssetsResponse { /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -31,7 +30,7 @@ public sealed partial class RemoveObjectFromV2AssetsResponse /// /// /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// `GET /v2/generations/{generation_id}` polling endpoint. /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundIdeogramV3Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundIdeogramV3Request.g.cs index 1b307534..9c6be763 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundIdeogramV3Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundIdeogramV3Request.g.cs @@ -4,9 +4,9 @@ namespace Ideogram { /// - /// Supply exactly one of `image_asset_identifier` or multipart `image`
- /// bytes. The prompt describes only the desired new background; the
- /// foreground subject is detected and preserved automatically. + /// Upload the source `image` using `multipart/form-data`. The prompt
+ /// describes only the new background; the foreground subject is detected
+ /// and kept automatically. ///
public sealed partial class ReplaceBackgroundIdeogramV3Request { @@ -19,15 +19,19 @@ public sealed partial class ReplaceBackgroundIdeogramV3Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only.
+ /// The longer side must be at most 3 times the shorter side; wider
+ /// aspect ratios are rejected with a 400. ///
[global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only.
+ /// The longer side must be at most 3 times the shorter side; wider
+ /// aspect ratios are rejected with a 400. ///
[global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -55,9 +59,8 @@ public sealed partial class ReplaceBackgroundIdeogramV3Request public int? NumImages { get; set; } /// - /// If true, the user is requesting private generation. If omitted,
- /// this defaults to the user's plan entitlement. Enterprise
- /// generations are always private. + /// Whether to keep the result private. When omitted, defaults to your
+ /// plan's setting. Enterprise generations are always private. ///
[global::System.Text.Json.Serialization.JsonPropertyName("private")] public bool? Private { get; set; } @@ -94,12 +97,16 @@ public sealed partial class ReplaceBackgroundIdeogramV3Request /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only.
+ /// The longer side must be at most 3 times the shorter side; wider
+ /// aspect ratios are rejected with a 400. /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only.
+ /// The longer side must be at most 3 times the shorter side; wider
+ /// aspect ratios are rejected with a 400. /// /// /// The rendering speed to use.
@@ -110,9 +117,8 @@ public sealed partial class ReplaceBackgroundIdeogramV3Request /// Default Value: 1 /// /// - /// If true, the user is requesting private generation. If omitted,
- /// this defaults to the user's plan entitlement. Enterprise
- /// generations are always private. + /// Whether to keep the result private. When omitted, defaults to your
+ /// plan's setting. Enterprise generations are always private. /// /// /// HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundRequest.g.cs index 9b0effb4..9e5017e4 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundRequest.g.cs @@ -4,9 +4,9 @@ namespace Ideogram { /// - /// Supply exactly one of `image_asset_identifier` or multipart `image`
- /// bytes. The prompt describes only the desired new background; the
- /// foreground subject is detected and preserved automatically. + /// Upload the source `image` using `multipart/form-data`. The prompt
+ /// describes only the new background; the foreground subject is detected
+ /// and kept automatically. ///
public sealed partial class ReplaceBackgroundRequest { @@ -19,15 +19,15 @@ public sealed partial class ReplaceBackgroundRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -55,9 +55,8 @@ public sealed partial class ReplaceBackgroundRequest public int? NumImages { get; set; } /// - /// If true, the user is requesting private generation. If omitted,
- /// this defaults to the user's plan entitlement. Enterprise
- /// generations are always private. + /// Whether to keep the result private. When omitted, defaults to your
+ /// plan's setting. Enterprise generations are always private. ///
[global::System.Text.Json.Serialization.JsonPropertyName("private")] public bool? Private { get; set; } @@ -94,12 +93,12 @@ public sealed partial class ReplaceBackgroundRequest /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only. /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only. /// /// /// The generation quality level. Defaults to `high`.
@@ -110,9 +109,8 @@ public sealed partial class ReplaceBackgroundRequest /// Default Value: 1 /// /// - /// If true, the user is requesting private generation. If omitted,
- /// this defaults to the user's plan entitlement. Enterprise
- /// generations are always private. + /// Whether to keep the result private. When omitted, defaults to your
+ /// plan's setting. Enterprise generations are always private. /// /// /// HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundResponse.g.cs index d66be02f..2d52466a 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundResponse.g.cs @@ -4,13 +4,13 @@ namespace Ideogram { /// - /// Acknowledgement that the workflow was accepted.
+ /// Acknowledgement that the request was accepted.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class ReplaceBackgroundResponse { /// - /// URL-safe base64 ID accepted by the generation polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// [global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -26,7 +26,7 @@ public sealed partial class ReplaceBackgroundResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID accepted by the generation polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.SketchToRenderRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.SketchToRenderRequest.g.cs index 113dc4e6..63675057 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.SketchToRenderRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.SketchToRenderRequest.g.cs @@ -4,9 +4,8 @@ namespace Ideogram { /// - /// Supply exactly one of `sketch_asset_identifier` or multipart
- /// `sketch_image` bytes. The entire source is transformed from an
- /// illustration into a photograph; masks are not accepted. + /// The whole sketch is transformed from an illustration into a
+ /// photograph; masks are not accepted. ///
public sealed partial class SketchToRenderRequest { @@ -19,24 +18,24 @@ public sealed partial class SketchToRenderRequest public global::Ideogram.AssetIdentifier? SketchAssetIdentifier { get; set; } /// - /// Raw fashion-sketch bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only.
- /// Mutually exclusive with `sketch_asset_identifier`. + /// The fashion sketch to render, up to 50 MB. JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("sketch_image")] public byte[]? SketchImage { get; set; } /// - /// Raw fashion-sketch bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only.
- /// Mutually exclusive with `sketch_asset_identifier`. + /// The fashion sketch to render, up to 50 MB. JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart requests
+ /// only. ///
[global::System.Text.Json.Serialization.JsonPropertyName("sketch_imagename")] public string? SketchImagename { get; set; } /// - /// Required material and rendering direction, plus any construction
- /// or design details that are not legible in the sketch. + /// Material and rendering direction, plus any construction or design
+ /// details that are not legible in the sketch. ///
[global::System.Text.Json.Serialization.JsonPropertyName("instruction")] [global::System.Text.Json.Serialization.JsonRequired] @@ -100,22 +99,22 @@ public sealed partial class SketchToRenderRequest /// Initializes a new instance of the class. /// /// - /// Required material and rendering direction, plus any construction
- /// or design details that are not legible in the sketch. + /// Material and rendering direction, plus any construction or design
+ /// details that are not legible in the sketch. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw fashion-sketch bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only.
- /// Mutually exclusive with `sketch_asset_identifier`. + /// The fashion sketch to render, up to 50 MB. JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart requests
+ /// only. /// /// - /// Raw fashion-sketch bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only.
- /// Mutually exclusive with `sketch_asset_identifier`. + /// The fashion sketch to render, up to 50 MB. JPEG, PNG, WEBP, HEIF,
+ /// AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart requests
+ /// only. /// /// /// Aspect ratio of each output image. Defaults to `1:1` when omitted. diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.SketchToRenderResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.SketchToRenderResponse.g.cs index 6d96b473..3da51b83 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.SketchToRenderResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.SketchToRenderResponse.g.cs @@ -4,7 +4,8 @@ namespace Ideogram { /// - /// Acknowledgement that the workflow was accepted.
+ /// Acknowledgement that the sketch rendering was accepted. Poll
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class SketchToRenderResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.SwanSLogoDesignResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.SwanSLogoDesignResponse.g.cs index 7a4b811f..9ac9dc3f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.SwanSLogoDesignResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.SwanSLogoDesignResponse.g.cs @@ -9,7 +9,7 @@ namespace Ideogram public sealed partial class SwanSLogoDesignResponse { /// - /// URL-safe base64 ID accepted by GET /v1/generations/{generation_id}. + /// URL-safe base64 ID accepted by GET /v2/generations/{generation_id}. /// [global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -25,7 +25,7 @@ public sealed partial class SwanSLogoDesignResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID accepted by GET /v1/generations/{generation_id}. + /// URL-safe base64 ID accepted by GET /v2/generations/{generation_id}. /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.SwanSLogoInstallResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.SwanSLogoInstallResponse.g.cs index 7d52a801..f82aab64 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.SwanSLogoInstallResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.SwanSLogoInstallResponse.g.cs @@ -9,7 +9,7 @@ namespace Ideogram public sealed partial class SwanSLogoInstallResponse { /// - /// URL-safe base64 ID accepted by GET /v1/generations/{generation_id}. + /// URL-safe base64 ID accepted by GET /v2/generations/{generation_id}. /// [global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -25,7 +25,7 @@ public sealed partial class SwanSLogoInstallResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID accepted by GET /v1/generations/{generation_id}. + /// URL-safe base64 ID accepted by GET /v2/generations/{generation_id}. /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixRequest.g.cs index 9b06a528..21ecf2dc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixRequest.g.cs @@ -22,31 +22,31 @@ public sealed partial class ToolRemixRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are staged for this generation request and are not added to your account's image assets. + /// The image to remix (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. The image is used only for this request and is not saved to your account. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are staged for this generation request and are not added to your account's image assets. + /// The image to remix (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. The image is used only for this request and is not saved to your account. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } /// - /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the selected model chooses its usual strength. Combining a weight with a `resolution` or `aspect_ratio` that changes the source's aspect ratio requires the 1K tier. + /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the selected model chooses its usual strength. Combining a weight with a `resolution` or `aspect_ratio` that changes the source's aspect ratio crops the source to the new shape; this is only available at the 1K tier and is rejected at 2K. /// [global::System.Text.Json.Serialization.JsonPropertyName("image_weight")] public int? ImageWeight { get; set; } /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. Not every model consults it. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it. /// [global::System.Text.Json.Serialization.JsonPropertyName("negative_prompt")] public string? NegativePrompt { get; set; } /// - /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output is served at the closest resolution the selected model supports in the corresponding 1K or 2K tier. Omit `aspect_ratio` when supplying a resolution. If `resolution_tier` is also supplied, it must match the tier implied by these dimensions. Combining a shape-changing value with `image_weight` requires the 1K tier. + /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output uses the closest supported resolution in the matching 1K or 2K tier. Omit `aspect_ratio` when supplying a resolution. If `resolution_tier` is also supplied, it must match the tier these dimensions fall in. Combining a shape-changing value with `image_weight` requires the 1K tier. /// [global::System.Text.Json.Serialization.JsonPropertyName("resolution")] public string? Resolution { get; set; } @@ -59,7 +59,7 @@ public sealed partial class ToolRemixRequest public global::Ideogram.IdeogramV4AspectRatio? AspectRatio { get; set; } /// - /// The output resolution tier. Influences which model serves the request. When omitted, the tier is inferred from `resolution`, or defaults to 1k when no exact resolution is supplied. Inputs that restrict the server's model choice (style references, saved styles, a color palette, style codes, a style preset, or a non-`auto` style type) currently support only 1K AUTO remixes. + /// The output resolution tier. When omitted, the tier is inferred from `resolution`, or defaults to 1k. A color palette, style codes, style preset, or non-`auto` style type are only supported at 1k. /// [global::System.Text.Json.Serialization.JsonPropertyName("resolution_tier")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.ToolRemixRequestResolutionTierJsonConverter))] @@ -74,7 +74,7 @@ public sealed partial class ToolRemixRequest public global::Ideogram.MagicPromptMode? MagicPrompt { get; set; } /// - /// Optional. Honored when the server selects the model that supports deterministic remixes; the default model synthesizes its own prompt, so results are not reproducible there. The response reports the seed used.
+ /// Optional. Only honored when the request uses a model that supports reproducible remixes; results from the default model are not reproducible. The response reports the seed used.
/// Example: 12345 ///
/// 12345 @@ -88,26 +88,26 @@ public sealed partial class ToolRemixRequest public global::System.Collections.Generic.IList? StyleReferenceAssetIdentifiers { get; set; } /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers`. Restricts the server to a model that supports style references and requires the 1K resolution tier. + /// A saved style to apply, by its URL-safe base64 collection id. Limits the request to a model that supports style references and requires the 1K resolution tier. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_id")] public string? StyleReferenceCollectionId { get; set; } /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_reference_collection_version_id")] public string? StyleReferenceCollectionVersionId { get; set; } /// - /// A predefined style preset to apply. Restricts the server to a model that supports it and requires the 1K resolution tier. Cannot be combined with style codes or style references. + /// A predefined style preset to apply. Limits the request to a model that supports it and requires the 1K resolution tier. Cannot be combined with style codes. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_preset")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.IdeogramV3StylePresetJsonConverter))] public global::Ideogram.IdeogramV3StylePreset? StylePreset { get; set; } /// - /// A color palette to apply. Restricts the server to a model that supports palettes and requires the 1K resolution tier. + /// A color palette to apply. Limits the request to a model that supports palettes and requires the 1K resolution tier. /// [global::System.Text.Json.Serialization.JsonPropertyName("color_palette")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.IdeogramColorPaletteJsonConverter))] @@ -122,7 +122,7 @@ public sealed partial class ToolRemixRequest public global::System.Collections.Generic.IList? StyleCodes { get; set; } /// - /// The style type to generate with. A value other than `auto` restricts the server to a model that supports it and requires the 1K resolution tier. + /// The style type to generate with. A value other than `auto` limits the request to a model that supports it and requires the 1K resolution tier. /// [global::System.Text.Json.Serialization.JsonPropertyName("style_type")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.IdeogramV3StyleTypeJsonConverter))] @@ -136,13 +136,13 @@ public sealed partial class ToolRemixRequest public int? NumImages { get; set; } /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// [global::System.Text.Json.Serialization.JsonPropertyName("enable_copyright_detection")] public bool? EnableCopyrightDetection { get; set; } /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -191,65 +191,65 @@ public sealed partial class ToolRemixRequest /// The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are staged for this generation request and are not added to your account's image assets. + /// The image to remix (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. The image is used only for this request and is not saved to your account. /// /// - /// The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are staged for this generation request and are not added to your account's image assets. + /// The image to remix (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. The image is used only for this request and is not saved to your account. /// /// - /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the selected model chooses its usual strength. Combining a weight with a `resolution` or `aspect_ratio` that changes the source's aspect ratio requires the 1K tier. + /// Optional. How closely the result should follow the source image, from 1 to 100. When omitted the selected model chooses its usual strength. Combining a weight with a `resolution` or `aspect_ratio` that changes the source's aspect ratio crops the source to the new shape; this is only available at the 1K tier and is rejected at 2K. /// /// - /// Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. Not every model consults it. + /// Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it. /// /// - /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output is served at the closest resolution the selected model supports in the corresponding 1K or 2K tier. Omit `aspect_ratio` when supplying a resolution. If `resolution_tier` is also supplied, it must match the tier implied by these dimensions. Combining a shape-changing value with `image_weight` requires the 1K tier. + /// The requested output resolution, formatted as "WIDTHxHEIGHT" (for example "1280x800"). The output uses the closest supported resolution in the matching 1K or 2K tier. Omit `aspect_ratio` when supplying a resolution. If `resolution_tier` is also supplied, it must match the tier these dimensions fall in. Combining a shape-changing value with `image_weight` requires the 1K tier. /// /// /// The requested output aspect ratio. Omit it to keep the source image's shape. `auto` also keeps the source shape. Omit `resolution` when supplying a concrete value. Combining a shape-changing value with `image_weight` requires the 1K tier. /// /// - /// The output resolution tier. Influences which model serves the request. When omitted, the tier is inferred from `resolution`, or defaults to 1k when no exact resolution is supplied. Inputs that restrict the server's model choice (style references, saved styles, a color palette, style codes, a style preset, or a non-`auto` style type) currently support only 1K AUTO remixes. + /// The output resolution tier. When omitted, the tier is inferred from `resolution`, or defaults to 1k. A color palette, style codes, style preset, or non-`auto` style type are only supported at 1k. /// /// /// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`. The selected model decides how to interpret it.
/// Default Value: auto /// /// - /// Optional. Honored when the server selects the model that supports deterministic remixes; the default model synthesizes its own prompt, so results are not reproducible there. The response reports the seed used.
+ /// Optional. Only honored when the request uses a model that supports reproducible remixes; results from the default model are not reproducible. The response reports the seed used.
/// Example: 12345 /// /// /// Existing upload or generated image assets whose style should guide the remix, by reference. Supplying style references restricts the server to a model that supports them and requires the 1K resolution tier. Ignored if `style_reference_collection_id` is also supplied. /// /// - /// A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers`. Restricts the server to a model that supports style references and requires the 1K resolution tier. + /// A saved style to apply, by its URL-safe base64 collection id. Limits the request to a model that supports style references and requires the 1K resolution tier. /// /// - /// Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it. + /// Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it. /// /// - /// A predefined style preset to apply. Restricts the server to a model that supports it and requires the 1K resolution tier. Cannot be combined with style codes or style references. + /// A predefined style preset to apply. Limits the request to a model that supports it and requires the 1K resolution tier. Cannot be combined with style codes. /// /// - /// A color palette to apply. Restricts the server to a model that supports palettes and requires the 1K resolution tier. + /// A color palette to apply. Limits the request to a model that supports palettes and requires the 1K resolution tier. /// /// /// A list of 8-character hexadecimal codes representing the style of the image. Refer to each endpoint for supported combinations with style types, presets, and reference images.
/// Example: [AAFF5733, 0133FF57, DE3357FF] /// /// - /// The style type to generate with. A value other than `auto` restricts the server to a model that supports it and requires the 1K resolution tier. + /// The style type to generate with. A value other than `auto` limits the request to a model that supports it and requires the 1K resolution tier. /// /// /// The number of images to generate.
/// Default Value: 1 /// /// - /// Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`. + /// Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`. /// /// - /// When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixRequestResolutionTier.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixRequestResolutionTier.g.cs index 412c2978..6efedebb 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixRequestResolutionTier.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixRequestResolutionTier.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// The output resolution tier. Influences which model serves the request. When omitted, the tier is inferred from `resolution`, or defaults to 1k when no exact resolution is supplied. Inputs that restrict the server's model choice (style references, saved styles, a color palette, style codes, a style preset, or a non-`auto` style type) currently support only 1K AUTO remixes. + /// The output resolution tier. When omitted, the tier is inferred from `resolution`, or defaults to 1k. A color palette, style codes, style preset, or non-`auto` style type are only supported at 1k. /// public enum ToolRemixRequestResolutionTier { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixResponse.g.cs index 7b5830fd..5633b73d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.ToolRemixResponse.g.cs @@ -6,18 +6,16 @@ namespace Ideogram /// /// Response returned by `POST /v2/image/remix/auto`. Synchronous
/// requests (the default) include the remixed images in `data`.
- /// Requests with `async` set to true omit `data`; poll for completion
- /// and results with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`. The seed reports the server-assigned value
- /// attached to the request; AUTO remixes are not reproducible because the
- /// selected model may synthesize an unseeded instruction prompt.
+ /// Asynchronous requests omit `data`; poll
+ /// `GET /v2/generations/{generation_id}` with the returned
+ /// `generation_id`.
/// Example: {"data":[{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"prompt":"prompt","resolution":"1024x1024","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":"","generation_id":"generation_id"} ///
public sealed partial class ToolRemixResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -30,7 +28,7 @@ public sealed partial class ToolRemixResponse public global::System.Collections.Generic.IList? Data { get; set; } /// - /// Server-assigned value attached to the request for tracing. This value does not make AUTO remixes reproducible because the selected model may synthesize an unseeded instruction prompt. + /// The seed attached to the request. Reusing it does not guarantee a reproducible result, because the selected model may not honor seeds. /// [global::System.Text.Json.Serialization.JsonPropertyName("seed")] [global::System.Text.Json.Serialization.JsonRequired] @@ -46,11 +44,11 @@ public sealed partial class ToolRemixResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// URL-safe base64 ID of the generation. Use it to poll
+ /// `GET /v2/generations/{generation_id}`. /// /// - /// Server-assigned value attached to the request for tracing. This value does not make AUTO remixes reproducible because the selected model may synthesize an unseeded instruction prompt. + /// The seed attached to the request. Reusing it does not guarantee a reproducible result, because the selected model may not honor seeds. /// /// /// The remixed images, in generation order. Present only for synchronous requests (`async` omitted or false). diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageNanoBananaProRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageNanoBananaProRequest.g.cs index 0d723b17..dabce5ef 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageNanoBananaProRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageNanoBananaProRequest.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Supply the source image either as an `image_asset_identifier`
- /// reference or (multipart requests only) as raw `image` bytes. Exactly
- /// one source is required; if both forms are given, the reference is
- /// used and the bytes are ignored. + /// Upload the source `image` using `multipart/form-data`. ///
public sealed partial class UpscaleImageNanoBananaProRequest { @@ -20,13 +17,13 @@ public sealed partial class UpscaleImageNanoBananaProRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -54,7 +51,7 @@ public sealed partial class UpscaleImageNanoBananaProRequest public int? Seed { get; set; } /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -101,10 +98,10 @@ public sealed partial class UpscaleImageNanoBananaProRequest /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// Optional short guidance for the enhancement, appended to the model's upscaling instruction. When omitted, the image is upscaled as-is. @@ -118,7 +115,7 @@ public sealed partial class UpscaleImageNanoBananaProRequest /// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageNanoBananaProResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageNanoBananaProResponse.g.cs index f5110c29..f383a790 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageNanoBananaProResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageNanoBananaProResponse.g.cs @@ -4,20 +4,16 @@ namespace Ideogram { /// - /// Response returned by `POST /v2/image/upscale/nano-banana-pro`.
- /// Synchronous requests (the default) include the upscaled image in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset; width and height
- /// report the output dimensions.
+ /// Synchronous requests (the default) include the upscaled image in `data`.
+ /// Async requests omit `data`; poll `GET /v2/generations/{generation_id}`
+ /// with the returned `generation_id`. `seed` is the seed actually used,
+ /// and `width` and `height` are the output dimensions.
/// Example: {"data":[{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id","width":0,"height":6} ///
public sealed partial class UpscaleImageNanoBananaProResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -62,8 +58,7 @@ public sealed partial class UpscaleImageNanoBananaProResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazBloom2Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazBloom2Request.g.cs index 3750f3c9..4135a74a 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazBloom2Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazBloom2Request.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Supply the source image either as an `image_asset_identifier`
- /// reference or (multipart requests only) as raw `image` bytes. Exactly
- /// one source is required; if both forms are given, the reference is
- /// used and the bytes are ignored. + /// Upload the source `image` using `multipart/form-data`. ///
public sealed partial class UpscaleImageTopazBloom2Request { @@ -20,13 +17,13 @@ public sealed partial class UpscaleImageTopazBloom2Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -68,7 +65,7 @@ public sealed partial class UpscaleImageTopazBloom2Request public int? Seed { get; set; } /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -115,10 +112,10 @@ public sealed partial class UpscaleImageTopazBloom2Request /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -140,7 +137,7 @@ public sealed partial class UpscaleImageTopazBloom2Request /// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazBloom2Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazBloom2Response.g.cs index 5158f65c..12618972 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazBloom2Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazBloom2Response.g.cs @@ -4,20 +4,16 @@ namespace Ideogram { /// - /// Response returned by `POST /v2/image/upscale/topaz-bloom-2`.
- /// Synchronous requests (the default) include the upscaled image in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset; width and height
- /// report the output dimensions.
+ /// Synchronous requests (the default) include the upscaled image in `data`.
+ /// Async requests omit `data`; poll `GET /v2/generations/{generation_id}`
+ /// with the returned `generation_id`. `seed` is the seed actually used,
+ /// and `width` and `height` are the output dimensions.
/// Example: {"data":[{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id","width":0,"height":6} ///
public sealed partial class UpscaleImageTopazBloom2Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -62,8 +58,7 @@ public sealed partial class UpscaleImageTopazBloom2Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineRequest.g.cs index def65191..49788b55 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineRequest.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Supply the source image either as an `image_asset_identifier`
- /// reference or (multipart requests only) as raw `image` bytes. Exactly
- /// one source is required; if both forms are given, the reference is
- /// used and the bytes are ignored. + /// Upload the source `image` using `multipart/form-data`. ///
public sealed partial class UpscaleImageTopazRedefineRequest { @@ -20,13 +17,13 @@ public sealed partial class UpscaleImageTopazRedefineRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -80,13 +77,13 @@ public sealed partial class UpscaleImageTopazRedefineRequest public float? DetailStrength { get; set; } /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("sharpen")] public float? Sharpen { get; set; } /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("denoise")] public float? Denoise { get; set; } @@ -110,7 +107,7 @@ public sealed partial class UpscaleImageTopazRedefineRequest public float? FaceEnhancementCreativity { get; set; } /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("subject_detection")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.UpscaleImageTopazRedefineRequestSubjectDetectionJsonConverter))] @@ -125,7 +122,7 @@ public sealed partial class UpscaleImageTopazRedefineRequest public int? Seed { get; set; } /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -172,10 +169,10 @@ public sealed partial class UpscaleImageTopazRedefineRequest /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -204,10 +201,10 @@ public sealed partial class UpscaleImageTopazRedefineRequest /// Detail adjustment intensity, from 0 to 10. /// /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// /// /// Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required. @@ -219,14 +216,14 @@ public sealed partial class UpscaleImageTopazRedefineRequest /// How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative). /// /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// /// /// Random seed. Set for reproducible generation.
/// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineRequestSubjectDetection.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineRequestSubjectDetection.g.cs index 63a9cc33..d21fc870 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineRequestSubjectDetection.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineRequestSubjectDetection.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// public enum UpscaleImageTopazRedefineRequestSubjectDetection { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineResponse.g.cs index f493f33f..5805b3b1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazRedefineResponse.g.cs @@ -4,20 +4,16 @@ namespace Ideogram { /// - /// Response returned by `POST /v2/image/upscale/topaz-redefine`.
- /// Synchronous requests (the default) include the upscaled image in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset; width and height
- /// report the output dimensions.
+ /// Synchronous requests (the default) include the upscaled image in `data`.
+ /// Async requests omit `data`; poll `GET /v2/generations/{generation_id}`
+ /// with the returned `generation_id`. `seed` is the seed actually used,
+ /// and `width` and `height` are the output dimensions.
/// Example: {"data":[{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id","width":0,"height":6} ///
public sealed partial class UpscaleImageTopazRedefineResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -62,8 +58,7 @@ public sealed partial class UpscaleImageTopazRedefineResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2Request.g.cs index 068710a9..9f0a1183 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2Request.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Supply the source image either as an `image_asset_identifier`
- /// reference or (multipart requests only) as raw `image` bytes. Exactly
- /// one source is required; if both forms are given, the reference is
- /// used and the bytes are ignored. + /// Upload the source `image` using `multipart/form-data`. ///
public sealed partial class UpscaleImageTopazStandardV2Request { @@ -20,13 +17,13 @@ public sealed partial class UpscaleImageTopazStandardV2Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -40,25 +37,25 @@ public sealed partial class UpscaleImageTopazStandardV2Request public global::Ideogram.UpscaleImageTopazStandardV2RequestUpscaleFactor? UpscaleFactor { get; set; } /// - /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let Topaz choose per image. + /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("strength")] public float? Strength { get; set; } /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("sharpen")] public float? Sharpen { get; set; } /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("denoise")] public float? Denoise { get; set; } /// - /// Compression artifact removal, from 0 to 1. Omit to let Topaz choose per image. + /// Compression artifact removal, from 0 to 1. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("fix_compression")] public float? FixCompression { get; set; } @@ -82,14 +79,14 @@ public sealed partial class UpscaleImageTopazStandardV2Request public float? FaceEnhancementCreativity { get; set; } /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("subject_detection")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.UpscaleImageTopazStandardV2RequestSubjectDetectionJsonConverter))] public global::Ideogram.UpscaleImageTopazStandardV2RequestSubjectDetection? SubjectDetection { get; set; } /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -136,26 +133,26 @@ public sealed partial class UpscaleImageTopazStandardV2Request /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
/// Default Value: x2 /// /// - /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let Topaz choose per image. + /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let the model choose per image. /// /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// /// - /// Compression artifact removal, from 0 to 1. Omit to let Topaz choose per image. + /// Compression artifact removal, from 0 to 1. Omit to let the model choose per image. /// /// /// Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required. @@ -167,10 +164,10 @@ public sealed partial class UpscaleImageTopazStandardV2Request /// How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative). /// /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2RequestSubjectDetection.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2RequestSubjectDetection.g.cs index 44d96158..758c6b1d 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2RequestSubjectDetection.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2RequestSubjectDetection.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// public enum UpscaleImageTopazStandardV2RequestSubjectDetection { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2Response.g.cs index 943ea897..9f566d37 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazStandardV2Response.g.cs @@ -4,20 +4,16 @@ namespace Ideogram { /// - /// Response returned by `POST /v2/image/upscale/topaz-standard-2`.
- /// Synchronous requests (the default) include the upscaled image in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset; width and height
- /// report the output dimensions.
+ /// Synchronous requests (the default) include the upscaled image in `data`.
+ /// Async requests omit `data`; poll `GET /v2/generations/{generation_id}`
+ /// with the returned `generation_id`. `seed` is the seed actually used,
+ /// and `width` and `height` are the output dimensions.
/// Example: {"data":[{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id","width":0,"height":6} ///
public sealed partial class UpscaleImageTopazStandardV2Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -62,8 +58,7 @@ public sealed partial class UpscaleImageTopazStandardV2Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineRequest.g.cs index 6a361e68..5f1fc494 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineRequest.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Supply the source image either as an `image_asset_identifier`
- /// reference or (multipart requests only) as raw `image` bytes. Exactly
- /// one source is required; if both forms are given, the reference is
- /// used and the bytes are ignored. + /// Upload the source `image` using `multipart/form-data`. ///
public sealed partial class UpscaleImageTopazTextRefineRequest { @@ -20,13 +17,13 @@ public sealed partial class UpscaleImageTopazTextRefineRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -40,25 +37,25 @@ public sealed partial class UpscaleImageTopazTextRefineRequest public global::Ideogram.UpscaleImageTopazTextRefineRequestUpscaleFactor? UpscaleFactor { get; set; } /// - /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let Topaz choose per image. + /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("strength")] public float? Strength { get; set; } /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("sharpen")] public float? Sharpen { get; set; } /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("denoise")] public float? Denoise { get; set; } /// - /// Compression artifact removal, from 0 to 1. Omit to let Topaz choose per image. + /// Compression artifact removal, from 0 to 1. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("fix_compression")] public float? FixCompression { get; set; } @@ -82,7 +79,7 @@ public sealed partial class UpscaleImageTopazTextRefineRequest public float? FaceEnhancementCreativity { get; set; } /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// [global::System.Text.Json.Serialization.JsonPropertyName("subject_detection")] [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Ideogram.JsonConverters.UpscaleImageTopazTextRefineRequestSubjectDetectionJsonConverter))] @@ -97,7 +94,7 @@ public sealed partial class UpscaleImageTopazTextRefineRequest public int? Seed { get; set; } /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -144,26 +141,26 @@ public sealed partial class UpscaleImageTopazTextRefineRequest /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
/// Default Value: x2 /// /// - /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let Topaz choose per image. + /// Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let the model choose per image. /// /// - /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image. + /// Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image. /// /// - /// Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image. + /// Noise and grain reduction, from 0 to 1. Omit to let the model choose per image. /// /// - /// Compression artifact removal, from 0 to 1. Omit to let Topaz choose per image. + /// Compression artifact removal, from 0 to 1. Omit to let the model choose per image. /// /// /// Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required. @@ -175,14 +172,14 @@ public sealed partial class UpscaleImageTopazTextRefineRequest /// How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative). /// /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// /// /// Random seed. Set for reproducible generation.
/// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineRequestSubjectDetection.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineRequestSubjectDetection.g.cs index 9309c59f..a249b305 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineRequestSubjectDetection.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineRequestSubjectDetection.g.cs @@ -4,7 +4,7 @@ namespace Ideogram { /// - /// Where enhancements apply. Omit to let Topaz choose per image. + /// Where enhancements apply. Omit to let the model choose per image. /// public enum UpscaleImageTopazTextRefineRequestSubjectDetection { diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineResponse.g.cs index f95c0c26..ee4207ab 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazTextRefineResponse.g.cs @@ -4,20 +4,16 @@ namespace Ideogram { /// - /// Response returned by `POST /v2/image/upscale/topaz-text-refine`.
- /// Synchronous requests (the default) include the upscaled image in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset; width and height
- /// report the output dimensions.
+ /// Synchronous requests (the default) include the upscaled image in `data`.
+ /// Async requests omit `data`; poll `GET /v2/generations/{generation_id}`
+ /// with the returned `generation_id`. `seed` is the seed actually used,
+ /// and `width` and `height` are the output dimensions.
/// Example: {"data":[{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id","width":0,"height":6} ///
public sealed partial class UpscaleImageTopazTextRefineResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -62,8 +58,7 @@ public sealed partial class UpscaleImageTopazTextRefineResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazWonder35Request.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazWonder35Request.g.cs index 9bc48804..e60f56d9 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazWonder35Request.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazWonder35Request.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Supply the source image either as an `image_asset_identifier`
- /// reference or (multipart requests only) as raw `image` bytes. Exactly
- /// one source is required; if both forms are given, the reference is
- /// used and the bytes are ignored. + /// Upload the source `image` using `multipart/form-data`. ///
public sealed partial class UpscaleImageTopazWonder35Request { @@ -20,13 +17,13 @@ public sealed partial class UpscaleImageTopazWonder35Request public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -56,7 +53,7 @@ public sealed partial class UpscaleImageTopazWonder35Request public int? Seed { get; set; } /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -103,10 +100,10 @@ public sealed partial class UpscaleImageTopazWonder35Request /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -121,7 +118,7 @@ public sealed partial class UpscaleImageTopazWonder35Request /// Example: 12345 /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazWonder35Response.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazWonder35Response.g.cs index 8982eb78..a23c8826 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazWonder35Response.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageTopazWonder35Response.g.cs @@ -4,20 +4,16 @@ namespace Ideogram { /// - /// Response returned by `POST /v2/image/upscale/topaz-wonder-3-5`.
- /// Synchronous requests (the default) include the upscaled image in
- /// `data`. Requests with `async` set to true omit `data`; poll for
- /// completion and results with `GET /v1/generations/{generation_id}`
- /// using the returned `generation_id`. The seed reports the value the
- /// request resolved to when the caller left it unset; width and height
- /// report the output dimensions.
+ /// Synchronous requests (the default) include the upscaled image in `data`.
+ /// Async requests omit `data`; poll `GET /v2/generations/{generation_id}`
+ /// with the returned `generation_id`. `seed` is the seed actually used,
+ /// and `width` and `height` are the output dimensions.
/// Example: {"data":[{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id","width":0,"height":6} ///
public sealed partial class UpscaleImageTopazWonder35Response { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -62,8 +58,7 @@ public sealed partial class UpscaleImageTopazWonder35Response /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleToolRequest.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleToolRequest.g.cs index c8d9e163..1c30e981 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleToolRequest.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleToolRequest.g.cs @@ -4,10 +4,7 @@ namespace Ideogram { /// - /// Supply the source image either as an `image_asset_identifier`
- /// reference or (multipart requests only) as raw `image` bytes. Provide
- /// exactly one of the two forms; supplying both, or neither, is rejected
- /// with a 400. + /// Upload the source `image` using `multipart/form-data`. ///
public sealed partial class UpscaleToolRequest { @@ -20,13 +17,13 @@ public sealed partial class UpscaleToolRequest public global::Ideogram.AssetIdentifier? ImageAssetIdentifier { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("image")] public byte[]? Image { get; set; } /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// [global::System.Text.Json.Serialization.JsonPropertyName("imagename")] public string? Imagename { get; set; } @@ -55,7 +52,7 @@ public sealed partial class UpscaleToolRequest public bool? Internal { get; set; } /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false ///
[global::System.Text.Json.Serialization.JsonPropertyName("async")] @@ -102,10 +99,10 @@ public sealed partial class UpscaleToolRequest /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -120,7 +117,7 @@ public sealed partial class UpscaleToolRequest /// Default Value: false /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleToolResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleToolResponse.g.cs index c0cc2ea3..2af37fac 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleToolResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.UpscaleToolResponse.g.cs @@ -4,20 +4,16 @@ namespace Ideogram { /// - /// Response returned by `POST /v2/image/upscale/auto`. Synchronous requests
- /// (the default) include the upscaled image in `data`. Requests with
- /// `async` set to true omit `data`; poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`. The seed reports the value the request resolved to
- /// when the caller left it unset; width and height report the output
- /// dimensions.
+ /// Synchronous requests (the default) include the upscaled image in `data`.
+ /// Async requests omit `data`; poll `GET /v2/generations/{generation_id}`
+ /// with the returned `generation_id`. `seed` is the seed actually used,
+ /// and `width` and `height` are the output dimensions.
/// Example: {"data":[{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true},{"seed":12345,"resolution":"2048x2048","url":"https://openapi-generator.tech","is_image_safe":true}],"seed":12345,"generation_id":"generation_id","width":0,"height":6} ///
public sealed partial class UpscaleToolResponse { /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. ///
[global::System.Text.Json.Serialization.JsonPropertyName("generation_id")] [global::System.Text.Json.Serialization.JsonRequired] @@ -62,8 +58,7 @@ public sealed partial class UpscaleToolResponse /// Initializes a new instance of the class. /// /// - /// URL-safe base64 ID of the accepted generation. Accepted by the
- /// `GET /v1/generations/{generation_id}` polling endpoint. + /// The generation ID to poll with `GET /v2/generations/{generation_id}`. /// /// /// Random seed. Set for reproducible generation.
diff --git a/src/libs/Ideogram/Generated/Ideogram.Models.VirtualTryOnResponse.g.cs b/src/libs/Ideogram/Generated/Ideogram.Models.VirtualTryOnResponse.g.cs index 445a6192..f475a33a 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Models.VirtualTryOnResponse.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Models.VirtualTryOnResponse.g.cs @@ -5,7 +5,7 @@ namespace Ideogram { /// /// Acknowledgement that the try-on was accepted. Poll
- /// `GET /v1/generations/{generation_id}` for status and results.
+ /// `GET /v2/generations/{generation_id}` for status and results.
/// Example: {"generation_id":"generation_id"} ///
public sealed partial class VirtualTryOnResponse diff --git a/src/libs/Ideogram/Generated/Ideogram.ObjectRemoval.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.ObjectRemoval.JsonSerializerContext.g.cs index 1d545047..5308b0b1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ObjectRemoval.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ObjectRemoval.JsonSerializerContext.g.cs @@ -17,10 +17,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(int))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(bool))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(byte[]))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.RemoveObjectFromV2AssetsResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.RemoveObjectFromV2AssetsRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetType), TypeInfoPropertyName = "AssetType2")] diff --git a/src/libs/Ideogram/Generated/Ideogram.ObjectRemovalClient.PostRemoveObjectFromV2Assets.g.cs b/src/libs/Ideogram/Generated/Ideogram.ObjectRemovalClient.PostRemoveObjectFromV2Assets.g.cs index 0456027a..3529a0ff 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ObjectRemovalClient.PostRemoveObjectFromV2Assets.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ObjectRemovalClient.PostRemoveObjectFromV2Assets.g.cs @@ -44,17 +44,11 @@ partial void ProcessPostRemoveObjectFromV2AssetsResponseContent( ref string content); /// - /// Remove a masked object from an image, by asset id or by uploaded bytes
- /// Remove a masked object from an image. For each of the source image and the
- /// mask, supply either an `AssetIdentifier` reference (`image_asset_identifier`
- /// / `mask_asset_identifier`) or the raw image bytes directly (`image` / `mask`,
- /// multipart requests only) — callers are never required to call
- /// `POST /v2/assets` first. If both a reference and bytes are supplied for the
- /// same input, the reference wins and the bytes are ignored.
- /// Poll for completion with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// This is the `/v2` capability-first shape; no `model` or `model_uri` field is
- /// exposed until a second backend exists. + /// Remove an object
+ /// Remove a masked object from an image. Upload the source `image` and a
+ /// `mask` of the same size using `multipart/form-data`. Returns a
+ /// `generation_id`; poll `GET /v2/generations/{generation_id}` for the
+ /// result. ///
/// /// Default Value: false @@ -81,17 +75,11 @@ partial void ProcessPostRemoveObjectFromV2AssetsResponseContent( return __response.Body; } /// - /// Remove a masked object from an image, by asset id or by uploaded bytes
- /// Remove a masked object from an image. For each of the source image and the
- /// mask, supply either an `AssetIdentifier` reference (`image_asset_identifier`
- /// / `mask_asset_identifier`) or the raw image bytes directly (`image` / `mask`,
- /// multipart requests only) — callers are never required to call
- /// `POST /v2/assets` first. If both a reference and bytes are supplied for the
- /// same input, the reference wins and the bytes are ignored.
- /// Poll for completion with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// This is the `/v2` capability-first shape; no `model` or `model_uri` field is
- /// exposed until a second backend exists. + /// Remove an object
+ /// Remove a masked object from an image. Upload the source `image` and a
+ /// `mask` of the same size using `multipart/form-data`. Returns a
+ /// `generation_id`; poll `GET /v2/generations/{generation_id}` for the
+ /// result. ///
/// /// Default Value: false @@ -857,17 +845,11 @@ request.Maskname is null } } /// - /// Remove a masked object from an image, by asset id or by uploaded bytes
- /// Remove a masked object from an image. For each of the source image and the
- /// mask, supply either an `AssetIdentifier` reference (`image_asset_identifier`
- /// / `mask_asset_identifier`) or the raw image bytes directly (`image` / `mask`,
- /// multipart requests only) — callers are never required to call
- /// `POST /v2/assets` first. If both a reference and bytes are supplied for the
- /// same input, the reference wins and the bytes are ignored.
- /// Poll for completion with `GET /v1/generations/{generation_id}` using the
- /// returned `generation_id`.
- /// This is the `/v2` capability-first shape; no `model` or `model_uri` field is
- /// exposed until a second backend exists. + /// Remove an object
+ /// Remove a masked object from an image. Upload the source `image` and a
+ /// `mask` of the same size using `multipart/form-data`. Returns a
+ /// `generation_id`; poll `GET /v2/generations/{generation_id}` for the
+ /// result. ///
/// /// Default Value: false @@ -877,20 +859,20 @@ request.Maskname is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to remove an object from (max size 50MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to remove an object from. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// - /// The source image to remove an object from (max size 50MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. + /// The source image to remove an object from. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// /// An identifier for an ideogram asset.
/// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// A binary mask the same size as the image (max size 50MB), as raw bytes; white (>= 128) marks the region to remove. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the image; white (>= 128) marks the region to remove. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// - /// A binary mask the same size as the image (max size 50MB), as raw bytes; white (>= 128) marks the region to remove. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied. + /// A black-and-white mask the same size as the image; white (>= 128) marks the region to remove. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. /// /// /// Random seed. Set for reproducible generation.
@@ -900,9 +882,8 @@ request.Maskname is null /// A collection you can write to, by its URL-safe base64 collection id. Completed outputs are added to it automatically. /// /// - /// Whether to store resulting generation assets on Ideogram. Defaults to `false` for
- /// API developers; first-party mini-apps should pass `true`. Reserved in the schema for
- /// an upcoming storage-control rollout — currently accepted but not yet enforced.
+ /// Whether to store the resulting images on Ideogram. Defaults to `false`.
+ /// Currently accepted but not yet enforced.
/// Default Value: false /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. diff --git a/src/libs/Ideogram/Generated/Ideogram.ObjectRemovalClient.g.cs b/src/libs/Ideogram/Generated/Ideogram.ObjectRemovalClient.g.cs index 580ad272..8a9df2c7 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ObjectRemovalClient.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ObjectRemovalClient.g.cs @@ -4,9 +4,8 @@ namespace Ideogram { /// - /// Remove unwanted objects from existing image assets. Requests use
- /// `AssetIdentifier` references and return a generation id that can be
- /// polled via `GET /v1/generations/{generation_id}`.
+ /// Remove unwanted objects from an image. Requests return a generation id
+ /// to poll with `GET /v2/generations/{generation_id}`.
/// If no httpClient is provided, a new one will be created.
/// If no baseUri is provided, the default baseUri from OpenAPI spec will be used. ///
diff --git a/src/libs/Ideogram/Generated/Ideogram.Tool.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.Tool.JsonSerializerContext.g.cs index ec06f790..d75acd9c 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Tool.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Tool.JsonSerializerContext.g.cs @@ -17,10 +17,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(int))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(bool))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(byte[]))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.RemoveBackgroundV2Response))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.BackgroundRemovedImageObject))] diff --git a/src/libs/Ideogram/Generated/Ideogram.ToolClient.RemoveBackground.g.cs b/src/libs/Ideogram/Generated/Ideogram.ToolClient.RemoveBackground.g.cs index 61cb77ae..f6cbab1a 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ToolClient.RemoveBackground.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ToolClient.RemoveBackground.g.cs @@ -44,19 +44,11 @@ partial void ProcessRemoveBackgroundResponseContent( ref string content); /// - /// Remove an image background
- /// Remove the background from one image and return a foreground PNG with
- /// transparency. Supply exactly one source: raw `image` bytes in a
- /// multipart request, or an existing `image_asset_identifier` in JSON or
- /// multipart form.
- /// By default the request blocks until the foreground image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll `GET /v1/generations/{generation_id}`.
- /// API-key requests use the organization bound to the key. Firebase Bearer
- /// requests use their selected organization, and Mini App context tokens
- /// remain bound to the organization in the token. When `private` is omitted,
- /// Bearer and Mini App callers inherit their plan's private-generation
- /// default; Enterprise generations are always private. + /// Remove background
+ /// Remove the background from an image and return the foreground as a
+ /// transparent PNG. Upload the source `image` using `multipart/form-data`.
+ /// Returns the result directly by default; set `async` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -83,19 +75,11 @@ partial void ProcessRemoveBackgroundResponseContent( return __response.Body; } /// - /// Remove an image background
- /// Remove the background from one image and return a foreground PNG with
- /// transparency. Supply exactly one source: raw `image` bytes in a
- /// multipart request, or an existing `image_asset_identifier` in JSON or
- /// multipart form.
- /// By default the request blocks until the foreground image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll `GET /v1/generations/{generation_id}`.
- /// API-key requests use the organization bound to the key. Firebase Bearer
- /// requests use their selected organization, and Mini App context tokens
- /// remain bound to the organization in the token. When `private` is omitted,
- /// Bearer and Mini App callers inherit their plan's private-generation
- /// default; Enterprise generations are always private. + /// Remove background
+ /// Remove the background from an image and return the foreground as a
+ /// transparent PNG. Upload the source `image` using `multipart/form-data`.
+ /// Returns the result directly by default; set `async` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -811,28 +795,20 @@ request.Imagename is null } } /// - /// Remove an image background
- /// Remove the background from one image and return a foreground PNG with
- /// transparency. Supply exactly one source: raw `image` bytes in a
- /// multipart request, or an existing `image_asset_identifier` in JSON or
- /// multipart form.
- /// By default the request blocks until the foreground image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll `GET /v1/generations/{generation_id}`.
- /// API-key requests use the organization bound to the key. Firebase Bearer
- /// requests use their selected organization, and Mini App context tokens
- /// remain bound to the organization in the token. When `private` is omitted,
- /// Bearer and Mini App callers inherit their plan's private-generation
- /// default; Enterprise generations are always private. + /// Remove background
+ /// Remove the background from an image and return the foreground as a
+ /// transparent PNG. Upload the source `image` using `multipart/form-data`.
+ /// Returns the result directly by default; set `async` to get a
+ /// `generation_id` and poll `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false /// /// - /// Raw JPEG, PNG, or WebP image bytes (max 25MB). Multipart requests only. + /// The source image. JPEG, PNG, or WebP, up to 25MB. Multipart requests only. /// /// - /// Raw JPEG, PNG, or WebP image bytes (max 25MB). Multipart requests only. + /// The source image. JPEG, PNG, or WebP, up to 25MB. Multipart requests only. /// /// /// An identifier for an ideogram asset.
@@ -843,13 +819,11 @@ request.Imagename is null /// /// /// Whether to keep the result out of the public gallery. When omitted,
- /// Firebase Bearer and Mini App callers inherit their plan entitlement.
- /// Enterprise generations are always private. API keys use their bound
- /// organization and otherwise default to public when no subscription
- /// entitlement is available. + /// defaults to your plan's setting, or public if your plan has none.
+ /// Enterprise generations are always private. /// /// - /// When false (the default), wait for and return the foreground image. When true, return after acceptance and poll `GET /v1/generations/{generation_id}`.
+ /// When false (the default), wait for and return the foreground image. When true, return as soon as the request is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. diff --git a/src/libs/Ideogram/Generated/Ideogram.ToolClient.ReplaceBackground.g.cs b/src/libs/Ideogram/Generated/Ideogram.ToolClient.ReplaceBackground.g.cs index b34b4c91..393775ee 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ToolClient.ReplaceBackground.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ToolClient.ReplaceBackground.g.cs @@ -44,16 +44,12 @@ partial void ProcessReplaceBackgroundResponseContent( ref string content); /// - /// Replace an image background
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject. The foreground mask is detected automatically;
- /// callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. + /// Replace background with GPT Image 2
+ /// Replace the background of an image from a text prompt while keeping the
+ /// automatically detected foreground subject; no mask is needed. Upload
+ /// the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -80,16 +76,12 @@ partial void ProcessReplaceBackgroundResponseContent( return __response.Body; } /// - /// Replace an image background
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject. The foreground mask is detected automatically;
- /// callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. + /// Replace background with GPT Image 2
+ /// Replace the background of an image from a text prompt while keeping the
+ /// automatically detected foreground subject; no mask is needed. Upload
+ /// the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -817,16 +809,12 @@ request.Imagename is null } } /// - /// Replace an image background
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject. The foreground mask is detected automatically;
- /// callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. + /// Replace background with GPT Image 2
+ /// Replace the background of an image from a text prompt while keeping the
+ /// automatically detected foreground subject; no mask is needed. Upload
+ /// the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -836,12 +824,12 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only. /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only. /// /// /// Plain-language description of the desired new background. @@ -855,9 +843,8 @@ request.Imagename is null /// Default Value: 1 /// /// - /// If true, the user is requesting private generation. If omitted,
- /// this defaults to the user's plan entitlement. Enterprise
- /// generations are always private. + /// Whether to keep the result private. When omitted, defaults to your
+ /// plan's setting. Enterprise generations are always private. /// /// /// HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a
diff --git a/src/libs/Ideogram/Generated/Ideogram.ToolClient.ReplaceBackgroundIdeogramV3.g.cs b/src/libs/Ideogram/Generated/Ideogram.ToolClient.ReplaceBackgroundIdeogramV3.g.cs index bdefabce..5c7d74cc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ToolClient.ReplaceBackgroundIdeogramV3.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ToolClient.ReplaceBackgroundIdeogramV3.g.cs @@ -44,18 +44,12 @@ partial void ProcessReplaceBackgroundIdeogramV3ResponseContent( ref string content); /// - /// Replace an image background with Ideogram 3.0
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject, generated by Ideogram 3.0 inpainting. The
- /// foreground mask is detected automatically; callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. The source's longer
- /// side must be at most 3 times its shorter side; wider aspect ratios are
- /// rejected with a 400. + /// Replace background with Ideogram 3.0
+ /// Replace the background of an image from a text prompt with Ideogram 3.0,
+ /// keeping the automatically detected foreground subject; no mask is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -82,18 +76,12 @@ partial void ProcessReplaceBackgroundIdeogramV3ResponseContent( return __response.Body; } /// - /// Replace an image background with Ideogram 3.0
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject, generated by Ideogram 3.0 inpainting. The
- /// foreground mask is detected automatically; callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. The source's longer
- /// side must be at most 3 times its shorter side; wider aspect ratios are
- /// rejected with a 400. + /// Replace background with Ideogram 3.0
+ /// Replace the background of an image from a text prompt with Ideogram 3.0,
+ /// keeping the automatically detected foreground subject; no mask is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -821,18 +809,12 @@ request.Imagename is null } } /// - /// Replace an image background with Ideogram 3.0
- /// Replaces the background of one image from a text prompt while preserving
- /// the foreground subject, generated by Ideogram 3.0 inpainting. The
- /// foreground mask is detected automatically; callers do not provide a mask.
- /// The request is processed asynchronously. Poll
- /// `GET /v1/generations/{generation_id}` with the returned `generation_id`
- /// until the generation is completed or failed.
- /// Supply exactly one source transport: an existing `AssetIdentifier` in
- /// `image_asset_identifier`, or raw `image` bytes in a multipart request.
- /// Supplying both or neither is rejected with a 400. The source's longer
- /// side must be at most 3 times its shorter side; wider aspect ratios are
- /// rejected with a 400. + /// Replace background with Ideogram 3.0
+ /// Replace the background of an image from a text prompt with Ideogram 3.0,
+ /// keeping the automatically detected foreground subject; no mask is
+ /// needed. Upload the source `image` using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -842,12 +824,16 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only.
+ /// The longer side must be at most 3 times the shorter side; wider
+ /// aspect ratios are rejected with a 400. /// /// - /// Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,
- /// TIFF, and MPO are supported, up to 50 MB. Multipart requests only. + /// The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and
+ /// MPO are supported, up to 50 MB. Multipart requests only.
+ /// The longer side must be at most 3 times the shorter side; wider
+ /// aspect ratios are rejected with a 400. /// /// /// Plain-language description of the desired new background. @@ -861,9 +847,8 @@ request.Imagename is null /// Default Value: 1 /// /// - /// If true, the user is requesting private generation. If omitted,
- /// this defaults to the user's plan entitlement. Enterprise
- /// generations are always private. + /// Whether to keep the result private. When omitted, defaults to your
+ /// plan's setting. Enterprise generations are always private. /// /// /// HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a
diff --git a/src/libs/Ideogram/Generated/Ideogram.Tools.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.Tools.JsonSerializerContext.g.cs index d05be76b..7a9a0c8e 100644 --- a/src/libs/Ideogram/Generated/Ideogram.Tools.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.Tools.JsonSerializerContext.g.cs @@ -17,10 +17,10 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(int))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(bool))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(byte[]))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.UpscaleImageObject))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.UpscaleToolResponse))] diff --git a/src/libs/Ideogram/Generated/Ideogram.ToolsClient.PostUpscale.g.cs b/src/libs/Ideogram/Generated/Ideogram.ToolsClient.PostUpscale.g.cs index dc71722f..d0b132a1 100644 --- a/src/libs/Ideogram/Generated/Ideogram.ToolsClient.PostUpscale.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.ToolsClient.PostUpscale.g.cs @@ -44,26 +44,13 @@ partial void ProcessPostUpscaleResponseContent( ref string content); /// - /// Upscale an image
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Ideogram selects the best upscaling
- /// model for each request, and the selection may change over time; callers
- /// never choose a model.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400. Uploaded bytes are used for this
- /// request only and are not stored as an asset; upscales of a referenced
- /// asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the source image is enhanced as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with automatic model selection
+ /// Upscale an image to 2x, 4x, or 8x its original resolution with a model
+ /// Ideogram picks per request; the choice may change over time. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -90,26 +77,13 @@ partial void ProcessPostUpscaleResponseContent( return __response.Body; } /// - /// Upscale an image
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Ideogram selects the best upscaling
- /// model for each request, and the selection may change over time; callers
- /// never choose a model.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400. Uploaded bytes are used for this
- /// request only and are not stored as an asset; upscales of a referenced
- /// asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the source image is enhanced as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with automatic model selection
+ /// Upscale an image to 2x, 4x, or 8x its original resolution with a model
+ /// Ideogram picks per request; the choice may change over time. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -857,26 +831,13 @@ request.Imagename is null } } /// - /// Upscale an image
- /// Upscale one image to 2x, 4x, or 8x its original resolution, up to a
- /// maximum output of 8192px per side. Ideogram selects the best upscaling
- /// model for each request, and the selection may change over time; callers
- /// never choose a model.
- /// Supply the source either as an `image_asset_identifier` reference (an
- /// image already stored with Ideogram) or as raw `image` bytes (multipart
- /// requests only). Provide exactly one of the two forms; supplying both,
- /// or neither, is rejected with a 400. Uploaded bytes are used for this
- /// request only and are not stored as an asset; upscales of a referenced
- /// asset keep a visible link to their source image.
- /// Upscaling takes no prompt: the source image is enhanced as-is.
- /// By default the request blocks until the upscaled image is ready and
- /// returns it in `data`. Set `async` to true to return immediately after
- /// the request is accepted, then poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using the returned
- /// `generation_id`.
- /// Supplying a `webhook_url` makes the request asynchronous whatever
- /// `async` says: the response returns as soon as the request is accepted,
- /// and the finished result is POSTed to that URL. + /// Upscale with automatic model selection
+ /// Upscale an image to 2x, 4x, or 8x its original resolution with a model
+ /// Ideogram picks per request; the choice may change over time. Upload the
+ /// source `image` using `multipart/form-data`.
+ /// Returns results directly by default; set `async` or supply a
+ /// `webhook_url` to get a `generation_id` and poll
+ /// `GET /v2/generations/{generation_id}`. ///
/// /// Default Value: false @@ -886,10 +847,10 @@ request.Imagename is null /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. The bytes are used for this request only and are not stored as an asset. + /// The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// How much to enlarge the source image: 2x, 4x, or 8x its original width and height. Rejected when the output would exceed 8192px on either side.
@@ -904,7 +865,7 @@ request.Imagename is null /// Default Value: false /// /// - /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.
+ /// When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.
/// Default Value: false /// /// diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoEdit.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoEdit.JsonSerializerContext.g.cs index e2b7cf18..f4a29536 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoEdit.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoEdit.JsonSerializerContext.g.cs @@ -20,9 +20,12 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.DateTime))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(float))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance2Response))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.SeedDance2Resolution), TypeInfoPropertyName = "SeedDance2Resolution2")] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponse))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.MinimaxH3AspectRatio), TypeInfoPropertyName = "MinimaxH3AspectRatio2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.MinimaxH3Resolution), TypeInfoPropertyName = "MinimaxH3Resolution2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoMinimaxH3Response))] @@ -36,6 +39,8 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.DateTime?))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(float?))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.SeedDance2Resolution?), TypeInfoPropertyName = "NullableSeedDance2Resolution2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason?), TypeInfoPropertyName = "NullableGenerationRejectReason2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed?), TypeInfoPropertyName = "NullableGenerationErrorResponseTaskCompletionSpeed2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.MinimaxH3AspectRatio?), TypeInfoPropertyName = "NullableMinimaxH3AspectRatio2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.MinimaxH3Resolution?), TypeInfoPropertyName = "NullableMinimaxH3Resolution2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.MinimaxH3PromptExpansionMode?), TypeInfoPropertyName = "NullableMinimaxH3PromptExpansionMode2")] @@ -111,14 +116,22 @@ private sealed class LazyEnumJsonConverterFactory : global::System.Text.Json.Ser public override bool CanConvert(global::System.Type typeToConvert) { return - typeToConvert == typeof(global::Ideogram.SeedDance2Resolution) + typeToConvert == typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed) - || typeToConvert == typeof(global::Ideogram.SeedDance2Resolution?) + || typeToConvert == typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed?) + + || typeToConvert == typeof(global::Ideogram.GenerationRejectReason) + + || typeToConvert == typeof(global::Ideogram.GenerationRejectReason?) || typeToConvert == typeof(global::Ideogram.AssetType) || typeToConvert == typeof(global::Ideogram.AssetType?) + || typeToConvert == typeof(global::Ideogram.SeedDance2Resolution) + + || typeToConvert == typeof(global::Ideogram.SeedDance2Resolution?) + || typeToConvert == typeof(global::Ideogram.MinimaxH3AspectRatio) || typeToConvert == typeof(global::Ideogram.MinimaxH3AspectRatio?) @@ -136,14 +149,24 @@ public override bool CanConvert(global::System.Type typeToConvert) global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options) { - if (typeToConvert == typeof(global::Ideogram.SeedDance2Resolution)) + if (typeToConvert == typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed)) { - return new global::Ideogram.JsonConverters.SeedDance2ResolutionJsonConverter(); + return new global::Ideogram.JsonConverters.GenerationErrorResponseTaskCompletionSpeedJsonConverter(); } - if (typeToConvert == typeof(global::Ideogram.SeedDance2Resolution?)) + if (typeToConvert == typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed?)) { - return new global::Ideogram.JsonConverters.SeedDance2ResolutionNullableJsonConverter(); + return new global::Ideogram.JsonConverters.GenerationErrorResponseTaskCompletionSpeedNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.GenerationRejectReason)) + { + return new global::Ideogram.JsonConverters.GenerationRejectReasonJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.GenerationRejectReason?)) + { + return new global::Ideogram.JsonConverters.GenerationRejectReasonNullableJsonConverter(); } if (typeToConvert == typeof(global::Ideogram.AssetType)) @@ -156,6 +179,16 @@ public override bool CanConvert(global::System.Type typeToConvert) return new global::Ideogram.JsonConverters.AssetTypeNullableJsonConverter(); } + if (typeToConvert == typeof(global::Ideogram.SeedDance2Resolution)) + { + return new global::Ideogram.JsonConverters.SeedDance2ResolutionJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.SeedDance2Resolution?)) + { + return new global::Ideogram.JsonConverters.SeedDance2ResolutionNullableJsonConverter(); + } + if (typeToConvert == typeof(global::Ideogram.MinimaxH3AspectRatio)) { return new global::Ideogram.JsonConverters.MinimaxH3AspectRatioJsonConverter(); diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoEditClient.PostEditVideoMinimaxH3ReferenceToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoEditClient.PostEditVideoMinimaxH3ReferenceToVideo.g.cs index cae431f0..504f3ace 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoEditClient.PostEditVideoMinimaxH3ReferenceToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoEditClient.PostEditVideoMinimaxH3ReferenceToVideo.g.cs @@ -44,32 +44,12 @@ partial void ProcessPostEditVideoMinimaxH3ReferenceToVideoResponseContent( ref string content); /// - /// Produce a video from reference media with MiniMax H3
- /// Produce a video from a text prompt and reference media with MiniMax H3.
- /// The prompt addresses the references by position: the first reference
- /// image is `Image 1`, the second `Image 2`, the first reference video is
- /// `Video 1`, and the first reference audio is `Audio 1`. Supply reference
- /// images either as
- /// `reference_image_asset_identifiers` (images already stored with
- /// Ideogram) or as raw `reference_images` bytes (multipart requests only);
- /// supplying both is rejected, and uploaded bytes are used for this request
- /// only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which must reference videos
- /// generated or uploaded with Ideogram. At most 9 reference images and 3 reference
- /// videos are accepted, and reference videos are capped again on clip
- /// length. Optional `reference_audios` accepts MP3/WAV uploads alongside
- /// an image or video. Audio and video references must total at most 15
- /// seconds; at most 12 references are accepted across all media.
- /// References are optional. With none, the video is produced from the
- /// prompt alone.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with MiniMax H3
+ /// Produce a video from a text prompt and optional reference media with
+ /// MiniMax H3. Upload `reference_images` and `reference_audios` using
+ /// `multipart/form-data`, and address them in the prompt by position
+ /// (`Image 1`, `Audio 1`, …). Returns a `generation_id`; poll
+ /// `GET /v2/generations/{generation_id}` or supply a `webhook_url`. ///
/// /// Default Value: false @@ -96,32 +76,12 @@ partial void ProcessPostEditVideoMinimaxH3ReferenceToVideoResponseContent( return __response.Body; } /// - /// Produce a video from reference media with MiniMax H3
- /// Produce a video from a text prompt and reference media with MiniMax H3.
- /// The prompt addresses the references by position: the first reference
- /// image is `Image 1`, the second `Image 2`, the first reference video is
- /// `Video 1`, and the first reference audio is `Audio 1`. Supply reference
- /// images either as
- /// `reference_image_asset_identifiers` (images already stored with
- /// Ideogram) or as raw `reference_images` bytes (multipart requests only);
- /// supplying both is rejected, and uploaded bytes are used for this request
- /// only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which must reference videos
- /// generated or uploaded with Ideogram. At most 9 reference images and 3 reference
- /// videos are accepted, and reference videos are capped again on clip
- /// length. Optional `reference_audios` accepts MP3/WAV uploads alongside
- /// an image or video. Audio and video references must total at most 15
- /// seconds; at most 12 references are accepted across all media.
- /// References are optional. With none, the video is produced from the
- /// prompt alone.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with MiniMax H3
+ /// Produce a video from a text prompt and optional reference media with
+ /// MiniMax H3. Upload `reference_images` and `reference_audios` using
+ /// `multipart/form-data`, and address them in the prompt by position
+ /// (`Image 1`, `Audio 1`, …). Returns a `generation_id`; poll
+ /// `GET /v2/generations/{generation_id}` or supply a `webhook_url`. ///
/// /// Default Value: false @@ -576,20 +536,24 @@ partial void ProcessPostEditVideoMinimaxH3ReferenceToVideoResponseContent( h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -598,11 +562,12 @@ partial void ProcessPostEditVideoMinimaxH3ReferenceToVideoResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -704,20 +669,24 @@ partial void ProcessPostEditVideoMinimaxH3ReferenceToVideoResponseContent( h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -726,11 +695,12 @@ partial void ProcessPostEditVideoMinimaxH3ReferenceToVideoResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -897,32 +867,12 @@ partial void ProcessPostEditVideoMinimaxH3ReferenceToVideoResponseContent( } } /// - /// Produce a video from reference media with MiniMax H3
- /// Produce a video from a text prompt and reference media with MiniMax H3.
- /// The prompt addresses the references by position: the first reference
- /// image is `Image 1`, the second `Image 2`, the first reference video is
- /// `Video 1`, and the first reference audio is `Audio 1`. Supply reference
- /// images either as
- /// `reference_image_asset_identifiers` (images already stored with
- /// Ideogram) or as raw `reference_images` bytes (multipart requests only);
- /// supplying both is rejected, and uploaded bytes are used for this request
- /// only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which must reference videos
- /// generated or uploaded with Ideogram. At most 9 reference images and 3 reference
- /// videos are accepted, and reference videos are capped again on clip
- /// length. Optional `reference_audios` accepts MP3/WAV uploads alongside
- /// an image or video. Audio and video references must total at most 15
- /// seconds; at most 12 references are accepted across all media.
- /// References are optional. With none, the video is produced from the
- /// prompt alone.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with MiniMax H3
+ /// Produce a video from a text prompt and optional reference media with
+ /// MiniMax H3. Upload `reference_images` and `reference_audios` using
+ /// `multipart/form-data`, and address them in the prompt by position
+ /// (`Image 1`, `Audio 1`, …). Returns a `generation_id`; poll
+ /// `GET /v2/generations/{generation_id}` or supply a `webhook_url`. ///
/// /// Default Value: false @@ -935,7 +885,7 @@ partial void ProcessPostEditVideoMinimaxH3ReferenceToVideoResponseContent( /// Images already stored with Ideogram to use as references, by reference, in prompt order. Cannot be combined with `reference_images`. Only image assets are accepted. /// /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Uploaded images are used for this request only and are not stored. /// /// /// Videos generated or uploaded with Ideogram to use as motion references, by reference, in prompt order. Each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds. Raw video uploads are not accepted. diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoEditClient.PostEditVideoSeedDance2.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoEditClient.PostEditVideoSeedDance2.g.cs index 210d6d97..28abb144 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoEditClient.PostEditVideoSeedDance2.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoEditClient.PostEditVideoSeedDance2.g.cs @@ -44,7 +44,7 @@ partial void ProcessPostEditVideoSeedDance2ResponseContent( ref string content); /// - /// Edit a video with Seedance 2.0 by regenerating from frames of it
+ /// Edit video with Seedance 2.0
/// Edit a video you already have stored with Ideogram by replacing part of
/// it. Reference the source video with `video_asset_identifier` and mark the
/// span to replace with `start_frame_time` and `end_frame_time`, in seconds.
@@ -68,7 +68,7 @@ partial void ProcessPostEditVideoSeedDance2ResponseContent( /// Video generation always runs asynchronously: the response returns as
/// soon as the request is accepted and carries only a `generation_id`.
/// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
+ /// `GET /v2/generations/{generation_id}` using that id, or supply a
/// `webhook_url` to have the finished result POSTed to your server
/// instead.
/// Video links are available for a limited period of time; download the
@@ -99,7 +99,7 @@ partial void ProcessPostEditVideoSeedDance2ResponseContent( return __response.Body; } /// - /// Edit a video with Seedance 2.0 by regenerating from frames of it
+ /// Edit video with Seedance 2.0
/// Edit a video you already have stored with Ideogram by replacing part of
/// it. Reference the source video with `video_asset_identifier` and mark the
/// span to replace with `start_frame_time` and `end_frame_time`, in seconds.
@@ -123,7 +123,7 @@ partial void ProcessPostEditVideoSeedDance2ResponseContent( /// Video generation always runs asynchronously: the response returns as
/// soon as the request is accepted and carries only a `generation_id`.
/// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
+ /// `GET /v2/generations/{generation_id}` using that id, or supply a
/// `webhook_url` to have the finished result POSTed to your server
/// instead.
/// Video links are available for a limited period of time; download the
@@ -471,20 +471,24 @@ partial void ProcessPostEditVideoSeedDance2ResponseContent( h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -493,11 +497,12 @@ partial void ProcessPostEditVideoSeedDance2ResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -599,20 +604,24 @@ partial void ProcessPostEditVideoSeedDance2ResponseContent( h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -621,11 +630,12 @@ partial void ProcessPostEditVideoSeedDance2ResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -792,7 +802,7 @@ partial void ProcessPostEditVideoSeedDance2ResponseContent( } } /// - /// Edit a video with Seedance 2.0 by regenerating from frames of it
+ /// Edit video with Seedance 2.0
/// Edit a video you already have stored with Ideogram by replacing part of
/// it. Reference the source video with `video_asset_identifier` and mark the
/// span to replace with `start_frame_time` and `end_frame_time`, in seconds.
@@ -816,7 +826,7 @@ partial void ProcessPostEditVideoSeedDance2ResponseContent( /// Video generation always runs asynchronously: the response returns as
/// soon as the request is accepted and carries only a `generation_id`.
/// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
+ /// `GET /v2/generations/{generation_id}` using that id, or supply a
/// `webhook_url` to have the finished result POSTed to your server
/// instead.
/// Video links are available for a limited period of time; download the
diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerate.JsonSerializerContext.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerate.JsonSerializerContext.g.cs index f9522f71..7364c20b 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerate.JsonSerializerContext.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerate.JsonSerializerContext.g.cs @@ -20,6 +20,7 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.IList))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.DateTime))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(float))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance2Response))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance2TextToVideoRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.SeedDance2AspectRatio), TypeInfoPropertyName = "SeedDance2AspectRatio2")] @@ -28,7 +29,6 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationRejectReason), TypeInfoPropertyName = "GenerationRejectReason2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerationErrorResponseTaskCompletionSpeed), TypeInfoPropertyName = "GenerationErrorResponseTaskCompletionSpeed2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance2ImageToVideoRequest))] - [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetIdentifier))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance25Response))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance25TextToVideoRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.SeedDance25Resolution), TypeInfoPropertyName = "SeedDance25Resolution2")] @@ -48,6 +48,9 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.GenerateVideoSeedDance25ReferenceToVideoRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.Product360VideoRequest))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.Product360VideoDirection), TypeInfoPropertyName = "Product360VideoDirection2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LivingImageResponse))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LivingImageRequest))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LivingImageQuality), TypeInfoPropertyName = "LivingImageQuality2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetType), TypeInfoPropertyName = "AssetType2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(int?))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(bool?))] @@ -63,6 +66,7 @@ namespace Ideogram [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.KlingV3AspectRatio?), TypeInfoPropertyName = "NullableKlingV3AspectRatio2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.KlingV3ShotType?), TypeInfoPropertyName = "NullableKlingV3ShotType2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.Product360VideoDirection?), TypeInfoPropertyName = "NullableProduct360VideoDirection2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.LivingImageQuality?), TypeInfoPropertyName = "NullableLivingImageQuality2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Ideogram.AssetType?), TypeInfoPropertyName = "NullableAssetType2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::System.Collections.Generic.List))] @@ -151,6 +155,14 @@ public override bool CanConvert(global::System.Type typeToConvert) || typeToConvert == typeof(global::Ideogram.Product360VideoDirection?) + || typeToConvert == typeof(global::Ideogram.LivingImageQuality) + + || typeToConvert == typeof(global::Ideogram.LivingImageQuality?) + + || typeToConvert == typeof(global::Ideogram.AssetType) + + || typeToConvert == typeof(global::Ideogram.AssetType?) + || typeToConvert == typeof(global::Ideogram.SeedDance2AspectRatio) || typeToConvert == typeof(global::Ideogram.SeedDance2AspectRatio?) @@ -159,10 +171,6 @@ public override bool CanConvert(global::System.Type typeToConvert) || typeToConvert == typeof(global::Ideogram.SeedDance2Resolution?) - || typeToConvert == typeof(global::Ideogram.AssetType) - - || typeToConvert == typeof(global::Ideogram.AssetType?) - || typeToConvert == typeof(global::Ideogram.MinimaxH3AspectRatio) || typeToConvert == typeof(global::Ideogram.MinimaxH3AspectRatio?) @@ -224,6 +232,26 @@ public override bool CanConvert(global::System.Type typeToConvert) return new global::Ideogram.JsonConverters.Product360VideoDirectionNullableJsonConverter(); } + if (typeToConvert == typeof(global::Ideogram.LivingImageQuality)) + { + return new global::Ideogram.JsonConverters.LivingImageQualityJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.LivingImageQuality?)) + { + return new global::Ideogram.JsonConverters.LivingImageQualityNullableJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.AssetType)) + { + return new global::Ideogram.JsonConverters.AssetTypeJsonConverter(); + } + + if (typeToConvert == typeof(global::Ideogram.AssetType?)) + { + return new global::Ideogram.JsonConverters.AssetTypeNullableJsonConverter(); + } + if (typeToConvert == typeof(global::Ideogram.SeedDance2AspectRatio)) { return new global::Ideogram.JsonConverters.SeedDance2AspectRatioJsonConverter(); @@ -244,16 +272,6 @@ public override bool CanConvert(global::System.Type typeToConvert) return new global::Ideogram.JsonConverters.SeedDance2ResolutionNullableJsonConverter(); } - if (typeToConvert == typeof(global::Ideogram.AssetType)) - { - return new global::Ideogram.JsonConverters.AssetTypeJsonConverter(); - } - - if (typeToConvert == typeof(global::Ideogram.AssetType?)) - { - return new global::Ideogram.JsonConverters.AssetTypeNullableJsonConverter(); - } - if (typeToConvert == typeof(global::Ideogram.MinimaxH3AspectRatio)) { return new global::Ideogram.JsonConverters.MinimaxH3AspectRatioJsonConverter(); diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoKlingV3StandardImageToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoKlingV3StandardImageToVideo.g.cs index e7f767c1..8715df99 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoKlingV3StandardImageToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoKlingV3StandardImageToVideo.g.cs @@ -44,29 +44,12 @@ partial void ProcessPostGenerateVideoKlingV3StandardImageToVideoResponseContent( ref string content); /// - /// Generate a video from a first frame with Kling v3 Standard, by asset id or by uploaded bytes
+ /// Image to video with Kling v3 Standard
/// Generate a video from a first-frame image and a text prompt with Kling
- /// v3 Standard. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// there is no aspect ratio to set.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// v3 Standard. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -93,29 +76,12 @@ partial void ProcessPostGenerateVideoKlingV3StandardImageToVideoResponseContent( return __response.Body; } /// - /// Generate a video from a first frame with Kling v3 Standard, by asset id or by uploaded bytes
+ /// Image to video with Kling v3 Standard
/// Generate a video from a first-frame image and a text prompt with Kling
- /// v3 Standard. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// there is no aspect ratio to set.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// v3 Standard. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -957,29 +923,12 @@ request.EndImagename is null } } /// - /// Generate a video from a first frame with Kling v3 Standard, by asset id or by uploaded bytes
+ /// Image to video with Kling v3 Standard
/// Generate a video from a first-frame image and a text prompt with Kling
- /// v3 Standard. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// there is no aspect ratio to set.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// v3 Standard. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -988,19 +937,19 @@ request.EndImagename is null /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// A natural-language prompt describing how the first frame should animate.
diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoKlingV3StandardTextToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoKlingV3StandardTextToVideo.g.cs index 3214b61f..ba19d1a4 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoKlingV3StandardTextToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoKlingV3StandardTextToVideo.g.cs @@ -44,16 +44,10 @@ partial void ProcessPostGenerateVideoKlingV3StandardTextToVideoResponseContent( ref string content); /// - /// Generate a video from a text prompt with Kling v3 Standard
+ /// Text to video with Kling v3 Standard
/// Generate a video from a text prompt with Kling v3 Standard.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -80,16 +74,10 @@ partial void ProcessPostGenerateVideoKlingV3StandardTextToVideoResponseContent( return __response.Body; } /// - /// Generate a video from a text prompt with Kling v3 Standard
+ /// Text to video with Kling v3 Standard
/// Generate a video from a text prompt with Kling v3 Standard.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -732,16 +720,10 @@ partial void ProcessPostGenerateVideoKlingV3StandardTextToVideoResponseContent( } } /// - /// Generate a video from a text prompt with Kling v3 Standard
+ /// Text to video with Kling v3 Standard
/// Generate a video from a text prompt with Kling v3 Standard.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoMinimaxH3ImageToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoMinimaxH3ImageToVideo.g.cs index 3c4beec1..094a3321 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoMinimaxH3ImageToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoMinimaxH3ImageToVideo.g.cs @@ -44,29 +44,12 @@ partial void ProcessPostGenerateVideoMinimaxH3ImageToVideoResponseContent( ref string content); /// - /// Generate a video from a first frame with MiniMax H3, by asset id or by uploaded bytes
+ /// Image to video with MiniMax H3
/// Generate a video from a first-frame image and a text prompt with
- /// MiniMax H3. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// this endpoint accepts no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// MiniMax H3. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -93,29 +76,12 @@ partial void ProcessPostGenerateVideoMinimaxH3ImageToVideoResponseContent( return __response.Body; } /// - /// Generate a video from a first frame with MiniMax H3, by asset id or by uploaded bytes
+ /// Image to video with MiniMax H3
/// Generate a video from a first-frame image and a text prompt with
- /// MiniMax H3. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// this endpoint accepts no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// MiniMax H3. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -933,29 +899,12 @@ request.EndImagename is null } } /// - /// Generate a video from a first frame with MiniMax H3, by asset id or by uploaded bytes
+ /// Image to video with MiniMax H3
/// Generate a video from a first-frame image and a text prompt with
- /// MiniMax H3. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// The generated video takes its aspect ratio from the first frame, so
- /// this endpoint accepts no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// MiniMax H3. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -964,19 +913,19 @@ request.EndImagename is null /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// A natural-language prompt describing how the first frame should animate.
diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoMinimaxH3TextToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoMinimaxH3TextToVideo.g.cs index 9feabc26..1f61d146 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoMinimaxH3TextToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoMinimaxH3TextToVideo.g.cs @@ -44,16 +44,10 @@ partial void ProcessPostGenerateVideoMinimaxH3TextToVideoResponseContent( ref string content); /// - /// Generate a video from a text prompt with MiniMax H3
+ /// Text to video with MiniMax H3
/// Generate a video from a text prompt with MiniMax H3.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -80,16 +74,10 @@ partial void ProcessPostGenerateVideoMinimaxH3TextToVideoResponseContent( return __response.Body; } /// - /// Generate a video from a text prompt with MiniMax H3
+ /// Text to video with MiniMax H3
/// Generate a video from a text prompt with MiniMax H3.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -732,16 +720,10 @@ partial void ProcessPostGenerateVideoMinimaxH3TextToVideoResponseContent( } } /// - /// Generate a video from a text prompt with MiniMax H3
+ /// Text to video with MiniMax H3
/// Generate a video from a text prompt with MiniMax H3.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25ImageToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25ImageToVideo.g.cs index 6a0d4b25..054268a0 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25ImageToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25ImageToVideo.g.cs @@ -44,29 +44,12 @@ partial void ProcessPostGenerateVideoSeedDance25ImageToVideoResponseContent( ref string content); /// - /// Generate a video from a first frame with Seedance 2.5, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.5
/// Generate a video from a first-frame image and a text prompt with
- /// Seedance 2.5. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// Seedance 2.5 always derives an image-to-video result's aspect ratio
- /// from its first frame, so this endpoint takes no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Seedance 2.5. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -93,29 +76,12 @@ partial void ProcessPostGenerateVideoSeedDance25ImageToVideoResponseContent( return __response.Body; } /// - /// Generate a video from a first frame with Seedance 2.5, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.5
/// Generate a video from a first-frame image and a text prompt with
- /// Seedance 2.5. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// Seedance 2.5 always derives an image-to-video result's aspect ratio
- /// from its first frame, so this endpoint takes no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Seedance 2.5. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -941,29 +907,12 @@ request.EndImagename is null } } /// - /// Generate a video from a first frame with Seedance 2.5, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.5
/// Generate a video from a first-frame image and a text prompt with
- /// Seedance 2.5. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional and follows the same
- /// one-form-only rule.
- /// Seedance 2.5 always derives an image-to-video result's aspect ratio
- /// from its first frame, so this endpoint takes no `aspect_ratio`.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Seedance 2.5. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -972,19 +921,19 @@ request.EndImagename is null /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// A natural-language prompt describing how the first frame should animate.
diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25ReferenceToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25ReferenceToVideo.g.cs index 7969162e..48c15bdc 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25ReferenceToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25ReferenceToVideo.g.cs @@ -44,34 +44,12 @@ partial void ProcessPostGenerateVideoSeedDance25ReferenceToVideoResponseContent( ref string content); /// - /// Produce a video from reference images and videos with Seedance 2.5
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.5.
- /// The prompt addresses the references by position: the first reference
- /// image is `[Image1]`, the second
- /// `[Image2]`, the first reference video is
- /// `[Video1]`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 10
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds.
- /// Supply up to 10 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–30 seconds, with at most 30 seconds total. Reference
- /// them as `[Audio1]`, `[Audio2]`, and so on. Audio is used for this request only.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.5
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.5. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -98,34 +76,12 @@ partial void ProcessPostGenerateVideoSeedDance25ReferenceToVideoResponseContent( return __response.Body; } /// - /// Produce a video from reference images and videos with Seedance 2.5
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.5.
- /// The prompt addresses the references by position: the first reference
- /// image is `[Image1]`, the second
- /// `[Image2]`, the first reference video is
- /// `[Video1]`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 10
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds.
- /// Supply up to 10 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–30 seconds, with at most 30 seconds total. Reference
- /// them as `[Audio1]`, `[Audio2]`, and so on. Audio is used for this request only.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.5
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.5. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -580,20 +536,24 @@ partial void ProcessPostGenerateVideoSeedDance25ReferenceToVideoResponseContent( h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -602,11 +562,12 @@ partial void ProcessPostGenerateVideoSeedDance25ReferenceToVideoResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -708,20 +669,24 @@ partial void ProcessPostGenerateVideoSeedDance25ReferenceToVideoResponseContent( h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -730,11 +695,12 @@ partial void ProcessPostGenerateVideoSeedDance25ReferenceToVideoResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -901,53 +867,31 @@ partial void ProcessPostGenerateVideoSeedDance25ReferenceToVideoResponseContent( } } /// - /// Produce a video from reference images and videos with Seedance 2.5
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.5.
- /// The prompt addresses the references by position: the first reference
- /// image is `[Image1]`, the second
- /// `[Image2]`, the first reference video is
- /// `[Video1]`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 10
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds.
- /// Supply up to 10 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–30 seconds, with at most 30 seconds total. Reference
- /// them as `[Audio1]`, `[Audio2]`, and so on. Audio is used for this request only.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.5
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.5. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false /// /// - /// A natural-language prompt describing the video to produce. Reference media is addressed by position, as in "[Image1] walks toward the camera with the motion of [Video1]".
+ /// A natural-language prompt describing the video to produce. Refer to references by position, as in "[Image1] walks toward the camera".
/// Example: [Image1] walks through the snowy forest at dawn. /// /// /// Images already stored with Ideogram to use as references, by reference, in prompt order. Cannot be combined with `reference_images`. Only image assets are accepted. /// /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Reference images, in prompt order. Common formats such as JPEG, PNG, and WEBP are supported, up to 50MB each. Multipart requests only. Uploaded images are used for this request only and are not stored. /// /// /// Uploaded or generated videos to use as references, by reference, in prompt order. Each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds. Upload video files first and pass their asset identifiers. /// /// - /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 30 seconds; combined duration must not exceed 30 seconds. At least one reference image or video is required. Audio is used for this generation only and is not saved to your library. + /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 30 seconds long, with a combined duration of at most 30 seconds. Requires at least one reference image. Audio is used for this request only and is not saved to your library. /// /// /// The aspect ratio of the generated video. `AUTO` lets the model choose the
diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25TextToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25TextToVideo.g.cs index fe2d68b7..762e6b6f 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25TextToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance25TextToVideo.g.cs @@ -44,17 +44,10 @@ partial void ProcessPostGenerateVideoSeedDance25TextToVideoResponseContent( ref string content); /// - /// Generate a video from a text prompt with Seedance 2.5
- /// Generate a video from a text prompt with Seedance 2.5, which serves
- /// resolutions up to 1080p and durations up to 30 seconds.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Text to video with Seedance 2.5
+ /// Generate a video from a text prompt with Seedance 2.5, at up to 1080p and
+ /// 30 seconds. Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -81,17 +74,10 @@ partial void ProcessPostGenerateVideoSeedDance25TextToVideoResponseContent( return __response.Body; } /// - /// Generate a video from a text prompt with Seedance 2.5
- /// Generate a video from a text prompt with Seedance 2.5, which serves
- /// resolutions up to 1080p and durations up to 30 seconds.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Text to video with Seedance 2.5
+ /// Generate a video from a text prompt with Seedance 2.5, at up to 1080p and
+ /// 30 seconds. Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -734,17 +720,10 @@ partial void ProcessPostGenerateVideoSeedDance25TextToVideoResponseContent( } } /// - /// Generate a video from a text prompt with Seedance 2.5
- /// Generate a video from a text prompt with Seedance 2.5, which serves
- /// resolutions up to 1080p and durations up to 30 seconds.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Text to video with Seedance 2.5
+ /// Generate a video from a text prompt with Seedance 2.5, at up to 1080p and
+ /// 30 seconds. Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2ImageToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2ImageToVideo.g.cs index 2eeff882..afb375fa 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2ImageToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2ImageToVideo.g.cs @@ -44,27 +44,12 @@ partial void ProcessPostGenerateVideoSeedDance2ImageToVideoResponseContent( ref string content); /// - /// Generate a video from a first frame with Seedance 2.0, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.0
/// Generate one or more videos from a first-frame image and a text prompt
- /// with Seedance 2.0. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional, follows the same one-form-only
- /// rule, and requires a first frame.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// with Seedance 2.0. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -91,27 +76,12 @@ partial void ProcessPostGenerateVideoSeedDance2ImageToVideoResponseContent( return __response.Body; } /// - /// Generate a video from a first frame with Seedance 2.0, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.0
/// Generate one or more videos from a first-frame image and a text prompt
- /// with Seedance 2.0. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional, follows the same one-form-only
- /// rule, and requires a first frame.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// with Seedance 2.0. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -945,27 +915,12 @@ request.EndImagename is null } } /// - /// Generate a video from a first frame with Seedance 2.0, by asset id or by uploaded bytes
+ /// Image to video with Seedance 2.0
/// Generate one or more videos from a first-frame image and a text prompt
- /// with Seedance 2.0. Supply the first frame either as an
- /// `image_asset_identifier` reference (an image already stored with
- /// Ideogram) or as raw `image` bytes (multipart requests only) — callers
- /// are never required to upload the asset first. Exactly one source is
- /// required; supplying neither or both is rejected. Only image assets are
- /// accepted as a first frame. Uploaded bytes are used for this request
- /// only and are not stored as an asset.
- /// To generate a transition between two stills, supply a final frame as
- /// well, in either of the same two forms: `end_image_asset_identifier` or
- /// `end_image`. The final frame is optional, follows the same one-form-only
- /// rule, and requires a first frame.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// with Seedance 2.0. Upload the first frame as `image`, and optionally a final
+ /// frame as `end_image`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -974,19 +929,19 @@ request.EndImagename is null /// A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// - /// The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset. + /// The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored. /// /// /// An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// - /// An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset. + /// An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one. /// /// /// A natural-language prompt describing how the first frame should animate.
diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2ReferenceToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2ReferenceToVideo.g.cs index 0363f105..89766993 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2ReferenceToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2ReferenceToVideo.g.cs @@ -44,35 +44,12 @@ partial void ProcessPostGenerateVideoSeedDance2ReferenceToVideoResponseContent( ref string content); /// - /// Produce a video from reference images and videos with Seedance 2.0
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.0.
- /// The prompt addresses the references by position: the first reference
- /// image is `@Image1`, the second
- /// `@Image2`, the first reference video is
- /// `@Video1`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 3
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds.
- /// Supply up to 3 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–15 seconds, with at most 15 seconds total. Reference
- /// them as `@Audio1`, `@Audio2`, and so on. Audio is used for this request only.
- /// Images, videos, and audio combined must not exceed 12 references.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.0
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.0. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -99,35 +76,12 @@ partial void ProcessPostGenerateVideoSeedDance2ReferenceToVideoResponseContent( return __response.Body; } /// - /// Produce a video from reference images and videos with Seedance 2.0
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.0.
- /// The prompt addresses the references by position: the first reference
- /// image is `@Image1`, the second
- /// `@Image2`, the first reference video is
- /// `@Video1`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 3
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds.
- /// Supply up to 3 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–15 seconds, with at most 15 seconds total. Reference
- /// them as `@Audio1`, `@Audio2`, and so on. Audio is used for this request only.
- /// Images, videos, and audio combined must not exceed 12 references.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.0
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.0. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -582,20 +536,24 @@ partial void ProcessPostGenerateVideoSeedDance2ReferenceToVideoResponseContent( h => h.Key, h => h.Value)); } - // + // Insufficient credits or quota. if ((int)__response.StatusCode == 402) { string? __content_402 = null; global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; try { if (__effectiveReadResponseAsString) { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } else { __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -604,11 +562,12 @@ partial void ProcessPostGenerateVideoSeedDance2ReferenceToVideoResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_402, responseBody: __content_402, + responseObject: __value_402, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -710,20 +669,24 @@ partial void ProcessPostGenerateVideoSeedDance2ReferenceToVideoResponseContent( h => h.Key, h => h.Value)); } - // + // Too many requests. if ((int)__response.StatusCode == 429) { string? __content_429 = null; global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; try { if (__effectiveReadResponseAsString) { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } else { __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); } } catch (global::System.Exception __ex) @@ -732,11 +695,12 @@ partial void ProcessPostGenerateVideoSeedDance2ReferenceToVideoResponseContent( } - throw global::Ideogram.ApiException.Create( + throw global::Ideogram.ApiException.Create( statusCode: __response.StatusCode, message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, innerException: __exception_429, responseBody: __content_429, + responseObject: __value_429, responseHeaders: global::System.Linq.Enumerable.ToDictionary( __response.Headers, h => h.Key, @@ -903,54 +867,31 @@ partial void ProcessPostGenerateVideoSeedDance2ReferenceToVideoResponseContent( } } /// - /// Produce a video from reference images and videos with Seedance 2.0
- /// Produce a video from a text prompt and reference media with
- /// Seedance 2.0.
- /// The prompt addresses the references by position: the first reference
- /// image is `@Image1`, the second
- /// `@Image2`, the first reference video is
- /// `@Video1`, and so on. Supply reference images
- /// either as `reference_image_asset_identifiers` (images already stored
- /// with Ideogram) or as raw `reference_images` bytes (multipart requests
- /// only); supplying both is rejected, and uploaded bytes are used for this
- /// request only and are not stored as an asset. Supply reference videos as
- /// `reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 3
- /// reference videos are accepted, and reference videos are capped again on
- /// clip length: each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds.
- /// Supply up to 3 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.
- /// Each audio clip must be 2–15 seconds, with at most 15 seconds total. Reference
- /// them as `@Audio1`, `@Audio2`, and so on. Audio is used for this request only.
- /// Images, videos, and audio combined must not exceed 12 references.
- /// At least one reference image or video is required: the model
- /// conditions every generation on the media it is given, so a request
- /// with no references is rejected.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Reference to video with Seedance 2.0
+ /// Generate a video from a text prompt and reference media with
+ /// Seedance 2.0. Upload at least one image in `reference_images`, plus optional
+ /// `reference_audios`, using `multipart/form-data`.
+ /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false /// /// - /// A natural-language prompt describing the video to produce. Reference media is addressed by position, as in "@Image1 walks toward the camera with the motion of @Video1".
+ /// A natural-language prompt describing the video to produce. Refer to references by position, as in "@Image1 walks toward the camera".
/// Example: @Image1 walks through the snowy forest at dawn. /// /// /// Images already stored with Ideogram to use as references, by reference, in prompt order. Cannot be combined with `reference_images`. Only image assets are accepted. /// /// - /// Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset. + /// Reference images, in prompt order. Common formats such as JPEG, PNG, and WEBP are supported, up to 50MB each. Multipart requests only. Uploaded images are used for this request only and are not stored. /// /// /// Uploaded or generated videos to use as references, by reference, in prompt order. Each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds. Upload video files first and pass their asset identifiers. /// /// - /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 15 seconds; combined duration must not exceed 15 seconds. At least one reference image or video is required. Audio is used for this generation only and is not saved to your library. + /// MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 15 seconds long, with a combined duration of at most 15 seconds. Requires at least one reference image. Audio is used for this request only and is not saved to your library. /// /// /// The aspect ratio of the generated video. `AUTO` lets the model choose the
diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2TextToVideo.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2TextToVideo.g.cs index ad3704c2..39fcdea9 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2TextToVideo.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostGenerateVideoSeedDance2TextToVideo.g.cs @@ -44,16 +44,10 @@ partial void ProcessPostGenerateVideoSeedDance2TextToVideoResponseContent( ref string content); /// - /// Generate a video from a text prompt with Seedance 2.0
+ /// Text to video with Seedance 2.0
/// Generate one or more videos from a text prompt with Seedance 2.0.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -80,16 +74,10 @@ partial void ProcessPostGenerateVideoSeedDance2TextToVideoResponseContent( return __response.Body; } /// - /// Generate a video from a text prompt with Seedance 2.0
+ /// Text to video with Seedance 2.0
/// Generate one or more videos from a text prompt with Seedance 2.0.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false @@ -732,16 +720,10 @@ partial void ProcessPostGenerateVideoSeedDance2TextToVideoResponseContent( } } /// - /// Generate a video from a text prompt with Seedance 2.0
+ /// Text to video with Seedance 2.0
/// Generate one or more videos from a text prompt with Seedance 2.0.
- /// Video generation always runs asynchronously: the response returns as
- /// soon as the request is accepted and carries only a `generation_id`.
- /// Poll for completion and results with
- /// `GET /v1/generations/{generation_id}` using that id, or supply a
- /// `webhook_url` to have the finished result POSTed to your server
- /// instead.
- /// Video links are available for a limited period of time; download the
- /// video if you want to keep it. + /// Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`
+ /// or supply a `webhook_url`. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostLivingImage.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostLivingImage.g.cs new file mode 100644 index 00000000..3e682f7f --- /dev/null +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostLivingImage.g.cs @@ -0,0 +1,739 @@ + +#nullable enable + +namespace Ideogram +{ + public partial class VideoGenerateClient + { + + + private static readonly global::Ideogram.EndPointSecurityRequirement s_PostLivingImageSecurityRequirement0 = + new global::Ideogram.EndPointSecurityRequirement + { + Authorizations = new global::Ideogram.EndPointAuthorizationRequirement[] + { new global::Ideogram.EndPointAuthorizationRequirement + { + Type = "Http", + SchemeId = "HttpBearer", + Location = "Header", + Name = "Bearer", + FriendlyName = "Bearer", + }, + }, + }; + private static readonly global::Ideogram.EndPointSecurityRequirement[] s_PostLivingImageSecurityRequirements = + new global::Ideogram.EndPointSecurityRequirement[] + { s_PostLivingImageSecurityRequirement0, + }; + partial void PreparePostLivingImageArguments( + global::System.Net.Http.HttpClient httpClient, + ref bool? dryRun, + global::Ideogram.LivingImageRequest request); + partial void PreparePostLivingImageRequest( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpRequestMessage httpRequestMessage, + bool? dryRun, + global::Ideogram.LivingImageRequest request); + partial void ProcessPostLivingImageResponse( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpResponseMessage httpResponseMessage); + + partial void ProcessPostLivingImageResponseContent( + global::System.Net.Http.HttpClient httpClient, + global::System.Net.Http.HttpResponseMessage httpResponseMessage, + ref string content); + + /// + /// Turn a still image into a subtle looping video
+ /// Animates one image into a short, loop-ready clip for use as a living background. The camera stays fixed and only the parts of the scene that would move in real life move: water, light, mist, particles, fabric, creatures. Ideogram inspects the image and writes the motion prompt, so the request needs only the image.
+ /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + ///
+ /// + /// Default Value: false + /// + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + public async global::System.Threading.Tasks.Task PostLivingImageAsync( + + global::Ideogram.LivingImageRequest request, + bool? dryRun = default, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default) + { + var __response = await PostLivingImageAsResponseAsync( + + request: request, + dryRun: dryRun, + requestOptions: requestOptions, + cancellationToken: cancellationToken + ).ConfigureAwait(false); + + return __response.Body; + } + /// + /// Turn a still image into a subtle looping video
+ /// Animates one image into a short, loop-ready clip for use as a living background. The camera stays fixed and only the parts of the scene that would move in real life move: water, light, mist, particles, fabric, creatures. Ideogram inspects the image and writes the motion prompt, so the request needs only the image.
+ /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + ///
+ /// + /// Default Value: false + /// + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + public async global::System.Threading.Tasks.Task> PostLivingImageAsResponseAsync( + + global::Ideogram.LivingImageRequest request, + bool? dryRun = default, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default) + { + request = request ?? throw new global::System.ArgumentNullException(nameof(request)); + + PrepareArguments( + client: HttpClient); + PreparePostLivingImageArguments( + httpClient: HttpClient, + dryRun: ref dryRun, + request: request); + + + var __authorizations = global::Ideogram.EndPointSecurityResolver.ResolveAuthorizations( + availableAuthorizations: Authorizations, + securityRequirements: s_PostLivingImageSecurityRequirements, + operationName: "PostLivingImageAsync"); + + using var __timeoutCancellationTokenSource = global::Ideogram.AutoSDKRequestOptionsSupport.CreateTimeoutCancellationTokenSource( + clientOptions: Options, + requestOptions: requestOptions, + cancellationToken: cancellationToken); + var __effectiveCancellationToken = __timeoutCancellationTokenSource?.Token ?? cancellationToken; + var __effectiveReadResponseAsString = global::Ideogram.AutoSDKRequestOptionsSupport.GetReadResponseAsString( + clientOptions: Options, + requestOptions: requestOptions, + fallbackValue: ReadResponseAsString); + var __maxAttempts = global::Ideogram.AutoSDKRequestOptionsSupport.GetMaxAttempts( + clientOptions: Options, + requestOptions: requestOptions, + supportsRetry: true); + + global::System.Net.Http.HttpRequestMessage __CreateHttpRequest() + { + + var __pathBuilder = new global::Ideogram.PathBuilder( + path: "/v2/tool/living-image", + baseUri: HttpClient.BaseAddress); + __pathBuilder + .AddOptionalParameter("dry_run", dryRun?.ToString().ToLowerInvariant()) + ; + var __path = __pathBuilder.ToString(); + __path = global::Ideogram.AutoSDKRequestOptionsSupport.AppendQueryParameters( + path: __path, + clientParameters: Options.QueryParameters, + requestParameters: requestOptions?.QueryParameters); + var __httpRequest = new global::System.Net.Http.HttpRequestMessage( + method: global::System.Net.Http.HttpMethod.Post, + requestUri: new global::System.Uri(__path, global::System.UriKind.RelativeOrAbsolute)); +#if NET6_0_OR_GREATER + __httpRequest.Version = global::System.Net.HttpVersion.Version11; + __httpRequest.VersionPolicy = global::System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher; +#endif + + foreach (var __authorization in __authorizations) + { + if (__authorization.Type == "Http" || + __authorization.Type == "OAuth2" || + __authorization.Type == "OpenIdConnect") + { + __httpRequest.Headers.Authorization = new global::System.Net.Http.Headers.AuthenticationHeaderValue( + scheme: __authorization.Name, + parameter: __authorization.Value); + } + else if (__authorization.Type == "ApiKey" && + __authorization.Location == "Header") + { + __httpRequest.Headers.Add(__authorization.Name, __authorization.Value); + } + } + var __httpRequestContentBody = request.ToJson(JsonSerializerContext); + var __httpRequestContent = new global::System.Net.Http.StringContent( + content: __httpRequestContentBody, + encoding: global::System.Text.Encoding.UTF8, + mediaType: "application/json"); + __httpRequest.Content = __httpRequestContent; + global::Ideogram.AutoSDKRequestOptionsSupport.ApplyHeaders( + request: __httpRequest, + clientHeaders: Options.Headers, + requestHeaders: requestOptions?.Headers); + + PrepareRequest( + client: HttpClient, + request: __httpRequest); + PreparePostLivingImageRequest( + httpClient: HttpClient, + httpRequestMessage: __httpRequest, + dryRun: dryRun, + request: request); + + return __httpRequest; + } + + global::System.Net.Http.HttpRequestMessage? __httpRequest = null; + global::System.Net.Http.HttpResponseMessage? __response = null; + var __attemptNumber = 0; + try + { + for (var __attempt = 1; __attempt <= __maxAttempts; __attempt++) + { + __attemptNumber = __attempt; + __httpRequest = __CreateHttpRequest(); + await global::Ideogram.AutoSDKRequestOptionsSupport.OnBeforeRequestAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "PostLivingImage", + methodName: "PostLivingImageAsync", + pathTemplate: "\"/v2/tool/living-image\"", + httpMethod: "POST", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: null, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: false, + retryDelay: null, + retryReason: global::System.String.Empty, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + try + { + __response = await HttpClient.SendAsync( + request: __httpRequest, + completionOption: global::System.Net.Http.HttpCompletionOption.ResponseContentRead, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + } + catch (global::System.Net.Http.HttpRequestException __exception) + { + var __retryDelay = global::Ideogram.AutoSDKRequestOptionsSupport.GetRetryDelay( + clientOptions: Options, + requestOptions: requestOptions, + response: null, + attempt: __attempt); + var __willRetry = __attempt < __maxAttempts && !__effectiveCancellationToken.IsCancellationRequested; + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "PostLivingImage", + methodName: "PostLivingImageAsync", + pathTemplate: "\"/v2/tool/living-image\"", + httpMethod: "POST", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: null, + exception: __exception, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: __willRetry, + retryDelay: __willRetry ? __retryDelay : (global::System.TimeSpan?)null, + retryReason: "exception", + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + if (!__willRetry) + { + throw; + } + + __httpRequest.Dispose(); + __httpRequest = null; + await global::Ideogram.AutoSDKRequestOptionsSupport.DelayBeforeRetryAsync( + retryDelay: __retryDelay, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + continue; + } + + if (__response != null && + __attempt < __maxAttempts && + global::Ideogram.AutoSDKRequestOptionsSupport.ShouldRetryStatusCode(__response.StatusCode)) + { + var __retryDelay = global::Ideogram.AutoSDKRequestOptionsSupport.GetRetryDelay( + clientOptions: Options, + requestOptions: requestOptions, + response: __response, + attempt: __attempt); + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "PostLivingImage", + methodName: "PostLivingImageAsync", + pathTemplate: "\"/v2/tool/living-image\"", + httpMethod: "POST", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attempt, + maxAttempts: __maxAttempts, + willRetry: true, + retryDelay: __retryDelay, + retryReason: "status:" + ((int)__response.StatusCode).ToString(global::System.Globalization.CultureInfo.InvariantCulture), + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + __response.Dispose(); + __response = null; + __httpRequest.Dispose(); + __httpRequest = null; + await global::Ideogram.AutoSDKRequestOptionsSupport.DelayBeforeRetryAsync( + retryDelay: __retryDelay, + cancellationToken: __effectiveCancellationToken).ConfigureAwait(false); + continue; + } + + break; + } + + if (__response == null) + { + throw new global::System.InvalidOperationException("No response received."); + } + + using (__response) + { + + ProcessResponse( + client: HttpClient, + response: __response); + ProcessPostLivingImageResponse( + httpClient: HttpClient, + httpResponseMessage: __response); + if (__response.IsSuccessStatusCode) + { + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterSuccessAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "PostLivingImage", + methodName: "PostLivingImageAsync", + pathTemplate: "\"/v2/tool/living-image\"", + httpMethod: "POST", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attemptNumber, + maxAttempts: __maxAttempts, + willRetry: false, + retryDelay: null, + retryReason: global::System.String.Empty, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + } + else + { + await global::Ideogram.AutoSDKRequestOptionsSupport.OnAfterErrorAsync( + clientOptions: Options, + context: global::Ideogram.AutoSDKRequestOptionsSupport.CreateHookContext( + operationId: "PostLivingImage", + methodName: "PostLivingImageAsync", + pathTemplate: "\"/v2/tool/living-image\"", + httpMethod: "POST", + baseUri: BaseUri, + request: __httpRequest ?? throw new global::System.InvalidOperationException("The HTTP request was not created before invoking a request hook."), + response: __response, + exception: null, + clientOptions: Options, + requestOptions: requestOptions, + attempt: __attemptNumber, + maxAttempts: __maxAttempts, + willRetry: false, + retryDelay: null, + retryReason: global::System.String.Empty, + cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); + } + // + if ((int)__response.StatusCode == 400) + { + string? __content_400 = null; + global::System.Exception? __exception_400 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_400 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_400 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_400 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_400 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_400, + responseBody: __content_400, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // + if ((int)__response.StatusCode == 401) + { + string? __content_401 = null; + global::System.Exception? __exception_401 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_401 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_401 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_401 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_401 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_401, + responseBody: __content_401, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // Insufficient credits or quota. + if ((int)__response.StatusCode == 402) + { + string? __content_402 = null; + global::System.Exception? __exception_402 = null; + global::Ideogram.GenerationErrorResponse? __value_402 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); + } + else + { + __content_402 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_402 = global::Ideogram.GenerationErrorResponse.FromJson(__content_402, JsonSerializerContext); + } + } + catch (global::System.Exception __ex) + { + __exception_402 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_402 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_402, + responseBody: __content_402, + responseObject: __value_402, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // + if ((int)__response.StatusCode == 403) + { + string? __content_403 = null; + global::System.Exception? __exception_403 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_403 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_403 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_403 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_403 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_403, + responseBody: __content_403, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // + if ((int)__response.StatusCode == 404) + { + string? __content_404 = null; + global::System.Exception? __exception_404 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_404 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_404 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_404 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_404 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_404, + responseBody: __content_404, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // Too many requests. + if ((int)__response.StatusCode == 429) + { + string? __content_429 = null; + global::System.Exception? __exception_429 = null; + global::Ideogram.GenerationErrorResponse? __value_429 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); + } + else + { + __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Ideogram.GenerationErrorResponse.FromJson(__content_429, JsonSerializerContext); + } + } + catch (global::System.Exception __ex) + { + __exception_429 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_429, + responseBody: __content_429, + responseObject: __value_429, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + // + if ((int)__response.StatusCode == 503) + { + string? __content_503 = null; + global::System.Exception? __exception_503 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_503 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + else + { + __content_503 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + } + } + catch (global::System.Exception __ex) + { + __exception_503 = __ex; + } + + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_503 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_503, + responseBody: __content_503, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + + if (__effectiveReadResponseAsString) + { + var __content = await __response.Content.ReadAsStringAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + + ProcessResponseContent( + client: HttpClient, + response: __response, + content: ref __content); + ProcessPostLivingImageResponseContent( + httpClient: HttpClient, + httpResponseMessage: __response, + content: ref __content); + + try + { + __response.EnsureSuccessStatusCode(); + + var __value = global::Ideogram.LivingImageResponse.FromJson(__content, JsonSerializerContext) ?? + throw new global::System.InvalidOperationException($"Response deserialization failed for \"{__content}\" "); + return new global::Ideogram.AutoSDKHttpResponse( + statusCode: __response.StatusCode, + headers: global::Ideogram.AutoSDKHttpResponse.CreateHeaders(__response), + requestUri: __response.RequestMessage?.RequestUri, + body: __value); + } + catch (global::System.Exception __ex) + { + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content ?? __response.ReasonPhrase ?? string.Empty, + innerException: __ex, + responseBody: __content, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + } + else + { + try + { + __response.EnsureSuccessStatusCode(); + using var __content = await __response.Content.ReadAsStreamAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + + var __value = await global::Ideogram.LivingImageResponse.FromJsonStreamAsync(__content, JsonSerializerContext).ConfigureAwait(false) ?? + throw new global::System.InvalidOperationException("Response deserialization failed."); + return new global::Ideogram.AutoSDKHttpResponse( + statusCode: __response.StatusCode, + headers: global::Ideogram.AutoSDKHttpResponse.CreateHeaders(__response), + requestUri: __response.RequestMessage?.RequestUri, + body: __value); + } + catch (global::System.Exception __ex) + { + string? __content = null; + try + { + __content = await __response.Content.ReadAsStringAsync( + #if NET5_0_OR_GREATER + __effectiveCancellationToken + #endif + ).ConfigureAwait(false); + } + catch (global::System.Exception) + { + } + + throw global::Ideogram.ApiException.Create( + statusCode: __response.StatusCode, + message: __content ?? __response.ReasonPhrase ?? string.Empty, + innerException: __ex, + responseBody: __content, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } + } + + } + } + finally + { + __httpRequest?.Dispose(); + } + } + /// + /// Turn a still image into a subtle looping video
+ /// Animates one image into a short, loop-ready clip for use as a living background. The camera stays fixed and only the parts of the scene that would move in real life move: water, light, mist, particles, fabric, creatures. Ideogram inspects the image and writes the motion prompt, so the request needs only the image.
+ /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + ///
+ /// + /// Default Value: false + /// + /// + /// An identifier for an ideogram asset.
+ /// Example: {"asset_type":"RESPONSE","asset_id":"7uS_VESkRI6O3-sVgHQp_A"} + /// + /// + /// The output resolution tier. `standard` renders at 768P; `high` renders at 2K. Higher tiers cost more.
+ /// Default Value: standard + /// + /// + /// The length of the generated video in seconds.
+ /// Default Value: 8
+ /// Example: 8 + /// + /// + /// A collection you can write to, by its URL-safe base64 collection id. The output video is added to it when the request completes. + /// + /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. + /// The token to cancel the operation with + /// + public async global::System.Threading.Tasks.Task PostLivingImageAsync( + global::Ideogram.AssetIdentifier imageAssetIdentifier, + bool? dryRun = default, + global::Ideogram.LivingImageQuality? quality = default, + int? duration = default, + string? targetCollectionId = default, + global::Ideogram.AutoSDKRequestOptions? requestOptions = default, + global::System.Threading.CancellationToken cancellationToken = default) + { + var __request = new global::Ideogram.LivingImageRequest + { + ImageAssetIdentifier = imageAssetIdentifier, + Quality = quality, + Duration = duration, + TargetCollectionId = targetCollectionId, + }; + + return await PostLivingImageAsync( + dryRun: dryRun, + request: __request, + requestOptions: requestOptions, + cancellationToken: cancellationToken).ConfigureAwait(false); + } + } +} \ No newline at end of file diff --git a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostProduct360Video.g.cs b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostProduct360Video.g.cs index c7cf2d01..0a9832c3 100644 --- a/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostProduct360Video.g.cs +++ b/src/libs/Ideogram/Generated/Ideogram.VideoGenerateClient.PostProduct360Video.g.cs @@ -44,9 +44,9 @@ partial void ProcessPostProduct360VideoResponseContent( ref string content); /// - /// Create a looping 360-degree product video
+ /// Product 360 Video
/// Animates one product image through a complete turntable revolution and returns to the starting pose so the result loops cleanly.
- /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + /// Video generation runs asynchronously. Poll `GET /v2/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. ///
/// /// Default Value: false @@ -73,9 +73,9 @@ partial void ProcessPostProduct360VideoResponseContent( return __response.Body; } /// - /// Create a looping 360-degree product video
+ /// Product 360 Video
/// Animates one product image through a complete turntable revolution and returns to the starting pose so the result loops cleanly.
- /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + /// Video generation runs asynchronously. Poll `GET /v2/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. ///
/// /// Default Value: false @@ -718,9 +718,9 @@ partial void ProcessPostProduct360VideoResponseContent( } } /// - /// Create a looping 360-degree product video
+ /// Product 360 Video
/// Animates one product image through a complete turntable revolution and returns to the starting pose so the result loops cleanly.
- /// Video generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. + /// Video generation runs asynchronously. Poll `GET /v2/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails. ///
/// /// Default Value: false diff --git a/src/libs/Ideogram/Generated/autosdk.generated-examples.json b/src/libs/Ideogram/Generated/autosdk.generated-examples.json index 9747eb53..805e8aac 100644 --- a/src/libs/Ideogram/Generated/autosdk.generated-examples.json +++ b/src/libs/Ideogram/Generated/autosdk.generated-examples.json @@ -2,7 +2,7 @@ "Examples": [ { "Order": 1, - "Title": "List your organization\u0027s API keys", + "Title": "List API keys", "Slug": "get-account-api-keys", "Description": "Lists the API keys in your organization. Key material is redacted \u2014\nthe full key is only shown once, when it is created. Disabled and\narchived keys are included (see each key\u0027s \u0060status\u0060) so historical\nusage can always be matched to the key that generated it.\n\nRequires an API key whose owner is an organization admin. Keys owned\nby other members receive a 404.", "Language": "csharp", @@ -13,7 +13,7 @@ }, { "Order": 2, - "Title": "List your organization\u0027s invoices", + "Title": "List invoices", "Slug": "get-account-invoices", "Description": "Returns your organization\u0027s invoices with their line items \u2014 the\nbilling record your usage reports reconcile against. Amounts are\ndecimal strings in the invoice\u0027s currency.\n\nRequires an API key whose owner is an organization admin. Keys owned\nby other members receive a 404.", "Language": "csharp", @@ -24,39 +24,50 @@ }, { "Order": 3, - "Title": "Retrieve your organization\u0027s API usage and spend over time", + "Title": "Get usage and spend", "Slug": "get-account-usage", "Description": "Returns your organization\u0027s billed API usage as dense time buckets of\nline items. Every line item carries the billed dollar amount; products\nbilled per item also carry \u0060billed_units\u0060 (unit, quantity, and unit\nprice, where \u0060quantity \u00D7 unit_price = cost_total\u0060). Usage-priced\nproducts (billed by metered provider usage) report \u0060cost_total\u0060 only.\n\nBuckets cover the requested range completely \u2014 a bucket with no line\nitems means no billed usage in that window. Line items are unique per\nbucket on (\u0060product\u0060, \u0060dimensions\u0060, \u0060api_key.id\u0060, unit price). Usage\nbilled without an API key (requests authenticated as a user session)\nis included with \u0060api_key\u0060 absent, so totals always reconcile with\nyour invoices.\n\u0060product\u0060 and \u0060endpoint\u0060 are stable identifiers safe to aggregate on;\n\u0060description\u0060 is display text and may be reworded at any time.\n\nUsage data may lag live traffic by a few minutes, and responses may be\ncached briefly, so this endpoint is for reporting rather than\nreal-time monitoring.\n\nRequires an API key whose owner is an organization admin. Keys owned\nby other members receive a 404.", "Language": "http", - "Code": "### Retrieve your organization\u0027s API usage and spend over time\n# @name get_account_usage\nGET {{host}}/v2/account/usage?start_time={{start_time}}\u0026end_time={{end_time}}\u0026bucket_width=1d\u0026sources=[\n \u0022api\u0022,\n \u0022app\u0022\n]\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Bucketed usage for the requested range.\n# Content-Type: application/json\n# 400\n# Description: Invalid time range, bucket width, or filters.\n# 401\n# Description: Unauthorized.\n# 404\n# Description: No organization with billing access was found for this credential.\n# 429\n# Description: Too many requests.", + "Code": "### Get usage and spend\n# @name get_account_usage\nGET {{host}}/v2/account/usage?start_time={{start_time}}\u0026end_time={{end_time}}\u0026bucket_width=1d\u0026sources=[\n \u0022api\u0022,\n \u0022app\u0022\n]\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Bucketed usage for the requested range.\n# Content-Type: application/json\n# 400\n# Description: Invalid time range, bucket width, or filters.\n# 401\n# Description: Unauthorized.\n# 404\n# Description: No organization with billing access was found for this credential.\n# 429\n# Description: Too many requests.", "Format": "http", "OperationId": "get_account_usage", "Setup": null }, { "Order": 4, - "Title": "Generate or transform images, letting the server pick the best model", + "Title": "Rank edit reference assets used by organization requests", + "Slug": "get-asset-reference-usage", + "Description": "Counts completed requests made by the authenticated organization that used each existing asset as an edit input during the UTC date range. Direct file uploads without saved asset identifiers are excluded. Results are independent of current asset ownership, collection membership, and sharing. Returning an identifier does not grant access to its image. Tracking begins when enabled; earlier history is not included. Returns 50 assets per page. Rankings may change between pages when daily counts are updated; cursors do not pin a historical snapshot.", + "Language": "http", + "Code": "### Rank edit reference assets used by organization requests\n# @name get_asset_reference_usage\nGET {{host}}/v2/assets/reference-usage?start_date={{start_date}}\u0026end_date={{end_date}}\u0026cursor={{cursor}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Ranked edit reference assets\n# Content-Type: application/json\n# 400\n# Description: Invalid date range or cursor, or missing organization context\n# 401\n# Description: Unauthorized\n# 503\n# Description: Usage data temporarily unavailable", + "Format": "http", + "OperationId": "get_asset_reference_usage", + "Setup": null + }, + { + "Order": 5, + "Title": "Generate with automatic model selection", "Slug": "post-generate-image-v2-auto", - "Description": "Generate one or more images without choosing a model. The server\nselects the model best suited to the request and may route different\nrequests to different models.\n\nSupplying source images turns the request into a transform: the server\npicks a model that can edit, and the prompt describes the change to\napply. Provide the sources either as \u0060image_asset_identifiers\u0060\nreferences (images already stored with Ideogram) or as raw \u0060images\u0060\nbytes (multipart requests only) \u2014 if both are supplied, the references\nwin and the bytes are ignored. \u0060negative_prompt\u0060 and\n\u0060style_reference_asset_identifiers\u0060 only apply without source images;\ncombining them with sources is rejected with a 422 rather than\nsilently ignored.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.", + "Description": "Generate images with the model Ideogram picks as best suited to each\nrequest. Optionally upload source images as \u0060images\u0060 using\n\u0060multipart/form-data\u0060 to edit them with the prompt. Returns results\ndirectly by default; set \u0060async\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Generate or transform images, letting the server pick the best model\n# @name post_generate_image_v2_auto\nPOST {{host}}/v2/image/generate/auto?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution_tier\u0022\n\n1k\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022category_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced source asset was not found.\n# 422\n# Description: The prompt did not pass safety checks, or the request combined source images with text-to-image-only fields.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Generate with automatic model selection\n# @name post_generate_image_v2_auto\nPOST {{host}}/v2/image/generate/auto?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution_tier\u0022\n\n1k\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022category_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A source image was not found.\n# 422\n# Description: The prompt did not pass safety checks, or the request combined source images with text-to-image-only fields.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_image_v2_auto", "Setup": null }, { - "Order": 5, - "Title": "Remix an existing image, letting the server pick the best model", + "Order": 6, + "Title": "Remix with automatic model selection", "Slug": "post-tool-remix", - "Description": "Transform an existing image with a server-selected model, guided by a\ntext prompt. Supply the source as \u0060image\u0060 bytes (multipart requests\nonly). \u0060image_weight\u0060 controls how closely the result follows the\nsource; when omitted the selected model chooses its usual strength.\n\nThe server chooses a model that supports the requested remix controls:\nstyle references (ad hoc or saved), a color palette, style codes, a\nstyle preset, and a non-\u0060auto\u0060 style type each\nrestrict the request to a compatible model and to the 1K tier;\nremixes without those controls use the default model. Omit\n\u0060resolution\u0060 and \u0060aspect_ratio\u0060 to keep the source image\u0027s shape.\nSupplying \u0060image_weight\u0060 together with a \u0060resolution\u0060 or\n\u0060aspect_ratio\u0060 that changes the source\u0027s aspect ratio routes the\nrequest to a model that crops the source to the new shape; that\ncombination is served only at the 1K tier and is rejected at 2K.\n(The model-pinned remix endpoints such as\n\u0060/v2/image/remix/ideogram-4\u0060 reject the combination outright.)\n\u0060seed\u0060 is honored only on the compatible model; the default model\nsynthesizes an unseeded instruction prompt, so results are not\nreproducible there.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Remix an image guided by a text prompt, with Ideogram choosing the\nmodel. Upload the source image as \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Remix an existing image, letting the server pick the best model\n# @name post_tool_remix\nPOST {{host}}/v2/image/remix/auto?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_weight\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution_tier\u0022\n\n1k\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The remixed images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# 404\n# Description: A referenced source, reference asset, or saved collection was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Remix with automatic model selection\n# @name post_tool_remix\nPOST {{host}}/v2/image/remix/auto?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_weight\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution_tier\u0022\n\n1k\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The remixed images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_tool_remix", "Setup": null }, { - "Order": 6, + "Order": 7, "Title": "Get Batch Magic Prompt Job Results if available.", "Slug": "get-maybe-batch-results", "Description": "Gets the results of a batch magic prompt job if available.", @@ -67,7 +78,7 @@ "Setup": null }, { - "Order": 7, + "Order": 8, "Title": "Initiate Batch Magic Prompt Evalution", "Slug": "post-batch", "Description": "Runs automated evaluation of multiple LLM models and system prompts for magic prompt generation. \nGenerates images using large batches of user prompt inputs. Internal use only (feature flagged).", @@ -78,7 +89,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 8, + "Order": 9, "Title": "Create a new dataset", "Slug": "create-dataset", "Description": "Creates a new dataset", @@ -89,7 +100,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 9, + "Order": 10, "Title": "Get a dataset", "Slug": "get-dataset", "Description": "Returns a dataset by ID, including the total number of files and a list of each file\u0027s name and size in bytes.", @@ -100,7 +111,7 @@ "Setup": null }, { - "Order": 10, + "Order": 11, "Title": "List datasets", "Slug": "list-datasets", "Description": "Lists datasets for the authenticated user, most recently updated first. Supports an optional case-insensitive name search.", @@ -111,7 +122,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 11, + "Order": 12, "Title": "Train a model from a dataset", "Slug": "train-dataset-model", "Description": "Start training a custom model from a dataset. The dataset must contain at least 15 images and a maximum of 100 images. Returns the model ID and training status.", @@ -122,7 +133,7 @@ "Setup": null }, { - "Order": 12, + "Order": 13, "Title": "Upload assets to a dataset", "Slug": "upload-dataset-assets", "Description": "Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt caption sidecar files, and/or ZIP archives containing images and captions. A dataset can contain up to 100 images.", @@ -133,76 +144,76 @@ "Setup": null }, { - "Order": 13, - "Title": "Layerize the text in an image", + "Order": 14, + "Title": "Layerize text with Ideogram 3.0", "Slug": "post-layerize-design-ideogram-v3", - "Description": "Decompose a flat image into an editable design: the text in the image\nis detected, erased from the image, and returned as positioned text\nblocks with matched fonts, sizes, and colors, alongside a text-free\nbase image.\n\nSupply the source either as an \u0060image_asset_identifier\u0060 reference (an\nimage already stored with Ideogram) or as raw \u0060image\u0060 bytes (multipart\nrequests only). Provide exactly one of the two forms; supplying both,\nor neither, is rejected with a 400.\n\nA \u0060prompt\u0060 describing the image can guide text detection; when\nomitted, detection runs on the image alone.\n\nBy default the request blocks until layerization is complete and\nreturns the result in \u0060data\u0060. Set \u0060async\u0060 to true to return\nimmediately after the request is accepted, then poll for completion\nand results with \u0060GET /v1/generations/{generation_id}\u0060 using the\nreturned \u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Turn a flat image into an editable design: detected text is returned as\npositioned text blocks with matched fonts, sizes, and colors, alongside\na text-free base image. Upload the image as \u0060image\u0060 using\n\u0060multipart/form-data\u0060. Returns results directly by default; set \u0060async\u0060\nor supply a \u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Layerize the text in an image\n# @name post_layerize_design_ideogram_v3\nPOST {{host}}/v2/design/layerize/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022font_candidate_files\u0022; filename=\u0022font_candidate_files.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./font_candidate_files.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The layerized design (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# 403\n# Description: Not authorized to layerize images.\n# 404\n# Description: The referenced source asset was not found.\n# 429\n# Description: Too many requests.\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Layerize text with Ideogram 3.0\n# @name post_layerize_design_ideogram_v3\nPOST {{host}}/v2/design/layerize/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022font_candidate_files\u0022; filename=\u0022font_candidate_files.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./font_candidate_files.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The layerized design (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to layerize images.\n# 404\n# Description: The source image was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_layerize_design_ideogram_v3", "Setup": null }, { - "Order": 14, - "Title": "Rebuild an advertisement in another language", + "Order": 15, + "Title": "Ad Localizer", "Slug": "post-ad-localizer", - "Description": "Rebuilds the source advertisement for one target language. Layout,\nlogos, brand type, and the product are preserved; the visible marketing\ncopy is what changes.\n\nWithout \u0060exact_copy\u0060 the copy is translated. Supply \u0060exact_copy\u0060 to\nplace wording that has already been approved, character for character,\ninstead of translating it.\n\nThe output keeps the source advertisement\u0027s own shape and is generated\nat a frame derived from it, so neither the shape nor the size is asked\nfor.\n\nOne request localizes into one language. Localize into several languages\nby submitting one request per language.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.\n\nSupply the source advertisement as either an \u0060AssetIdentifier\u0060 reference\n(\u0060image_asset_identifier\u0060) or the raw image bytes directly (\u0060image\u0060,\nmultipart requests only). Provide exactly one of the two forms;\nsupplying both, or neither, is rejected with a 400.", + "Description": "Rebuilds an ad in one target language, preserving its layout, logos,\nbrand type, and product so only the visible marketing copy changes.\nUpload the source ad as \u0060image\u0060 using \u0060multipart/form-data\u0060; the copy\nis translated unless you supply \u0060exact_copy\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060 or\nsupply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Rebuild an advertisement in another language\n# @name post_ad_localizer\nPOST {{host}}/v2/tool/ad-localizer?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022language\u0022\n\nar\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022exact_copy\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Ad localization accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account or mini app is not authorized to use Ad Localizer.\n# 404\n# Description: An input asset was not found or is not readable.\n# 422\n# Description: The instruction did not pass prompt safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", + "Code": "### Ad Localizer\n# @name post_ad_localizer\nPOST {{host}}/v2/tool/ad-localizer?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022language\u0022\n\nar\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022exact_copy\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Ad localization accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to use Ad Localizer.\n# 404\n# Description: An input asset was not found or is not readable.\n# 422\n# Description: The instruction did not pass prompt safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", "Format": "http", "OperationId": "post_ad_localizer", "Setup": null }, { - "Order": 15, - "Title": "Advertisement Resizer v2", + "Order": 16, + "Title": "Ad Resizer", "Slug": "post-ad-resizer", - "Description": "Reframes the source creative to the exact requested ad resolution,\nregenerating the layout so text and key elements stay legible at the\ntarget size.\n\nSupply \u0060platform\u0060 to keep the whole advertisement clear of that\nplatform\u0027s own interface. The advertisement is generated at the largest\nrectangle that fits inside the platform\u0027s published safe zone for the\nrequested aspect ratio, placed at that rectangle\u0027s position, and the\nspace around it is filled in so the returned image is still exactly the\nrequested resolution. Omit \u0060platform\u0060 and the advertisement fills the\nwhole frame.\n\nEach platform accepts only the resolutions for which it publishes a\nsafe zone:\n\n| Platform | Accepted resolutions |\n| --- | --- |\n| \u0060google\u0060 | \u00601920x1080\u0060, \u00603840x2160\u0060, \u00601080x1080\u0060, \u00602400x2400\u0060, \u00602880x2880\u0060, \u00601080x1920\u0060, \u00602160x3840\u0060 |\n| \u0060tiktok\u0060 | \u00601920x1080\u0060, \u00603840x2160\u0060, \u00601080x1080\u0060, \u00602400x2400\u0060, \u00602880x2880\u0060, \u00601080x1920\u0060, \u00602160x3840\u0060 |\n| \u0060meta_stories\u0060 | \u00601080x1920\u0060, \u00602160x3840\u0060 |\n| \u0060meta_reels\u0060 | \u00601080x1920\u0060, \u00602160x3840\u0060 |\n| \u0060meta\u0060 (legacy) | \u00601080x1920\u0060, \u00602160x3840\u0060 |\n| \u0060snapchat\u0060 | \u00601080x1920\u0060, \u00602160x3840\u0060 |\n\nA \u0060platform\u0060 combined with any other \u0060resolution\u0060 is rejected with a\n400. When \u0060platform\u0060 is omitted, every resolution in the request schema\nis accepted.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed. The completed generation\nreports the exact amount billed for the request in\n\u0060usage_cost_usd_micros\u0060.\n\nSupply the source creative as either an \u0060AssetIdentifier\u0060 reference\n(\u0060image_asset_identifier\u0060) or the raw image bytes directly (\u0060image\u0060,\nmultipart requests only). Provide exactly one of the two forms;\nsupplying both, or neither, is rejected with a 400.", + "Description": "Reframes an ad creative to an exact ad resolution, regenerating the\nlayout so text and key elements stay legible at the new size. Upload\nthe source creative as \u0060image\u0060 using \u0060multipart/form-data\u0060, and supply\n\u0060platform\u0060 to keep the ad inside that platform\u0027s safe zone.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060 or\nsupply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Advertisement Resizer v2\n# @name post_ad_resizer\nPOST {{host}}/v2/tool/ad-resizer?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n300x250\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022platform\u0022\n\ngoogle\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Ad resize accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to resize an ad.\n# 404\n# Description: Source asset not found.\n# 422\n# Description: The prompt was rejected by safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", + "Code": "### Ad Resizer\n# @name post_ad_resizer\nPOST {{host}}/v2/tool/ad-resizer?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n300x250\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022platform\u0022\n\ngoogle\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Ad resize accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to resize an ad.\n# 404\n# Description: Source asset not found.\n# 422\n# Description: The prompt was rejected by safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", "Format": "http", "OperationId": "post_ad_resizer", "Setup": null }, { - "Order": 16, - "Title": "Advertisement Variations", + "Order": 17, + "Title": "Ad Variations", "Slug": "post-ad-variations", - "Description": "Generates a brand-locked creative variation of the source ad along the\nrequested variation axis: different people, a different setting, a\ndifferent group size, or a different scene. Logos, brand colors, the\nproduct, and all on-image text are preserved; only the requested axis\nchanges.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed. The completed generation\nreports the exact amount billed for the request in\n\u0060usage_cost_usd_micros\u0060.\n\nEach returned image is generated at the source creative\u0027s own aspect\nratio (the long side to short side ratio is capped at 3:1).\n\nSupply the source creative as either an \u0060AssetIdentifier\u0060 reference\n(\u0060image_asset_identifier\u0060) or the raw image bytes directly (\u0060image\u0060,\nmultipart requests only). Provide exactly one of the two forms;\nsupplying both, or neither, is rejected with a 400.", + "Description": "Creates on-brand variations of an ad along one axis, preserving logos,\nbrand colors, the product, and all on-image text. Upload the source\ncreative as \u0060image\u0060 using \u0060multipart/form-data\u0060 and choose a\n\u0060variation_type\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060 or\nsupply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Advertisement Variations\n# @name post_ad_variations\nPOST {{host}}/v2/tool/ad-variations\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022variation_type\u0022\n\npeople\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Ad variation accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to generate ad variations.\n# 404\n# Description: Source asset not found.\n# 422\n# Description: The prompt was rejected by safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", + "Code": "### Ad Variations\n# @name post_ad_variations\nPOST {{host}}/v2/tool/ad-variations\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022variation_type\u0022\n\npeople\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Ad variation accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to generate ad variations.\n# 404\n# Description: Source asset not found.\n# 422\n# Description: The prompt was rejected by safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", "Format": "http", "OperationId": "post_ad_variations", "Setup": null }, { - "Order": 17, - "Title": "Product Color Change", + "Order": 18, + "Title": "Colorways", "Slug": "post-colorways", - "Description": "Recolors the masked regions of the product photo, each to its own\ntarget color, while preserving the product\u0027s geometry, materials,\nprints, logos, and shading, and keeping every region outside the\nmasks unchanged.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.\n\nSupply the product photo as raw \u0060image\u0060 bytes via\n\u0060multipart/form-data\u0060.\n\nSupply the masks marking the regions to recolor as raw \u0060masks\u0060 bytes,\npaired by position with \u0060colors\u0060 \u2014 up to 4 regions; a single-region\nedit is a one-item list. Every mask must have the same pixel\ndimensions as the product photo. White pixels mark the region to\nrecolor; black pixels are preserved. Alpha-only masks are also\nsupported: opaque pixels mark the region to recolor and transparent\npixels are preserved.", + "Description": "Recolors masked regions of a product photo, each to its own target\ncolor, preserving the product\u0027s geometry, materials, prints, logos, and\neverything outside the masks. Upload the \u0060image\u0060 and up to 4 \u0060masks\u0060\nusing \u0060multipart/form-data\u0060, with one entry in \u0060colors\u0060 per mask.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060 or\nsupply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Product Color Change\n# @name post_colorways\nPOST {{host}}/v2/tool/colorways?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022masks\u0022; filename=\u0022masks.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./masks.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022colors\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Colorway accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to create a colorway.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", + "Code": "### Colorways\n# @name post_colorways\nPOST {{host}}/v2/tool/colorways?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022masks\u0022; filename=\u0022masks.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./masks.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022colors\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Colorway accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to create a colorway.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", "Format": "http", "OperationId": "post_colorways", "Setup": null }, { - "Order": 18, - "Title": "Create ghost-mannequin garment photography", + "Order": 19, + "Title": "Ghost Mannequin", "Slug": "post-ghost-mannequin", - "Description": "Transforms one or more photographs of the same garment into a polished\nghost-mannequin product image on a clean white studio background. The\ngarment keeps its identity and construction while the source person,\nmannequin, hanger, environment, and other clothing are removed.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.\n\nSupply one or more garment references. Use the directional fields when\nthe camera direction is known; each direction accepts either an\nexisting \u0060AssetIdentifier\u0060 or one raw image, but not both. Additional\nunlabeled references can be supplied through exactly one transport:\n\u0060garment_asset_identifiers\u0060, or multipart \u0060garment_images\u0060.", + "Description": "Turns photos of one garment into a ghost-mannequin product image on a\nclean white studio background, removing the person, mannequin, hanger,\nand other clothing. Upload the photos using \u0060multipart/form-data\u0060, in\nthe directional fields (such as \u0060front_image\u0060) when the camera\ndirection is known and in \u0060garment_images\u0060 otherwise.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060 or\nsupply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Create ghost-mannequin garment photography\n# @name post_ghost_mannequin\nPOST {{host}}/v2/tool/ghost-mannequin?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022garment_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022garment_images\u0022; filename=\u0022garment_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./garment_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022front_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022front_image\u0022; filename=\u0022front_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./front_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022back_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022back_image\u0022; filename=\u0022back_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./back_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022left_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022left_image\u0022; filename=\u0022left_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./left_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022right_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022right_image\u0022; filename=\u0022right_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./right_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022top_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022top_image\u0022; filename=\u0022top_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./top_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022bottom_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022bottom_image\u0022; filename=\u0022bottom_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./bottom_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022view\u0022\n\nfront\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022instruction\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022metadata\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Ghost-mannequin generation accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to create ghost-mannequin images.\n# 404\n# Description: An input asset was not found or is not readable.\n# 413\n# Description: The combined raw image uploads exceed 100 MB.\n# 422\n# Description: The instruction did not pass prompt safety validation.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", + "Code": "### Ghost Mannequin\n# @name post_ghost_mannequin\nPOST {{host}}/v2/tool/ghost-mannequin?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022garment_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022garment_images\u0022; filename=\u0022garment_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./garment_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022front_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022front_image\u0022; filename=\u0022front_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./front_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022back_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022back_image\u0022; filename=\u0022back_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./back_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022left_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022left_image\u0022; filename=\u0022left_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./left_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022right_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022right_image\u0022; filename=\u0022right_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./right_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022top_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022top_image\u0022; filename=\u0022top_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./top_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022bottom_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022bottom_image\u0022; filename=\u0022bottom_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./bottom_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022view\u0022\n\nfront\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022instruction\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022metadata\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Ghost-mannequin generation accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to create ghost-mannequin images.\n# 404\n# Description: An input asset was not found or is not readable.\n# 413\n# Description: The combined raw image uploads exceed 100 MB.\n# 422\n# Description: The instruction did not pass prompt safety validation.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", "Format": "http", "OperationId": "post_ghost_mannequin", "Setup": null }, { - "Order": 19, + "Order": 20, "Title": "Create a fashion lookbook", "Slug": "post-lookbook", - "Description": "Creates polished fashion product imagery from one or more product\nreferences and an aesthetic reference. Each generated shoot is returned\nas four individual lookbook images.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.", + "Description": "Creates polished fashion product imagery from one or more product\nreferences and an aesthetic reference. Each generated shoot is returned\nas four individual lookbook images.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v2/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.LookbookRequest\u003E(\n @\u0022{\n \u0022\u0022aspect_ratio\u0022\u0022: \u0022\u0022aspect_ratio\u0022\u0022,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022category\u0022\u0022: \u0022\u0022dresses\u0022\u0022,\n \u0022\u0022num_shoots\u0022\u0022: 1,\n \u0022\u0022product_asset_identifiers\u0022\u0022: [\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n }\n ]\n}\u0022)!;\n\nvar response = await client.EditWorkflow.PostLookbookAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -210,43 +221,43 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 20, - "Title": "Product Material Change", + "Order": 21, + "Title": "Material Swap", "Slug": "post-material-swap", - "Description": "Re-renders the masked regions of the product photo in the materials\nshown by the reference images \u2014 matching each one\u0027s color, texture,\npattern scale, and orientation \u2014 while preserving the product\u0027s\nsilhouette, construction, seams, and shading, and keeping every region\noutside the masks unchanged.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.\n\nSupply the product photo, the masks marking the regions to\nre-material, and the material reference images as raw bytes (\u0060image\u0060,\n\u0060masks\u0060, and \u0060materials\u0060) via \u0060multipart/form-data\u0060 \u2014 up to 4 masks; a\nsingle-region edit is a one-item list. Every mask must have the same\npixel dimensions as the product photo. White pixels mark the region to\nchange; black pixels are preserved. Alpha-only masks are also\nsupported: opaque pixels mark the region to change and transparent\npixels are preserved. Send either one material, which every mask\ntakes, or exactly one material per mask, paired by position.", + "Description": "Re-renders masked regions of a product photo in the materials shown in\nreference images, preserving the product\u0027s construction and everything\noutside the masks. Upload the \u0060image\u0060, up to 4 \u0060masks\u0060, and the\n\u0060materials\u0060 using \u0060multipart/form-data\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060 or\nsupply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Product Material Change\n# @name post_material_swap\nPOST {{host}}/v2/tool/material-swap?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022masks\u0022; filename=\u0022masks.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./masks.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022material_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022materials\u0022; filename=\u0022materials.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./materials.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Material swap accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to create a material swap.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", + "Code": "### Material Swap\n# @name post_material_swap\nPOST {{host}}/v2/tool/material-swap?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022masks\u0022; filename=\u0022masks.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./masks.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022material_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022materials\u0022; filename=\u0022materials.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./materials.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Material swap accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to create a material swap.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", "Format": "http", "OperationId": "post_material_swap", "Setup": null }, { - "Order": 21, - "Title": "Generate pose variants of a fashion image", + "Order": 22, + "Title": "Model Pose Variants", "Slug": "post-model-pose-variants", - "Description": "Changes the model\u0027s pose or camera presentation while preserving the\nsource model, garment, styling, and scene. An optional pose-reference\nimage supplies body pose and gaze only; it does not supply identity,\nclothing, or styling.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.\n\nSupply the source as either an \u0060AssetIdentifier\u0060 reference\n(\u0060source_asset_identifier\u0060) or raw image bytes (\u0060source_image\u0060,\nmultipart requests only). Provide exactly one source form; supplying\nboth, or neither, is rejected with a 400.", + "Description": "Changes the model\u0027s pose or camera angle in a fashion image while\npreserving the model, garment, styling, and scene. Upload the\n\u0060source_image\u0060 using \u0060multipart/form-data\u0060 and describe the new pose in\n\u0060instruction\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060 or\nsupply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Generate pose variants of a fashion image\n# @name post_model_pose_variants\nPOST {{host}}/v2/tool/model-pose-variants\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022source_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022source_image\u0022; filename=\u0022source_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./source_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022pose_reference_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022instruction\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Pose-variant generation accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to generate pose variants.\n# 404\n# Description: An input asset was not found or is not readable.\n# 422\n# Description: The instruction did not pass prompt safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", + "Code": "### Model Pose Variants\n# @name post_model_pose_variants\nPOST {{host}}/v2/tool/model-pose-variants\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022source_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022source_image\u0022; filename=\u0022source_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./source_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022pose_reference_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022instruction\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Pose-variant generation accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to generate pose variants.\n# 404\n# Description: An input asset was not found or is not readable.\n# 422\n# Description: The instruction did not pass prompt safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", "Format": "http", "OperationId": "post_model_pose_variants", "Setup": null }, { - "Order": 22, - "Title": "Replace the model in a commerce image", + "Order": 23, + "Title": "Model Swap", "Slug": "post-model-swap", - "Description": "Re-casts a fashion commerce image with the identity shown in one or\nmore ordered target-model references. The workflow uses the working\nimage for the product, pose, scene, lighting, framing, and camera, and\nuses the target references only for identity, hair, skin tone, and body\nproportions. Results are full-frame edits; exact pixel preservation is\nnot guaranteed.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.", + "Description": "Replaces the model in a fashion image with the person shown in one to\nfour target-model references, keeping the product, pose, scene,\nlighting, and framing. Upload the working image as \u0060source_image\u0060 using\n\u0060multipart/form-data\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060 or\nsupply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Replace the model in a commerce image\n# @name post_model_swap\nPOST {{host}}/v2/tool/model-swap\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022source_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022source_image\u0022; filename=\u0022source_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./source_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022model_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022instruction\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Model swap accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to use model swap.\n# 404\n# Description: An input asset was not found or is not readable.\n# 422\n# Description: The instruction did not pass prompt safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", + "Code": "### Model Swap\n# @name post_model_swap\nPOST {{host}}/v2/tool/model-swap\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022source_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022source_image\u0022; filename=\u0022source_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./source_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022model_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022instruction\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Model swap accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to use model swap.\n# 404\n# Description: An input asset was not found or is not readable.\n# 422\n# Description: The instruction did not pass prompt safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", "Format": "http", "OperationId": "post_model_swap", "Setup": null }, { - "Order": 23, - "Title": "Create marketplace-ready product packshots", + "Order": 24, + "Title": "Packshots", "Slug": "post-packshots", - "Description": "Creates one polished product photograph from one or more ordered product\nreferences. An optional style reference may guide framing, crop,\nbackground, and lighting without changing the product\u0027s identity.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed. Product fidelity is\nbest-effort and details absent from every reference may be reconstructed.", + "Description": "Creates one polished product photograph from one or more ordered product\nreferences. An optional style reference may guide framing, crop,\nbackground, and lighting without changing the product\u0027s identity.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v2/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed. Product fidelity is\nbest-effort and details absent from every reference may be reconstructed.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.PackshotsRequest\u003E(\n @\u0022{\n \u0022\u0022product_asset_identifiers\u0022\u0022: [\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n }\n ],\n \u0022\u0022view\u0022\u0022: \u0022\u0022front\u0022\u0022\n}\u0022)!;\n\nvar response = await client.EditWorkflow.PostPackshotsAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -254,10 +265,10 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 24, + "Order": 25, "Title": "Edit an image, optionally using a mask", "Slug": "post-precise-masked-edit", - "Description": "Applies an instruction to an image. When a mask is supplied, it identifies\nthe primary edit region. Without a mask, the model edits the full image.\nOptional reference images can guide the requested appearance. Set\n\u0060preserve_unmasked_pixels\u0060 to keep decoded pixels outside a supplied mask\nunchanged in the final image.\n\nThe request runs asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.", + "Description": "Applies an instruction to an image. When a mask is supplied, it identifies\nthe primary edit region. Without a mask, the model edits the full image.\nOptional reference images can guide the requested appearance. Set\n\u0060preserve_unmasked_pixels\u0060 to keep decoded pixels outside a supplied mask\nunchanged in the final image.\n\nThe request runs asynchronously. Poll\n\u0060GET /v2/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.", "Language": "http", "Code": "### Edit an image, optionally using a mask\n# @name post_precise_masked_edit\nPOST {{host}}/v2/workflow/precise-masked-edit\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022model\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nhigh\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022source_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022source_image\u0022; filename=\u0022source_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./source_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022instruction\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022preserve_unmasked_pixels\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Precise masked edit accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to use precise masked editing.\n# 404\n# Description: An input asset was not found or is not readable.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 503\n# Description: Precise masked editing is temporarily unavailable.", "Format": "http", @@ -265,10 +276,10 @@ "Setup": null }, { - "Order": 25, + "Order": 26, "Title": "Edit a product image using an instruction and ordered references", "Slug": "post-skechers-style-edit", - "Description": "Edits the base image while preserving details the instruction does not\nchange. Image 1 is the base; reference images are numbered from image 2\nin the supplied order. Resolve image mentions to these numbers before\nsubmitting. Descriptions identify the selected view or reference.\n\nPoll GET /v1/generations/{generation_id} with the returned generation_id\nuntil the workflow completes or fails.", + "Description": "Edits the base image while preserving details the instruction does not\nchange. Image 1 is the base; reference images are numbered from image 2\nin the supplied order. Resolve image mentions to these numbers before\nsubmitting. Descriptions identify the selected view or reference.\n\nPoll GET /v2/generations/{generation_id} with the returned generation_id\nuntil the workflow completes or fails.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.SkechersStyleEditRequest\u003E(\n @\u0022{\n \u0022\u0022base_description\u0022\u0022: \u0022\u0022base_description\u0022\u0022,\n \u0022\u0022aspect_ratio\u0022\u0022: 61,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022reference_asset_identifiers\u0022\u0022: [\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n }\n ],\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022base_generation_size\u0022\u0022: \u0022\u00222k\u0022\u0022,\n \u0022\u0022base_asset_identifier\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022reference_descriptions\u0022\u0022: [\n \u0022\u0022reference_descriptions\u0022\u0022,\n \u0022\u0022reference_descriptions\u0022\u0022,\n \u0022\u0022reference_descriptions\u0022\u0022,\n \u0022\u0022reference_descriptions\u0022\u0022,\n \u0022\u0022reference_descriptions\u0022\u0022\n ],\n \u0022\u0022resolved_instruction\u0022\u0022: \u0022\u0022resolved_instruction\u0022\u0022,\n \u0022\u0022num_images\u0022\u0022: 0,\n \u0022\u0022quality\u0022\u0022: null\n}\u0022)!;\n\nvar response = await client.EditWorkflow.PostSkechersStyleEditAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -276,21 +287,21 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 26, - "Title": "Render a fashion sketch as product photography", + "Order": 27, + "Title": "Sketch to Render", "Slug": "post-sketch-to-render", - "Description": "Converts one fashion sketch into photorealistic garment or product\nimagery while preserving its silhouette, construction, colors, and\nvisible design details.\n\nThe request runs asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.\n\nSupply exactly one sketch transport: an existing \u0060AssetIdentifier\u0060 in\n\u0060sketch_asset_identifier\u0060, or raw \u0060sketch_image\u0060 bytes in a multipart\nrequest. Supplying both or neither is rejected with a 400.", + "Description": "Turns a fashion sketch into photorealistic garment or product imagery,\npreserving its silhouette, construction, colors, and design details.\nUpload the \u0060sketch_image\u0060 using \u0060multipart/form-data\u0060 and describe\nmaterials and rendering in \u0060instruction\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060 or\nsupply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Render a fashion sketch as product photography\n# @name post_sketch_to_render\nPOST {{host}}/v2/tool/sketch-to-render\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022sketch_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022sketch_image\u0022; filename=\u0022sketch_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./sketch_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022instruction\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Sketch rendering accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to render sketches.\n# 404\n# Description: The referenced sketch was not found or is not readable.\n# 422\n# Description: The instruction did not pass prompt safety validation.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", + "Code": "### Sketch to Render\n# @name post_sketch_to_render\nPOST {{host}}/v2/tool/sketch-to-render\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022sketch_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022sketch_image\u0022; filename=\u0022sketch_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./sketch_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022instruction\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nlow\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Sketch rendering accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to render sketches.\n# 404\n# Description: The referenced sketch was not found or is not readable.\n# 422\n# Description: The instruction did not pass prompt safety validation.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", "Format": "http", "OperationId": "post_sketch_to_render", "Setup": null }, { - "Order": 27, - "Title": "Transfer a shoe upper onto a preserved sole", + "Order": 28, + "Title": "Sole Swap", "Slug": "post-sole-swap", - "Description": "Uses the sole-donor shoe as the output canvas, preserving its sole, camera,\nbackground, and lighting while transferring the upper from ordered references.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned\n\u0060generation_id\u0060 until the generation is completed or failed.", + "Description": "Uses the sole-donor shoe as the output canvas, preserving its sole, camera,\nbackground, and lighting while transferring the upper from ordered references.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v2/generations/{generation_id}\u0060 with the returned\n\u0060generation_id\u0060 until the generation is completed or failed.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.SoleSwapRequest\u003E(\n @\u0022{\n \u0022\u0022aspect_ratio\u0022\u0022: \u0022\u0022aspect_ratio\u0022\u0022,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022seed\u0022\u0022: 12345,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022base_generation_size\u0022\u0022: \u0022\u00222k\u0022\u0022,\n \u0022\u0022base_asset_identifier\u0022\u0022: {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n \u0022\u0022instruction\u0022\u0022: \u0022\u0022instruction\u0022\u0022,\n \u0022\u0022num_images\u0022\u0022: 0,\n \u0022\u0022upper_asset_identifiers\u0022\u0022: [\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n }\n ],\n \u0022\u0022quality\u0022\u0022: null\n}\u0022)!;\n\nvar response = await client.EditWorkflow.PostSoleSwapAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -298,10 +309,10 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 28, + "Order": 29, "Title": "Design one Swan S logo candidate", "Slug": "post-swan-s-logo-design", - "Description": "Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed.", + "Description": "Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.SwanSLogoDesignRequest\u003E(\n @\u0022{\n \u0022\u0022logo_style\u0022\u0022: \u0022\u00223d\u0022\u0022,\n \u0022\u0022flat_silhouette_asset_identifier\u0022\u0022: {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022source_mode\u0022\u0022: \u0022\u0022shoe_swatch\u0022\u0022,\n \u0022\u0022logo_specification_asset_identifier\u0022\u0022: {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n \u0022\u0022design_variant\u0022\u0022: \u0022\u0022split_coverage\u0022\u0022,\n \u0022\u0022style_source_asset_identifier\u0022\u0022: {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n \u0022\u0022geometry_hero_asset_identifier\u0022\u0022: {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n \u0022\u0022quality\u0022\u0022: null\n}\u0022)!;\n\nvar response = await client.EditWorkflow.PostSwanSLogoDesignAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -309,10 +320,10 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 29, + "Order": 30, "Title": "Install a Swan S logo on a shoe", "Slug": "post-swan-s-logo-install", - "Description": "Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed.", + "Description": "Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.SwanSLogoInstallRequest\u003E(\n @\u0022{\n \u0022\u0022logo_style\u0022\u0022: \u0022\u00223d\u0022\u0022,\n \u0022\u0022aspect_ratio\u0022\u0022: \u0022\u0022aspect_ratio\u0022\u0022,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022logo_asset_identifier\u0022\u0022: {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n \u0022\u0022logo_specification_asset_identifier\u0022\u0022: {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n \u0022\u0022shoe_asset_identifiers\u0022\u0022: [\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n }\n ],\n \u0022\u0022num_images\u0022\u0022: 0,\n \u0022\u0022quality\u0022\u0022: null\n}\u0022)!;\n\nvar response = await client.EditWorkflow.PostSwanSLogoInstallAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -320,10 +331,10 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 30, - "Title": "Replace or recolor footwear in an advertisement", + "Order": 31, + "Title": "Swap Product", "Slug": "post-swap-product", - "Description": "Edits the footwear in a source advertisement using ordered product references.\nPoll \u0060GET /v1/generations/{generation_id}\u0060 for status and image results.", + "Description": "Edits the footwear in a source advertisement using ordered product references.\nPoll \u0060GET /v2/generations/{generation_id}\u0060 for status and image results.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.SwapProductRequest\u003E(\n @\u0022{\n \u0022\u0022mode\u0022\u0022: null,\n \u0022\u0022aspect_ratio\u0022\u0022: \u0022\u0022aspect_ratio\u0022\u0022,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022instruction\u0022\u0022: \u0022\u0022instruction\u0022\u0022,\n \u0022\u0022source_asset_identifier\u0022\u0022: {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n \u0022\u0022num_images\u0022\u0022: 0,\n \u0022\u0022product_asset_identifiers\u0022\u0022: [\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n }\n ],\n \u0022\u0022quality\u0022\u0022: null\n}\u0022)!;\n\nvar response = await client.EditWorkflow.PostSwapProductAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -331,10 +342,10 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 31, + "Order": 32, "Title": "Dress a person in one or more garments", "Slug": "post-virtual-try-on", - "Description": "Generates a photorealistic image of the person in the supplied photo\nwearing the supplied garments, preserving their face, body, and\nbackground.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.\n\nSupply the person as either an \u0060AssetIdentifier\u0060 reference\n(\u0060person_asset_identifier\u0060) or the raw image bytes directly\n(\u0060person_image\u0060, multipart requests only), and likewise the garments as\neither \u0060garment_asset_identifiers\u0060 or \u0060garment_images\u0060. For each of the\ntwo sources, provide exactly one of the two forms; supplying both, or\nneither, is rejected with a 400.", + "Description": "Generates a photorealistic image of the person in the supplied photo\nwearing the supplied garments, preserving their face, body, and\nbackground.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v2/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.\n\nSupply the person as either an \u0060AssetIdentifier\u0060 reference\n(\u0060person_asset_identifier\u0060) or the raw image bytes directly\n(\u0060person_image\u0060, multipart requests only), and likewise the garments as\neither \u0060garment_asset_identifiers\u0060 or \u0060garment_images\u0060. For each of the\ntwo sources, provide exactly one of the two forms; supplying both, or\nneither, is rejected with a 400.", "Language": "http", "Code": "### Dress a person in one or more garments\n# @name post_virtual_try_on\nPOST {{host}}/v2/workflow/virtual-try-on\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022person_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022person_image\u0022; filename=\u0022person_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./person_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022garment_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022garment_images\u0022; filename=\u0022garment_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./garment_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022instruction\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Try-on accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to create a try-on.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json", "Format": "http", @@ -342,7 +353,7 @@ "Setup": null }, { - "Order": 32, + "Order": 33, "Title": "Poll a generation", "Slug": "get-generation", "Description": "Retrieves the current status of an asynchronous generation, and its results once complete. Use the \u0060generation_id\u0060 returned by the async generation endpoint. While the generation is \u0060pending\u0060 or has \u0060failed\u0060, the response contains only \u0060generation_id\u0060, \u0060status\u0060, and \u0060created\u0060. Once \u0060status\u0060 is \u0060completed\u0060, the response includes \u0060response_type\u0060 and \u0060data\u0060, and may include \u0060usage_cost_usd_micros\u0060 when the request uses variable usage-based pricing.", @@ -353,7 +364,7 @@ "Setup": null }, { - "Order": 33, + "Order": 34, "Title": "Edit (legacy)", "Slug": "post-edit-image", "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.", @@ -364,7 +375,7 @@ "Setup": null }, { - "Order": 34, + "Order": 35, "Title": "Generate a design from a text prompt with text detection and correction", "Slug": "post-generate-design-v3", "Description": "Generates a design synchronously from a text prompt using the Ideogram 3.0 model, then detects and corrects text layers within the generated image.\n\nThe response includes the generated image URL along with detected text layers (with font, size, color, position) and image asset layers.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -375,7 +386,7 @@ "Setup": null }, { - "Order": 35, + "Order": 36, "Title": "Generate an editable design with Ideogram 4.0 HTML", "Slug": "post-generate-design-v4", "Description": "Experimental prototype endpoint for generating an editable V4 HTML design from a prompt.\n\nOptionally accepts inspiration reference images to guide transferable visual style. Inspiration images are design/style references only and are not edit targets.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -386,7 +397,7 @@ "Setup": null }, { - "Order": 36, + "Order": 37, "Title": "Generate an editable V4 HTML design asynchronously via webhook", "Slug": "post-generate-design-v4-async", "Description": "Accepts an Ideogram 4.0 HTML design request for asynchronous processing and\nreturns immediately with a request_id. The generated design is POSTed to the\nsupplied \u0060webhook_url\u0060 once ready.", @@ -397,7 +408,7 @@ "Setup": null }, { - "Order": 37, + "Order": 38, "Title": "Generate (legacy)", "Slug": "post-generate-image", "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.", @@ -408,7 +419,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 38, + "Order": 39, "Title": "Generate with ERNIE-Image-Turbo", "Slug": "post-generate-image-ernie", "Description": "Generates images synchronously using the ERNIE-Image-Turbo model. Width\nand height must each be a positive multiple of 16 and the total area\nmust not exceed 1,075,200 pixels (896\u00D71200); the server validates these\nagainst the model\u0027s resolution constraints.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -419,7 +430,7 @@ "Setup": null }, { - "Order": 39, + "Order": 40, "Title": "Generate with ERNIE-Image-Turbo asynchronously via webhook", "Slug": "post-generate-image-ernie-async", "Description": "Accepts an ERNIE-Image-Turbo generation request for asynchronous\nprocessing and returns immediately with a generation_id. The generated\nimages are POSTed to the supplied \u0060webhook_url\u0060 once ready, in a payload\nthat mirrors the synchronous response with an added generation_id for\ncorrelation.\n\nSee [Webhooks](/ideogram-api/webhooks) for the delivery payload and how to verify webhook signatures.", @@ -430,7 +441,7 @@ "Setup": null }, { - "Order": 40, + "Order": 41, "Title": "Generate with FLUX.2-Klein", "Slug": "post-generate-image-flux2-klein", "Description": "Generates images synchronously using the FLUX.2-Klein model. Width and\nheight must each be a positive multiple of 16 and the total area must\nnot exceed 1,048,576 pixels (1024\u00D71024); the server validates these\nagainst the model\u0027s resolution constraints.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -441,7 +452,7 @@ "Setup": null }, { - "Order": 41, + "Order": 42, "Title": "Generate with FLUX.2-Klein asynchronously via webhook", "Slug": "post-generate-image-flux2-klein-async", "Description": "Accepts a FLUX.2-Klein generation request for asynchronous processing and\nreturns immediately with a generation_id. The generated images are POSTed to\nthe supplied \u0060webhook_url\u0060 once ready, in a payload that mirrors the\nsynchronous response with an added generation_id for correlation.\n\nSee [Webhooks](/ideogram-api/webhooks) for the delivery payload and how to verify webhook signatures.", @@ -452,7 +463,7 @@ "Setup": null }, { - "Order": 42, + "Order": 43, "Title": "Generate with FLUX.2-Klein (undistilled base)", "Slug": "post-generate-image-flux2-klein-base", "Description": "Generates images synchronously using the UNDISTILLED FLUX.2-Klein base \u2014 the 50-step quality tier (vs the distilled /v1/flux-2-klein fast tier). Width and\nheight must each be a positive multiple of 16 and the total area must\nnot exceed 1,048,576 pixels (1024\u00D71024); the server validates these\nagainst the model\u0027s resolution constraints.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -463,7 +474,7 @@ "Setup": null }, { - "Order": 43, + "Order": 44, "Title": "Generate with FLUX.2-Klein (undistilled base) asynchronously via webhook", "Slug": "post-generate-image-flux2-klein-base-async", "Description": "Accepts an undistilled-base FLUX.2-Klein generation request for asynchronous processing and\nreturns immediately with a generation_id. The generated images are POSTed to\nthe supplied \u0060webhook_url\u0060 once ready, in a payload that mirrors the\nsynchronous response with an added generation_id for correlation.\n\nSee [Webhooks](/ideogram-api/webhooks) for the delivery payload and how to verify webhook signatures.", @@ -474,7 +485,7 @@ "Setup": null }, { - "Order": 44, + "Order": 45, "Title": "Generate with the distilled few-step Ideogram model (high speed tier)", "Slug": "post-generate-image-p-image-high", "Description": "Generates images synchronously using the distilled few-step Ideogram\nmodel at the high speed tier \u2014 the highest quality, at the highest cost.\nThe speed tier controls the number of diffusion steps and the per-image\nprice.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -485,7 +496,7 @@ "Setup": null }, { - "Order": 45, + "Order": 46, "Title": "Generate with P-Image Ideogram", "Slug": "post-generate-image-p-image-ideogram", "Description": "Generates images synchronously using P-Image Ideogram. \u0060quality\u0060 selects\nthe generation quality level and \u0060resolution\u0060 selects the output-size\ntier. Both parameters have defaults.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download them.", @@ -496,7 +507,7 @@ "Setup": null }, { - "Order": 46, + "Order": 47, "Title": "Generate with P-Image Ideogram asynchronously", "Slug": "post-generate-image-p-image-ideogram-async", "Description": "Accepts a P-Image Ideogram generation request for asynchronous processing\nand returns immediately with a generation_id. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 to retrieve the result. If a\n\u0060webhook_url\u0060 is supplied, the generated images are additionally POSTed\nto it once ready, in a payload that mirrors the synchronous response with\nan added generation_id for correlation.\n\nSee [Webhooks](/ideogram-api/webhooks) for the delivery payload and how to verify webhook signatures.", @@ -507,7 +518,7 @@ "Setup": null }, { - "Order": 47, + "Order": 48, "Title": "Generate with the distilled few-step Ideogram model (low speed tier)", "Slug": "post-generate-image-p-image-low", "Description": "Generates images synchronously using the distilled few-step Ideogram\nmodel at the low speed tier \u2014 fast and low-cost, with a modest quality\ntrade-off. The speed tier controls the number of diffusion steps and the\nper-image price.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -518,7 +529,7 @@ "Setup": null }, { - "Order": 48, + "Order": 49, "Title": "Generate with the distilled few-step Ideogram model (medium speed tier)", "Slug": "post-generate-image-p-image-medium", "Description": "Generates images synchronously using the distilled few-step Ideogram\nmodel at the medium speed tier \u2014 the balanced default of speed, cost, and\nquality. The speed tier controls the number of diffusion steps and the\nper-image price.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -529,7 +540,7 @@ "Setup": null }, { - "Order": 49, + "Order": 50, "Title": "Generate with the distilled few-step Ideogram model (very-low speed tier)", "Slug": "post-generate-image-p-image-very-low", "Description": "Generates images synchronously using the distilled few-step Ideogram\nmodel at the very-low speed tier \u2014 the fastest and lowest-cost option.\nThe speed tier controls the number of diffusion steps and the per-image\nprice.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -540,7 +551,7 @@ "Setup": null }, { - "Order": 50, + "Order": 51, "Title": "Generate with Ideogram 3.0", "Slug": "post-generate-image-v3", "Description": "Generates images synchronously based on a given prompt and optional parameters using the Ideogram 3.0 model.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -551,7 +562,7 @@ "Setup": null }, { - "Order": 51, + "Order": 52, "Title": "Generate with Ideogram 3.0 (Transparent Background)", "Slug": "post-generate-image-v3-transparent", "Description": "Generates images with transparent background synchronously based on a given prompt and optional parameters using\nthe Ideogram 3.0 model. Images will be generated using maximum supported resolution at the specified aspect ratio\nto allow best results with upscaler. The selected resolution is written to the response, not the upscaled final\nresolution.\n\n\u0060rendering_speed=FLASH\u0060 is not supported for transparent-background generation; the request will return a 400.\nUse \u0060TURBO\u0060, \u0060DEFAULT\u0060, or \u0060QUALITY\u0060 instead.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -562,7 +573,7 @@ "Setup": null }, { - "Order": 52, + "Order": 53, "Title": "Generate with Ideogram 4.0", "Slug": "post-generate-image-v4", "Description": "Generates images synchronously using the Ideogram 4.0 model.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -573,7 +584,7 @@ "Setup": null }, { - "Order": 53, + "Order": 54, "Title": "Generate with Ideogram 4.5", "Slug": "post-generate-image-v45", "Description": "Generates images synchronously using the Ideogram 4.5 multimodal model.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -584,7 +595,7 @@ "Setup": null }, { - "Order": 54, + "Order": 55, "Title": "Generate with Ideogram 4.5 asynchronously via webhook", "Slug": "post-generate-image-v45-async", "Description": "Accepts an Ideogram 4.5 generation request for asynchronous processing and\nreturns immediately with a generation_id. The generated images are POSTed to\nthe supplied \u0060webhook_url\u0060 once ready, in a payload that mirrors the\nsynchronous response with an added generation_id for correlation.\n\nSee [Webhooks](/ideogram-api/webhooks) for the delivery payload and how to verify webhook signatures.", @@ -595,7 +606,7 @@ "Setup": null }, { - "Order": 55, + "Order": 56, "Title": "Generate with Ideogram 4.0 asynchronously", "Slug": "post-generate-image-v4-async", "Description": "Accepts an Ideogram 4.0 generation request for asynchronous processing and\nreturns immediately with a generation_id. Poll \u0060GET /v1/generations/{generation_id}\u0060\nto retrieve the result. If a \u0060webhook_url\u0060 is supplied, the generated images are\nadditionally POSTed to it once ready, in a payload that mirrors the synchronous\nresponse with an added generation_id for correlation.\n\nSee [Webhooks](/ideogram-api/webhooks) for the delivery payload and how to verify webhook signatures.", @@ -606,7 +617,7 @@ "Setup": null }, { - "Order": 56, + "Order": 57, "Title": "Generate with the CFG-distilled Ideogram 4.0 model", "Slug": "post-generate-image-v4-cfg-distilled", "Description": "Generates images synchronously using the CFG/guidance-distilled Ideogram\n4.0 model, served guidance-free.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -617,7 +628,7 @@ "Setup": null }, { - "Order": 57, + "Order": 58, "Title": "Generate with the CFG-distilled Ideogram 4.0 model asynchronously via webhook", "Slug": "post-generate-image-v4-cfg-distilled-async", "Description": "Accepts a CFG-distilled Ideogram 4.0 generation request for asynchronous\nprocessing and returns immediately with a generation_id. The generated\nimages are POSTed to the supplied \u0060webhook_url\u0060 once ready, in a payload\nthat mirrors the synchronous response with an added generation_id for\ncorrelation.\n\nSee [Webhooks](/ideogram-api/webhooks) for the delivery payload and how to verify webhook signatures.", @@ -628,7 +639,7 @@ "Setup": null }, { - "Order": 58, + "Order": 59, "Title": "Generate with the fp8-quantized Ideogram 4.0 model", "Slug": "post-generate-image-v4-fp8", "Description": "Generates images synchronously using the fp8-quantized Ideogram 4.0 model.\nA LoRA checkpoint can be layered on the base via the\n\u0060X-Ideogram-Positive-Lora-Ckpt-Path\u0060 header.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -639,7 +650,7 @@ "Setup": null }, { - "Order": 59, + "Order": 60, "Title": "Image-to-image with Ideogram 4.0", "Slug": "post-generate-image-v4-im2-im", "Description": "Generates images synchronously using the Ideogram 4.0 model with an initial image as input.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -650,7 +661,7 @@ "Setup": null }, { - "Order": 60, + "Order": 61, "Title": "Image-to-image with Ideogram 4.0 asynchronously via webhook", "Slug": "post-generate-image-v4-im2-im-async", "Description": "Accepts an Ideogram 4.0 image-to-image request for asynchronous processing\nand returns immediately with a request_id. The generated images are POSTed\nto the supplied \u0060webhook_url\u0060 once ready.", @@ -661,7 +672,7 @@ "Setup": null }, { - "Order": 61, + "Order": 62, "Title": "Generate with Ideogram 4.0 (stable model)", "Slug": "post-generate-image-v4-stable", "Description": "Generates images synchronously using a pinned stable build of the\nIdeogram 4.0 model. This endpoint is intentionally minimal: it accepts\nonly a prompt (and optional seed), pins the underlying model URI, and\nlets the server pick the output resolution automatically.\n\nImages links are available for a limited period of time; if you would\nlike to keep the image, you must download it.", @@ -672,7 +683,7 @@ "Setup": null }, { - "Order": 62, + "Order": 63, "Title": "Generate with Ideogram 4.0 (Transparent Background)", "Slug": "post-generate-image-v4-transparent", "Description": "Generates images with a transparent background synchronously using the\nIdeogram 4.0 model. The result is delivered as a PNG with an alpha\nchannel.\n\nAll Ideogram 4.0 aspect ratios are supported, including \u0060AUTO\u0060, which\nlets the model select the most suitable ratio from the prompt.\n\n\u0060output_resolution\u0060 selects the delivered resolution tier. Tiers are\ntotal-pixel budgets: wide and tall aspect ratios keep the same pixel\nbudget as the square of the named size, so a single dimension may\nexceed it. The response reports the final delivered resolution.\n\nImage links are available for a limited period of time; if you would\nlike to keep the image, you must download it.", @@ -683,7 +694,7 @@ "Setup": null }, { - "Order": 63, + "Order": 64, "Title": "Generate with Ideogram 4.0 (Transparent Background) asynchronously", "Slug": "post-generate-image-v4-transparent-async", "Description": "Accepts an Ideogram 4.0 transparent-background generation request for\nasynchronous processing and returns immediately with a generation_id.\nPoll \u0060GET /v1/generations/{generation_id}\u0060 to retrieve the result. If a\n\u0060webhook_url\u0060 is supplied, the generated images are additionally POSTed\nto it once ready, in a payload that mirrors the synchronous response\nwith an added generation_id for correlation.\n\nSee the synchronous \u0060/v1/ideogram-v4/generate-transparent\u0060 endpoint for\nthe request semantics, including \u0060output_resolution\u0060 tiers.\n\nSee [Webhooks](/ideogram-api/webhooks) for the delivery payload and how to verify webhook signatures.", @@ -694,7 +705,7 @@ "Setup": null }, { - "Order": 64, + "Order": 65, "Title": "Generate with Z-Image", "Slug": "post-generate-image-z-image", "Description": "Generates images synchronously using the Z-Image model. Width and height\nmust each be a positive multiple of 16 and the total area must not exceed\n1,048,576 pixels (1024\u00D71024); the server validates these against the\nmodel\u0027s resolution constraints.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -705,7 +716,7 @@ "Setup": null }, { - "Order": 65, + "Order": 66, "Title": "Generate with Z-Image asynchronously via webhook", "Slug": "post-generate-image-z-image-async", "Description": "Accepts a Z-Image generation request for asynchronous processing and\nreturns immediately with a generation_id. The generated images are POSTed to\nthe supplied \u0060webhook_url\u0060 once ready, in a payload that mirrors the\nsynchronous response with an added generation_id for correlation.\n\nSee [Webhooks](/ideogram-api/webhooks) for the delivery payload and how to verify webhook signatures.", @@ -716,7 +727,7 @@ "Setup": null }, { - "Order": 66, + "Order": 67, "Title": "Inpaint with Ideogram 3.0", "Slug": "post-inpaint-image-v3", "Description": "Inpaint a given image synchronously using the provided mask with Ideogram 3.0. The mask indicates which part of the image\nshould be edited, while the prompt and chosen style 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.", @@ -727,7 +738,7 @@ "Setup": null }, { - "Order": 67, + "Order": 68, "Title": "Layerize an existing flat graphic image with text detection and correction", "Slug": "post-layerize-design-v3", "Description": "Processes an existing flat graphic image to detect and correct text layers without generating a new image from scratch.\n\nThe uploaded image is analyzed for text content, which is then removed and returned as structured text layers with font matching, sizing, and color information.\n\nSupported image formats include JPEG, PNG, and WebP (max size 25MB).\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -738,7 +749,7 @@ "Setup": null }, { - "Order": 68, + "Order": 69, "Title": "Detect and remove reference logos from an image", "Slug": "post-layerize-logos", "Description": "Detects caller-supplied reference logos in a flat design image, inpaints\nthem out, and returns the cleaned image together with the matched\nbounding boxes (each tagged with the matching reference\u0027s \u0060REF_\u003Cn\u003E\u0060).", @@ -749,7 +760,7 @@ "Setup": null }, { - "Order": 69, + "Order": 70, "Title": "Layerize Text", "Slug": "post-layerize-text-v3", "Description": "Analyzes an image to detect text regions, then returns each detected text block with its position, content, font information, and styling.\n\nThe response includes a text-erased base image (background with all text removed) and a flat list of detected text blocks.\n\nSupported image formats include JPEG, PNG, and WebP (max size 25MB).\n\nImage links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -760,7 +771,7 @@ "Setup": null }, { - "Order": 70, + "Order": 71, "Title": "Reframe (legacy)", "Slug": "post-reframe-image", "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.", @@ -771,7 +782,7 @@ "Setup": null }, { - "Order": 71, + "Order": 72, "Title": "Reframe with Ideogram 3.0", "Slug": "post-reframe-image-v3", "Description": "Reframe a square image to a chosen resolution with Ideogram 3.0. 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.", @@ -782,7 +793,7 @@ "Setup": null }, { - "Order": 72, + "Order": 73, "Title": "Remix (legacy)", "Slug": "post-remix-image", "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.", @@ -793,7 +804,7 @@ "Setup": null }, { - "Order": 73, + "Order": 74, "Title": "Remix with Ideogram 3.0", "Slug": "post-remix-image-v3", "Description": "Remix provided images synchronously based on a given prompt and optional parameters with the Ideogram 3.0 model.\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.", @@ -804,7 +815,7 @@ "Setup": null }, { - "Order": 74, + "Order": 75, "Title": "Remix with Ideogram 4.0", "Slug": "post-remix-image-v4", "Description": "Remix an image synchronously using the Ideogram 4.0 model with an initial image and a prompt.\n\nMirrors \u0060/v1/ideogram-v3/remix\u0060 semantics (including \u0060image_weight\u0060 for how strongly the\noutput should resemble the input image) but routes the request through the V_4_0 model.\n\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -815,7 +826,7 @@ "Setup": null }, { - "Order": 75, + "Order": 76, "Title": "Remix with Ideogram 4.0 asynchronously", "Slug": "post-remix-image-v4-async", "Description": "Accepts an Ideogram 4.0 remix request for asynchronous processing and returns\nimmediately with a \u0060generation_id\u0060. Poll \u0060GET /v1/generations/{generation_id}\u0060\nto retrieve the result. If a \u0060webhook_url\u0060 is supplied, the generated images\nare additionally POSTed to it once ready.", @@ -826,7 +837,7 @@ "Setup": null }, { - "Order": 76, + "Order": 77, "Title": "Remove Background", "Slug": "post-remove-background", "Description": "Remove the background of a given image synchronously. The foreground subject\nis identified and returned on a transparent background. Supported image formats include JPEG,\nPNG, and WebP.\nImage links are available for a limited period of time; if you would like to keep the image,\nyou must download it.", @@ -837,7 +848,7 @@ "Setup": null }, { - "Order": 77, + "Order": 78, "Title": "Remove Object", "Slug": "post-remove-object", "Description": "Remove a masked object from a given image synchronously. Supply the image and a binary mask marking the region to remove (white = remove); the masked region is regenerated to blend with the surrounding scene. 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.", @@ -848,7 +859,7 @@ "Setup": null }, { - "Order": 78, + "Order": 79, "Title": "Replace Background with Ideogram 3.0", "Slug": "post-replace-background-v3", "Description": "Replace the background of a given image synchronously using a prompt with Ideogram 3.0. The foreground subject\nwill be identified and kept, while the background is replaced based on the prompt and chosen style.\nSupported image formats include JPEG, PNG, and WebP.\nImages links are available for a limited period of time; if you would like to keep the image, you must download it.", @@ -859,7 +870,7 @@ "Setup": null }, { - "Order": 79, + "Order": 80, "Title": "Advertisement Resizer", "Slug": "post-resize-image-async", "Description": "Resizes an advertisement image to the exact target size. Supply \u0060prompt\u0060\nto provide specific instructions for how the advertisement should look\nafter resizing.\n\nThe request is processed asynchronously and immediately returns a\n\u0060generation_id\u0060. Poll \u0060GET /v1/generations/{generation_id}\u0060 until \u0060status\u0060\nis \u0060completed\u0060 or \u0060failed\u0060. The completed polling response contains the\nfinal resized image(s) in \u0060data\u0060 and the amount charged for variable\nusage-based pricing in \u0060usage_cost_usd_micros\u0060. If a \u0060webhook_url\u0060 is\nsupplied, the completed result is also POSTed to that URL.\n\nSupply the advertisement image as raw \u0060image\u0060 bytes via\n\u0060multipart/form-data\u0060.\n\nThe required \u0060resolution\u0060 (\u0060WIDTHxHEIGHT\u0060) sets the exact output\ndimensions.\n\nThe model is fixed by the route, so no \u0060model\u0060 field is accepted.", @@ -870,7 +881,7 @@ "Setup": null }, { - "Order": 80, + "Order": 81, "Title": "Virtual Try-On with Ideogram 3.0", "Slug": "post-try-on-v3", "Description": "Performs virtual clothing try-on by automatically segmenting the clothing in the provided image\nand replacing it based on the prompt. The user provides an image and an optional prompt describing\nthe desired clothing change (e.g., \u0022change his shirt to a pink shirt\u0022).\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.", @@ -881,7 +892,7 @@ "Setup": null }, { - "Order": 81, + "Order": 82, "Title": "Upscale", "Slug": "post-upscale-image", "Description": "Upscale provided images synchronously with an optional prompt.\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.", @@ -892,7 +903,7 @@ "Setup": null }, { - "Order": 82, + "Order": 83, "Title": "Edit images with a prompt", "Slug": "post-v1-edit-image", "Description": "Edit one or more images using a text prompt. Provide images via file upload\nor Ideogram image URLs, and describe the desired edit in your prompt.\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.", @@ -903,7 +914,7 @@ "Setup": null }, { - "Order": 83, + "Order": 84, "Title": "Edit an image with a prompt at lower cost and latency", "Slug": "post-v1-edit-lite-image", "Description": "Edit an image using a text prompt, optimized for lower cost and\nlatency. Upload the image being edited via the \u0060image\u0060 field. Up to 9\nadditional \u0060reference_images\u0060 may be supplied to guide the edit.\n\nOutput is always generated at 1K resolution. Input images larger than\n1024px on their long edge are downscaled before processing. The\n\u0060aspect_ratio\u0060 field controls the output aspect ratio only; when\nomitted, the output follows the aspect ratio of the image being\nedited.\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.", @@ -914,76 +925,87 @@ "Setup": null }, { - "Order": 84, + "Order": 85, + "Title": "Poll a generation", + "Slug": "get-generation-v2", + "Description": "Retrieves the current status of an asynchronous generation, and its\nresults once complete. Use the \u0060generation_id\u0060 returned by any \u0060/v2\u0060\nendpoint that runs asynchronously: every video and tool endpoint, and\nany image endpoint called with \u0060async\u0060 or a \u0060webhook_url\u0060.\n\nWhile the generation is \u0060pending\u0060 or has \u0060failed\u0060, the response\ncontains only \u0060generation_id\u0060, \u0060status\u0060, and \u0060created\u0060 (plus\n\u0060failure_reason\u0060 once failed). Once \u0060status\u0060 is \u0060completed\u0060, the\nresponse includes \u0060response_type\u0060 and \u0060data\u0060. Each \u0060data\u0060 item carries\nan \u0060object_type\u0060 that identifies its shape, so image and video results\ncan be told apart. \u0060usage_cost_usd_micros\u0060 reports the amount billed\nwhen the request uses variable usage-based pricing.\n\nPolling is rate limited per organization; a 429 response carries a\n\u0060Retry-After\u0060 header with the number of seconds to wait.", + "Language": "http", + "Code": "### Poll a generation\n# @name get_generation_v2\nGET {{host}}/v2/generations/{{generation_id}}\nAuthorization: Bearer {{token}}\nAccept: application/json\n\n## Responses\n# 200\n# Description: Generation status retrieved successfully.\n# Content-Type: application/json\n# 400\n# Description: The generation ID is not a valid URL-safe base64 ID.\n# 401\n# Description: Not authorized.\n# 404\n# Description: Generation not found.\n# 429\n# Description: Too many requests.", + "Format": "http", + "OperationId": "get_generation_v2", + "Setup": null + }, + { + "Order": 86, "Title": "Describe with Ideogram 3.0", "Slug": "post-describe-image-ideogram-v3", - "Description": "Generate a natural-language description of an image using Ideogram\u0027s\n3.0-generation image captioner (a fine-tune of the Qwen2-VL\nvision-language model).\n\nSupply the source either as an \u0060image_asset_identifier\u0060 reference (an\nimage already stored with Ideogram) or as raw \u0060image\u0060 bytes (multipart\nrequests only). Provide exactly one of the two forms; supplying both,\nor neither, is rejected with a 400.\n\nSupported image formats include JPEG, PNG, and WebP.", + "Description": "Generate a natural-language description of an image with Ideogram\u0027s 3.0\nimage captioner (a fine-tune of the Qwen2-VL vision-language model).\nUpload the image as \u0060image\u0060 using \u0060multipart/form-data\u0060; the description\nis returned directly.", "Language": "http", - "Code": "### Describe with Ideogram 3.0\n# @name post_describe_image_ideogram_v3\nPOST {{host}}/v2/image/describe/ideogram-3\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Description(s) generated successfully.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source asset was not found.\n# 422\n# Description: Image failed the safety check.\n# Content-Type: application/json\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Describe with Ideogram 3.0\n# @name post_describe_image_ideogram_v3\nPOST {{host}}/v2/image/describe/ideogram-3\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Description(s) generated successfully.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The source image was not found.\n# 422\n# Description: Image failed the safety check.\n# Content-Type: application/json\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_describe_image_ideogram_v3", "Setup": null }, { - "Order": 85, + "Order": 87, "Title": "Describe with Ideogram 4.0", "Slug": "post-describe-image-ideogram-v4", - "Description": "Describe an image using Ideogram\u0027s 4.0-generation image captioner (a\nfine-tune of the Qwen3-VL vision-language model) and return a\nstructured \u0060V4JsonPrompt\u0060. The\nreturned \u0060json_prompt\u0060 is a working JSON prompt that can be passed\ndirectly as \u0060json_prompt\u0060 to the \u0060/v1/ideogram-v4/generate\u0060 family of\nendpoints.\n\nSupply the source either as an \u0060image_asset_identifier\u0060 reference (an\nimage already stored with Ideogram) or as raw \u0060image\u0060 bytes (multipart\nrequests only). Provide exactly one of the two forms; supplying both,\nor neither, is rejected with a 400.\n\nSupported image formats include JPEG, PNG, and WebP.", + "Description": "Describe an image as a structured \u0060V4JsonPrompt\u0060 with Ideogram\u0027s 4.0\nimage captioner (a fine-tune of the Qwen3-VL vision-language model).\nUpload the image as \u0060image\u0060 using \u0060multipart/form-data\u0060; the\n\u0060json_prompt\u0060 is returned directly and can be passed to the\n\u0060/v1/ideogram-v4/generate\u0060 endpoints.", "Language": "http", - "Code": "### Describe with Ideogram 4.0\n# @name post_describe_image_ideogram_v4\nPOST {{host}}/v2/image/describe/ideogram-4\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022include_bbox\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022include_style_descriptions\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022include_tags\u0022\n\nfalse\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Structured prompt generated successfully.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source asset was not found.\n# 422\n# Description: Image failed the safety check.\n# Content-Type: application/json\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Describe with Ideogram 4.0\n# @name post_describe_image_ideogram_v4\nPOST {{host}}/v2/image/describe/ideogram-4\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022include_bbox\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022include_style_descriptions\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022include_tags\u0022\n\nfalse\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Structured prompt generated successfully.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The source image was not found.\n# 422\n# Description: Image failed the safety check.\n# Content-Type: application/json\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_describe_image_ideogram_v4", "Setup": null }, { - "Order": 86, - "Title": "Generate images with GPT Image 2, from a text prompt or by editing source images", + "Order": 88, + "Title": "Generate with GPT Image 2", "Slug": "post-generate-image-v2-gpt-image2", - "Description": "Generate one or more images with GPT Image 2. The prompt is consumed\nby the model directly, without rewriting.\n\nSupplying source images turns the request into an edit: the model\napplies the prompt to the sources. Provide them either as\n\u0060image_asset_identifiers\u0060 references (images already stored with\nIdeogram) or as raw \u0060images\u0060 bytes (multipart requests only) \u2014 if both\nare supplied, the references win and the bytes are ignored. Without\nsource images the prompt alone drives the generation.\n\nThe output size follows \u0060resolution\u0060 when provided, otherwise the\nclosest size the model supports for \u0060aspect_ratio\u0060.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images with GPT Image 2. Optionally upload source images as\n\u0060images\u0060 using \u0060multipart/form-data\u0060 to edit them with the prompt.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Generate images with GPT Image 2, from a text prompt or by editing source images\n# @name post_generate_image_v2_gpt_image2\nPOST {{host}}/v2/image/generate/gpt-image-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Generate with GPT Image 2\n# @name post_generate_image_v2_gpt_image2\nPOST {{host}}/v2/image/generate/gpt-image-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_image_v2_gpt_image2", "Setup": null }, { - "Order": 87, - "Title": "Generate images with GPT Image 2.5 Flare, from a text prompt or by editing source images", + "Order": 89, + "Title": "Generate with GPT Image 2.5 Flare", "Slug": "post-generate-image-v2-gpt-image25-flare", - "Description": "Generate one or more images with GPT Image 2.5 Flare \u2014 the fast\nvariant of GPT Image 2.5, optimized for speed at quality comparable\nto GPT Image 2. The prompt is consumed by the model directly, without\nrewriting.\n\nSupplying source images turns the request into an edit: the model\napplies the prompt to the sources. Provide them either as\n\u0060image_asset_identifiers\u0060 references (images already stored with\nIdeogram) or as raw \u0060images\u0060 bytes (multipart requests only) \u2014 if both\nare supplied, the references win and the bytes are ignored. Without\nsource images the prompt alone drives the generation.\n\nThe output size follows \u0060resolution\u0060 when provided, otherwise the\nclosest size the model supports for \u0060aspect_ratio\u0060.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images with GPT Image 2.5 Flare, the fast variant of GPT Image\n2.5. Optionally upload source images as \u0060images\u0060 using\n\u0060multipart/form-data\u0060 to edit them with the prompt. Returns results\ndirectly by default; set \u0060async\u0060 or supply a \u0060webhook_url\u0060 to get a\n\u0060generation_id\u0060 and poll \u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Generate images with GPT Image 2.5 Flare, from a text prompt or by editing source images\n# @name post_generate_image_v2_gpt_image25_flare\nPOST {{host}}/v2/image/generate/gpt-image-2-5-flare?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022background\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Generate with GPT Image 2.5 Flare\n# @name post_generate_image_v2_gpt_image25_flare\nPOST {{host}}/v2/image/generate/gpt-image-2-5-flare?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022background\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_image_v2_gpt_image25_flare", "Setup": null }, { - "Order": 88, - "Title": "Generate images with GPT Image 2.5 Sunburst, from a text prompt or by editing source images", + "Order": 90, + "Title": "Generate with GPT Image 2.5 Sunburst", "Slug": "post-generate-image-v2-gpt-image25-sunburst", - "Description": "Generate one or more images with GPT Image 2.5 Sunburst \u2014 the quality\nvariant of GPT Image 2.5, optimized for fine detail at higher\nlatency than Flare. The prompt is consumed by the model directly, without\nrewriting.\n\nSupplying source images turns the request into an edit: the model\napplies the prompt to the sources. Provide them either as\n\u0060image_asset_identifiers\u0060 references (images already stored with\nIdeogram) or as raw \u0060images\u0060 bytes (multipart requests only) \u2014 if both\nare supplied, the references win and the bytes are ignored. Without\nsource images the prompt alone drives the generation.\n\nThe output size follows \u0060resolution\u0060 when provided, otherwise the\nclosest size the model supports for \u0060aspect_ratio\u0060.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images with GPT Image 2.5 Sunburst, the quality variant of GPT\nImage 2.5, with finer detail at higher latency than Flare. Optionally\nupload source images as \u0060images\u0060 using \u0060multipart/form-data\u0060 to edit\nthem with the prompt. Returns results directly by default; set \u0060async\u0060\nor supply a \u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Generate images with GPT Image 2.5 Sunburst, from a text prompt or by editing source images\n# @name post_generate_image_v2_gpt_image25_sunburst\nPOST {{host}}/v2/image/generate/gpt-image-2-5-sunburst?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022background\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Generate with GPT Image 2.5 Sunburst\n# @name post_generate_image_v2_gpt_image25_sunburst\nPOST {{host}}/v2/image/generate/gpt-image-2-5-sunburst?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022background\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_image_v2_gpt_image25_sunburst", "Setup": null }, { - "Order": 89, - "Title": "Generate images with Ideogram 4.5, from a prompt or by transforming source images", + "Order": 91, + "Title": "Generate with Ideogram 4.5", "Slug": "post-generate-image-v2-ideogram45", - "Description": "Generate one or more images with Ideogram 4.5. Supplying source\nimages turns the request into an image-to-image transform: the model\nconditions on the sources, the prompt becomes optional guidance, and\n\u0060size\u0060 may be \u0022source\u0022 to keep the first source\u0027s own size or \u0022auto\u0022\nto let the server pick the canvas from the sources and the prompt.\nProvide sources either as \u0060image_asset_identifiers\u0060 references or as\nraw \u0060images\u0060 bytes (multipart requests only); if both are supplied,\nthe references win and the bytes are ignored. The \u0060prompt\u0060 accepts\neither natural language or a structured Ideogram 4.0 JSON prompt; the\nserver detects which was supplied.\n\n\u0060magic_prompt\u0060 controls automatic prompt rewriting: \u0060auto\u0060 (the\ndefault) and \u0060on\u0060 rewrite a natural-language prompt, a prompt that is\nalready a valid structured JSON prompt is always consumed directly,\nand \u0060off\u0060 disables rewriting entirely so the model receives your\nprompt verbatim.\n\nIdeogram 4.5 renders a fixed set of output sizes. When \u0060size\u0060\nis omitted, the server picks a supported size automatically based on\nthe prompt, and on the source images when there are any.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images with Ideogram 4.5 from a natural-language or structured\nJSON prompt. Optionally upload source images as \u0060images\u0060 using\n\u0060multipart/form-data\u0060 to edit them with the prompt. Returns results\ndirectly by default; set \u0060async\u0060 or supply a \u0060webhook_url\u0060 to get a\n\u0060generation_id\u0060 and poll \u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Generate images with Ideogram 4.5, from a prompt or by transforming source images\n# @name post_generate_image_v2_ideogram45\nPOST {{host}}/v2/image/generate/ideogram-4-5?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022size\u0022\n\n2048x2048\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nvery_low\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Generate with Ideogram 4.5\n# @name post_generate_image_v2_ideogram45\nPOST {{host}}/v2/image/generate/ideogram-4-5?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022size\u0022\n\n2048x2048\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nvery_low\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_image_v2_ideogram45", "Setup": null }, { - "Order": 90, - "Title": "Generate images with Ideogram 2.0 from a text prompt", + "Order": 92, + "Title": "Generate with Ideogram 2.0", "Slug": "post-generate-image-v2-ideogram-v2", - "Description": "Generate one or more images from a text prompt with Ideogram 2.0,\nwith an optional style type and negative prompt. Set\n\u0060rendering_speed\u0060 to \u0060turbo\u0060 for faster, lower-cost generation.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images from a text prompt with Ideogram 2.0. Returns results\ndirectly by default; set \u0060async\u0060 or supply a \u0060webhook_url\u0060 to get a\n\u0060generation_id\u0060 and poll \u0060GET /v2/generations/{generation_id}\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateImageIdeogramV2Request\u003E(\n @\u0022{\n \u0022\u0022aspect_ratio\u0022\u0022: null,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022seed\u0022\u0022: 12345,\n \u0022\u0022rendering_speed\u0022\u0022: \u0022\u0022default\u0022\u0022,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022num_images\u0022\u0022: 1,\n \u0022\u0022magic_prompt\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022async\u0022\u0022: false,\n \u0022\u0022style_type\u0022\u0022: \u0022\u0022realistic\u0022\u0022,\n \u0022\u0022negative_prompt\u0022\u0022: \u0022\u0022negative_prompt\u0022\u0022,\n \u0022\u0022enable_copyright_detection\u0022\u0022: true,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022prompt\u0022\u0022\n}\u0022)!;\n\nvar response = await client.ImagesGenerate.PostGenerateImageV2IdeogramV2Async(\n request: request\n);\n\n// Example response:\n// {\n// \u0022data\u0022: [\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// },\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// }\n// ],\n// \u0022seed\u0022: 12345,\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -991,10 +1013,10 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 91, - "Title": "Generate images with Ideogram 2a from a text prompt", + "Order": 93, + "Title": "Generate with Ideogram 2a", "Slug": "post-generate-image-v2-ideogram-v2-a", - "Description": "Generate one or more images from a text prompt with Ideogram 2a, a\nfast, lower-cost model, with an optional style type. Set\n\u0060rendering_speed\u0060 to \u0060turbo\u0060 for even faster generation.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images from a text prompt with Ideogram 2a, a fast, lower-cost\nmodel. Returns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateImageIdeogramV2ARequest\u003E(\n @\u0022{\n \u0022\u0022magic_prompt\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022aspect_ratio\u0022\u0022: null,\n \u0022\u0022async\u0022\u0022: false,\n \u0022\u0022style_type\u0022\u0022: \u0022\u0022realistic\u0022\u0022,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022seed\u0022\u0022: 12345,\n \u0022\u0022rendering_speed\u0022\u0022: \u0022\u0022default\u0022\u0022,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022enable_copyright_detection\u0022\u0022: true,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022prompt\u0022\u0022,\n \u0022\u0022num_images\u0022\u0022: 1\n}\u0022)!;\n\nvar response = await client.ImagesGenerate.PostGenerateImageV2IdeogramV2AAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022data\u0022: [\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// },\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// }\n// ],\n// \u0022seed\u0022: 12345,\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -1002,43 +1024,43 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 92, - "Title": "Generate images with Ideogram 3.0 from a text prompt", + "Order": 94, + "Title": "Generate with Ideogram 3.0", "Slug": "post-generate-image-v2-ideogram-v3", - "Description": "Generate one or more images from a text prompt with Ideogram 3.0,\nwith optional style controls: style codes, a style preset, a color\npalette, or style references. Supply style references as a saved style\n(\u0060style_reference_collection_id\u0060), as\n\u0060style_reference_asset_identifiers\u0060 references (images already stored\nwith Ideogram), or as raw \u0060style_reference_images\u0060 bytes (multipart\nrequests only). These three style reference forms cannot be combined.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images from a text prompt with Ideogram 3.0. Optional style\ncontrols include style codes, a style preset, a color palette, and style\nreferences (uploaded \u0060style_reference_images\u0060). Returns\nresults directly by default; set \u0060async\u0060 or supply a \u0060webhook_url\u0060 to\nget a \u0060generation_id\u0060 and poll \u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Generate images with Ideogram 3.0 from a text prompt\n# @name post_generate_image_v2_ideogram_v3\nPOST {{host}}/v2/image/generate/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\ngeneral\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced style collection or asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Generate with Ideogram 3.0\n# @name post_generate_image_v2_ideogram_v3\nPOST {{host}}/v2/image/generate/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\ngeneral\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_image_v2_ideogram_v3", "Setup": null }, { - "Order": 93, - "Title": "Generate images of a consistent character with Ideogram 3.0", + "Order": 95, + "Title": "Generate a consistent character with Ideogram 3.0", "Slug": "post-generate-image-v2-ideogram-v3-character", - "Description": "Generate one or more images featuring a consistent character with\nIdeogram 3.0. Supply the character as a saved character\n(\u0060character_reference_collection_id\u0060), as\n\u0060character_reference_asset_identifiers\u0060 references (an image already\nstored with Ideogram), or as raw \u0060character_reference_images\u0060 bytes\n(multipart requests only, with an optional\n\u0060character_reference_mask\u0060 marking where the character is in the\nreference). If more than one form is supplied, the collection wins\nover the identifiers, and the identifiers win over the bytes.\n\nStyle references may be combined with the character on accounts with\naccess; otherwise the combination returns a 400. Supply them as a\nsaved style (\u0060style_reference_collection_id\u0060), as\n\u0060style_reference_asset_identifiers\u0060 references, or as raw\n\u0060style_reference_images\u0060 bytes, with the same precedence as the\ncharacter forms.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images featuring a consistent character with Ideogram 3.0.\nUpload the character as \u0060character_reference_images\u0060 using\n\u0060multipart/form-data\u0060. Returns\nresults directly by default; set \u0060async\u0060 or supply a \u0060webhook_url\u0060 to\nget a \u0060generation_id\u0060 and poll \u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Generate images of a consistent character with Ideogram 3.0\n# @name post_generate_image_v2_ideogram_v3_character\nPOST {{host}}/v2/image/generate/ideogram-3-character?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_images\u0022; filename=\u0022character_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_mask\u0022; filename=\u0022character_reference_mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced asset or collection was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Generate a consistent character with Ideogram 3.0\n# @name post_generate_image_v2_ideogram_v3_character\nPOST {{host}}/v2/image/generate/ideogram-3-character?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_images\u0022; filename=\u0022character_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_mask\u0022; filename=\u0022character_reference_mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_image_v2_ideogram_v3_character", "Setup": null }, { - "Order": 94, - "Title": "Generate images with a custom Ideogram 3.0 model", + "Order": 96, + "Title": "Generate with a custom Ideogram 3.0 model", "Slug": "post-generate-image-v2-ideogram-v3-custom-model", - "Description": "Generate one or more images with a custom Ideogram 3.0 model that the\nauthenticated user or organization can access. The model registry\ncontrols the model\u0027s supported rendering speeds and whether it removes\nbackgrounds automatically.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images with a custom Ideogram 3.0 model that you or your\norganization can access, selected by \u0060custom_model_uri\u0060. Returns results\ndirectly by default; set \u0060async\u0060 or supply a \u0060webhook_url\u0060 to get a\n\u0060generation_id\u0060 and poll \u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Generate images with a custom Ideogram 3.0 model\n# @name post_generate_image_v2_ideogram_v3_custom_model\nPOST {{host}}/v2/image/generate/ideogram-3-custom-model?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022custom_model_uri\u0022\n\nmodel/my-custom-model/version/1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\nturbo\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input or an unsupported model option.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: The custom model does not exist or is not accessible to this user or organization.\n# 404\n# Description: A referenced style asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Generate with a custom Ideogram 3.0 model\n# @name post_generate_image_v2_ideogram_v3_custom_model\nPOST {{host}}/v2/image/generate/ideogram-3-custom-model?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022custom_model_uri\u0022\n\nmodel/my-custom-model/version/1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\nturbo\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input or an unsupported model option.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: The custom model does not exist or is not accessible to this user or organization.\n# 404\n# Description: A requested resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_image_v2_ideogram_v3_custom_model", "Setup": null }, { - "Order": 95, - "Title": "Generate transparent-background images with Ideogram 3.0", + "Order": 97, + "Title": "Generate transparent images with Ideogram 3.0", "Slug": "post-generate-image-v2-ideogram-v3-transparent", - "Description": "Generate one or more images on a transparent background with\nIdeogram 3.0, delivered as PNGs with alpha. An optional\n\u0060upscale_factor\u0060 increases the output size after generation.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images on a transparent background with Ideogram 3.0, delivered\nas PNGs with alpha. Returns results directly by default; set \u0060async\u0060 or\nsupply a \u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateImageIdeogramV3TransparentRequest\u003E(\n @\u0022{\n \u0022\u0022aspect_ratio\u0022\u0022: null,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022seed\u0022\u0022: 12345,\n \u0022\u0022upscale_factor\u0022\u0022: \u0022\u0022x1\u0022\u0022,\n \u0022\u0022rendering_speed\u0022\u0022: \u0022\u0022default\u0022\u0022,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022num_images\u0022\u0022: 1,\n \u0022\u0022magic_prompt\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022async\u0022\u0022: false,\n \u0022\u0022negative_prompt\u0022\u0022: \u0022\u0022negative_prompt\u0022\u0022,\n \u0022\u0022enable_copyright_detection\u0022\u0022: true,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022prompt\u0022\u0022\n}\u0022)!;\n\nvar response = await client.ImagesGenerate.PostGenerateImageV2IdeogramV3TransparentAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022data\u0022: [\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// },\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// }\n// ],\n// \u0022seed\u0022: 12345,\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -1046,10 +1068,10 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 96, - "Title": "Generate images with Ideogram 4.0 from a text or structured prompt", + "Order": 98, + "Title": "Generate with Ideogram 4.0", "Slug": "post-generate-image-v2-ideogram-v4", - "Description": "Generate one or more images from a prompt with Ideogram 4.0. The\n\u0060prompt\u0060 accepts either natural language or a structured Ideogram 4.0\nJSON prompt; the server detects which was supplied. A structured JSON\nprompt is consumed by the model directly and skips magic prompt.\n\n\u0060magic_prompt\u0060 controls how a natural-language prompt is prepared:\n\u0060auto\u0060/\u0060on\u0060 rewrite and expand the prompt before generation, while\n\u0060off\u0060 keeps your wording and only converts the prompt into the\nstructured format the model consumes.\n\nWhen \u0060resolution\u0060 is omitted, the server picks an aspect ratio\nautomatically based on the prompt.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images with Ideogram 4.0 from a natural-language or structured\nJSON prompt. Returns results directly by default; set \u0060async\u0060 or supply\na \u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateImageIdeogramV4Request\u003E(\n @\u0022{\n \u0022\u0022magic_prompt\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022async\u0022\u0022: false,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022seed\u0022\u0022: 12345,\n \u0022\u0022rendering_speed\u0022\u0022: \u0022\u0022default\u0022\u0022,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022enable_copyright_detection\u0022\u0022: true,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022prompt\u0022\u0022,\n \u0022\u0022resolution\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022num_images\u0022\u0022: 1\n}\u0022)!;\n\nvar response = await client.ImagesGenerate.PostGenerateImageV2IdeogramV4Async(\n request: request\n);\n\n// Example response:\n// {\n// \u0022data\u0022: [\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// },\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// }\n// ],\n// \u0022seed\u0022: 12345,\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -1057,10 +1079,10 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 97, - "Title": "Generate images with a custom Ideogram 4.0 model", + "Order": 99, + "Title": "Generate with a custom Ideogram 4.0 model", "Slug": "post-generate-image-v2-ideogram-v4-custom-model", - "Description": "Generate one or more images with a custom Ideogram 4.0 model that the\nauthenticated user or organization can access. The model registry\ncontrols the model\u0027s supported rendering speeds.\n\nThe \u0060prompt\u0060 accepts either natural language or a structured Ideogram\n4.0 JSON prompt; the server detects which was supplied. A structured\nJSON prompt is consumed by the model directly and skips magic prompt.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images with a custom Ideogram 4.0 model that you or your\norganization can access, selected by \u0060custom_model_uri\u0060. Returns results\ndirectly by default; set \u0060async\u0060 or supply a \u0060webhook_url\u0060 to get a\n\u0060generation_id\u0060 and poll \u0060GET /v2/generations/{generation_id}\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateImageIdeogramV4CustomModelRequest\u003E(\n @\u0022{\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022seed\u0022\u0022: 12345,\n \u0022\u0022rendering_speed\u0022\u0022: \u0022\u0022turbo\u0022\u0022,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022custom_model_uri\u0022\u0022: \u0022\u0022model/my-custom-v4-model/version/1\u0022\u0022,\n \u0022\u0022resolution\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022num_images\u0022\u0022: 1,\n \u0022\u0022magic_prompt\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022async\u0022\u0022: false,\n \u0022\u0022enable_copyright_detection\u0022\u0022: true,\n \u0022\u0022stacked_custom_models\u0022\u0022: [\n {\n \u0022\u0022custom_model_uri\u0022\u0022: \u0022\u0022model/my-base-plora/version/1\u0022\u0022,\n \u0022\u0022weight\u0022\u0022: 0.5\n }\n ],\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022prompt\u0022\u0022\n}\u0022)!;\n\nvar response = await client.ImagesGenerate.PostGenerateImageV2IdeogramV4CustomModelAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022data\u0022: [\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// },\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// }\n// ],\n// \u0022seed\u0022: 12345,\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -1068,10 +1090,10 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 98, - "Title": "Generate transparent-background images with Ideogram 4.0", + "Order": 100, + "Title": "Generate transparent images with Ideogram 4.0", "Slug": "post-generate-image-v2-ideogram-v4-transparent", - "Description": "Generate one or more images on a transparent background with\nIdeogram 4.0, delivered as PNGs with alpha. The \u0060prompt\u0060 accepts\neither natural language or a structured Ideogram 4.0 JSON prompt; a\nstructured prompt is consumed directly and skips magic prompt, except\nthat its background description is replaced with a\ntransparent-background directive.\n\n\u0060magic_prompt\u0060 controls how a natural-language prompt is prepared:\n\u0060auto\u0060/\u0060on\u0060 rewrite and expand the prompt before generation, while\n\u0060off\u0060 keeps your wording and only converts the prompt into the\nstructured format the model consumes.\n\n\u0060output_resolution\u0060 selects the output tier (1k to 8k); tiers above\n2K are produced by upscaling after generation.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images on a transparent background with Ideogram 4.0, delivered\nas PNGs with alpha. Returns results directly by default; set \u0060async\u0060 or\nsupply a \u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateImageIdeogramV4TransparentRequest\u003E(\n @\u0022{\n \u0022\u0022magic_prompt\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022aspect_ratio\u0022\u0022: null,\n \u0022\u0022async\u0022\u0022: false,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022seed\u0022\u0022: 12345,\n \u0022\u0022rendering_speed\u0022\u0022: \u0022\u0022default\u0022\u0022,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022enable_copyright_detection\u0022\u0022: true,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022output_resolution\u0022\u0022: \u0022\u00221k\u0022\u0022,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022prompt\u0022\u0022,\n \u0022\u0022num_images\u0022\u0022: 1\n}\u0022)!;\n\nvar response = await client.ImagesGenerate.PostGenerateImageV2IdeogramV4TransparentAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022data\u0022: [\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// },\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// }\n// ],\n// \u0022seed\u0022: 12345,\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -1079,32 +1101,32 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 99, - "Title": "Generate images with Nano Banana 2, from a text prompt or by editing source images", + "Order": 101, + "Title": "Generate with Nano Banana 2", "Slug": "post-generate-image-v2-nano-banana2", - "Description": "Generate one or more images with Nano Banana 2. The prompt is\nconsumed by the model directly, without rewriting.\n\nSupplying source images turns the request into an edit: the model\napplies the prompt to the sources. Provide them either as\n\u0060image_asset_identifiers\u0060 references (images already stored with\nIdeogram) or as raw \u0060images\u0060 bytes (multipart requests only) \u2014 if both\nare supplied, the references win and the bytes are ignored. Without\nsource images the prompt alone drives the generation.\n\nThe output is served at the closest aspect ratio the model supports,\nat the requested \u0060resolution_tier\u0060 (1K by default).\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images with Nano Banana 2. Optionally upload source images as\n\u0060images\u0060 using \u0060multipart/form-data\u0060 to edit them with the prompt.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Generate images with Nano Banana 2, from a text prompt or by editing source images\n# @name post_generate_image_v2_nano_banana2\nPOST {{host}}/v2/image/generate/nano-banana-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution_tier\u0022\n\n1K\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Generate with Nano Banana 2\n# @name post_generate_image_v2_nano_banana2\nPOST {{host}}/v2/image/generate/nano-banana-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution_tier\u0022\n\n1K\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_image_v2_nano_banana2", "Setup": null }, { - "Order": 100, - "Title": "Generate images with Nano Banana Pro, from a text prompt or by editing source images", + "Order": 102, + "Title": "Generate with Nano Banana Pro", "Slug": "post-generate-image-v2-nano-banana-pro", - "Description": "Generate one or more images with Nano Banana Pro. The prompt is\nconsumed by the model directly, without rewriting.\n\nSupplying source images turns the request into an edit: the model\napplies the prompt to the sources. Provide them either as\n\u0060image_asset_identifiers\u0060 references (images already stored with\nIdeogram) or as raw \u0060images\u0060 bytes (multipart requests only) \u2014 if both\nare supplied, the references win and the bytes are ignored. Without\nsource images the prompt alone drives the generation.\n\nThe output is served at the closest aspect ratio the model supports,\nat the requested \u0060resolution_tier\u0060 (1K by default).\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images with Nano Banana Pro. Optionally upload source images as\n\u0060images\u0060 using \u0060multipart/form-data\u0060 to edit them with the prompt.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Generate images with Nano Banana Pro, from a text prompt or by editing source images\n# @name post_generate_image_v2_nano_banana_pro\nPOST {{host}}/v2/image/generate/nano-banana-pro?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution_tier\u0022\n\n1K\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Generate with Nano Banana Pro\n# @name post_generate_image_v2_nano_banana_pro\nPOST {{host}}/v2/image/generate/nano-banana-pro?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022images\u0022; filename=\u0022images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution_tier\u0022\n\n1K\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The generated images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_image_v2_nano_banana_pro", "Setup": null }, { - "Order": 101, - "Title": "Generate images with P-Image Ideogram from a text or structured prompt", + "Order": 103, + "Title": "Generate with P-Image Ideogram", "Slug": "post-generate-image-v2-p-image-ideogram", - "Description": "Generate one or more images with P-Image Ideogram, a fast model with\nselectable quality and resolution tiers. The \u0060prompt\u0060 accepts either\nnatural language or a structured Ideogram 4.0 JSON prompt; the server\ndetects which was supplied.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images with P-Image Ideogram, a fast model with selectable\nquality and resolution tiers. Returns results directly by default; set\n\u0060async\u0060 or supply a \u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateImagePImageIdeogramRequest\u003E(\n @\u0022{\n \u0022\u0022aspect_ratio\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022custom_height\u0022\u0022: 1,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022seed\u0022\u0022: 12345,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022custom_width\u0022\u0022: 6,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022resolution\u0022\u0022: \u0022\u00221k\u0022\u0022,\n \u0022\u0022num_images\u0022\u0022: 1,\n \u0022\u0022quality\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022magic_prompt\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022async\u0022\u0022: false,\n \u0022\u0022enable_copyright_detection\u0022\u0022: true,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022prompt\u0022\u0022\n}\u0022)!;\n\nvar response = await client.ImagesGenerate.PostGenerateImageV2PImageIdeogramAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022data\u0022: [\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// },\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// }\n// ],\n// \u0022seed\u0022: 12345,\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -1112,10 +1134,10 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 102, - "Title": "Generate images with Z-Image from a text prompt", + "Order": 104, + "Title": "Generate with Z-Image", "Slug": "post-generate-image-v2-z-image", - "Description": "Generate one or more images from a text prompt with Z-Image. The base\nmodel is pinned server-side.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Generate images from a text prompt with Z-Image. Returns results\ndirectly by default; set \u0060async\u0060 or supply a \u0060webhook_url\u0060 to get a\n\u0060generation_id\u0060 and poll \u0060GET /v2/generations/{generation_id}\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateImageZImageRequest\u003E(\n @\u0022{\n \u0022\u0022async\u0022\u0022: false,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022seed\u0022\u0022: 12345,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022A futuristic cityscape at golden hour, highly detailed.\u0022\u0022,\n \u0022\u0022resolution\u0022\u0022: \u0022\u00221024x1024\u0022\u0022,\n \u0022\u0022num_images\u0022\u0022: 1,\n \u0022\u0022num_inference_steps\u0022\u0022: 8\n}\u0022)!;\n\nvar response = await client.ImagesGenerate.PostGenerateImageV2ZImageAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022data\u0022: [\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// },\n// {\n// \u0022seed\u0022: 12345,\n// \u0022prompt\u0022: \u0022prompt\u0022,\n// \u0022resolution\u0022: \u00221024x1024\u0022,\n// \u0022url\u0022: \u0022https://openapi-generator.tech\u0022,\n// \u0022is_image_safe\u0022: true\n// }\n// ],\n// \u0022seed\u0022: 12345,\n// \u0022generation_id\u0022: \u0022generation_id\u0022\n// }", "Format": "sdk", @@ -1123,183 +1145,183 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 103, - "Title": "Repaint a masked region with Ideogram 3.0, by asset id or by uploaded bytes", + "Order": 105, + "Title": "Inpaint with Ideogram 3.0", "Slug": "post-inpaint-image-v2-ideogram-v3", - "Description": "Repaint the masked region of a source image from a text prompt with\nIdeogram 3.0. For each of the source image and the mask, supply either\nan \u0060AssetIdentifier\u0060 reference (\u0060image_asset_identifier\u0060 /\n\u0060mask_asset_identifier\u0060) or the raw image bytes directly (\u0060image\u0060 /\n\u0060mask\u0060, multipart requests only). If both a reference and bytes are\nsupplied for the same input, the reference wins and the bytes are\nignored.\n\nOptional style controls: style codes, a style preset, or style\nreference images.\nSupply style references as a saved style\n(\u0060style_reference_collection_id\u0060), as\n\u0060style_reference_asset_identifiers\u0060 references (images already stored\nwith Ideogram), or as raw \u0060style_reference_images\u0060 bytes (multipart\nrequests only). If more than one form is supplied, the collection wins\nover the identifiers, and the identifiers win over the bytes.\n\nThe output matches the size of the source image (snapped to the\nnearest resolution the model renders). By default the request blocks\nuntil the images are ready and returns them in \u0060data\u0060. Set \u0060async\u0060 to\ntrue to return immediately after the request is accepted, then poll\nfor completion and results with \u0060GET /v1/generations/{generation_id}\u0060\nusing the returned \u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Repaint the masked region of a source image with Ideogram 3.0, guided\nby a text prompt. Upload the source \u0060image\u0060 and its \u0060mask\u0060 using\n\u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Repaint a masked region with Ideogram 3.0, by asset id or by uploaded bytes\n# @name post_inpaint_image_v2_ideogram_v3\nPOST {{host}}/v2/image/inpaint/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\ngeneral\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The repainted images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced asset or style collection was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Inpaint with Ideogram 3.0\n# @name post_inpaint_image_v2_ideogram_v3\nPOST {{host}}/v2/image/inpaint/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\ngeneral\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The repainted images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_inpaint_image_v2_ideogram_v3", "Setup": null }, { - "Order": 104, - "Title": "Repaint a masked region with a consistent character with Ideogram 3.0", + "Order": 106, + "Title": "Inpaint a consistent character with Ideogram 3.0", "Slug": "post-inpaint-image-v2-ideogram-v3-character", - "Description": "Repaint the masked region of a source image so it features a\nconsistent character, with Ideogram 3.0. For each of the source image\nand the mask, supply either an \u0060AssetIdentifier\u0060 reference\n(\u0060image_asset_identifier\u0060 / \u0060mask_asset_identifier\u0060) or the raw image\nbytes directly (\u0060image\u0060 / \u0060mask\u0060, multipart requests only). If both a\nreference and bytes are supplied for the same input, the reference\nwins and the bytes are ignored.\n\nSupply the character as a saved character\n(\u0060character_reference_collection_id\u0060), as\n\u0060character_reference_asset_identifiers\u0060 references (an image already\nstored with Ideogram), or as raw \u0060character_reference_images\u0060 bytes\n(multipart requests only, with an optional\n\u0060character_reference_mask\u0060 marking where the character is in the\nreference). If more than one form is supplied, the collection wins\nover the identifiers, and the identifiers win over the bytes.\n\nOptional style controls may be combined with the character when\n\u0060style_type\u0060 is \u0060auto\u0060. Supply either style codes or style references.\nSupply style references as a saved style\n(\u0060style_reference_collection_id\u0060), as\n\u0060style_reference_asset_identifiers\u0060 references, or as raw\n\u0060style_reference_images\u0060 bytes (multipart requests only). If more than\none reference form is supplied, the collection wins over the\nidentifiers, and the identifiers win over the bytes. API-key callers\nalso need access to the style-with-character API rollout.\n\nThe output matches the size of the source image (snapped to the\nnearest resolution the model renders). By default the request blocks\nuntil the images are ready and returns them in \u0060data\u0060. Set \u0060async\u0060 to\ntrue to return immediately after the request is accepted, then poll\nfor completion and results with \u0060GET /v1/generations/{generation_id}\u0060\nusing the returned \u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Repaint the masked region of a source image with Ideogram 3.0 so it\nfeatures a consistent character. Upload the source \u0060image\u0060, its\n\u0060mask\u0060, and a \u0060character_reference_images\u0060 image (or use a saved\ncharacter) using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Repaint a masked region with a consistent character with Ideogram 3.0\n# @name post_inpaint_image_v2_ideogram_v3_character\nPOST {{host}}/v2/image/inpaint/ideogram-3-character?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_images\u0022; filename=\u0022character_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_mask\u0022; filename=\u0022character_reference_mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The repainted images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced asset or collection was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Inpaint a consistent character with Ideogram 3.0\n# @name post_inpaint_image_v2_ideogram_v3_character\nPOST {{host}}/v2/image/inpaint/ideogram-3-character?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_images\u0022; filename=\u0022character_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_mask\u0022; filename=\u0022character_reference_mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The repainted images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_inpaint_image_v2_ideogram_v3_character", "Setup": null }, { - "Order": 105, - "Title": "Repaint a masked region with a custom Ideogram 3.0 model", + "Order": 107, + "Title": "Inpaint with a custom Ideogram 3.0 model", "Slug": "post-inpaint-image-v2-ideogram-v3-custom-model", - "Description": "Repaint the masked region of a source image with a custom Ideogram 3.0\nmodel the authenticated user or organization can access. Supply the\nmodel URI returned by the custom-model API as \u0060custom_model_uri\u0060.\n\nFor each of the source image and mask, supply either an\n\u0060AssetIdentifier\u0060 reference (\u0060image_asset_identifier\u0060 /\n\u0060mask_asset_identifier\u0060) or raw bytes (\u0060image\u0060 / \u0060mask\u0060, multipart\nrequests only). A reference wins if both forms are supplied.\n\nOptional style controls are style codes, a style preset, or style\nreference images. Supply style references as a saved style, existing\nasset identifiers, or raw image bytes. Only one style control may be\nused; when multiple reference forms are supplied, the collection wins\nover identifiers, and identifiers win over bytes.\n\nBy default the request blocks until the images are ready. Set \u0060async\u0060\nto true to return after dispatch and poll\n\u0060GET /v1/generations/{generation_id}\u0060.", + "Description": "Repaint the masked region of a source image with a custom Ideogram 3.0\nmodel, passed as \u0060custom_model_uri\u0060. Upload the source \u0060image\u0060 and its\n\u0060mask\u0060 using \u0060multipart/form-data\u0060. Returns results directly by\ndefault; set \u0060async\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Repaint a masked region with a custom Ideogram 3.0 model\n# @name post_inpaint_image_v2_ideogram_v3_custom_model\nPOST {{host}}/v2/image/inpaint/ideogram-3-custom-model?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022custom_model_uri\u0022\n\nmodel/my-custom-model/version/1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\nturbo\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The repainted images, or an acknowledgement for an asynchronous request.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# 403\n# Description: The caller cannot use the requested custom model.\n# 404\n# Description: A referenced asset or style collection was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Inpaint with a custom Ideogram 3.0 model\n# @name post_inpaint_image_v2_ideogram_v3_custom_model\nPOST {{host}}/v2/image/inpaint/ideogram-3-custom-model?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022custom_model_uri\u0022\n\nmodel/my-custom-model/version/1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\nturbo\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The repainted images, or an acknowledgement for an asynchronous request.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: The caller cannot use the requested custom model.\n# 404\n# Description: A referenced resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_inpaint_image_v2_ideogram_v3_custom_model", "Setup": null }, { - "Order": 106, - "Title": "Edit an image with Ideogram 4.5, keeping the source\u0027s exact geometry", + "Order": 108, + "Title": "Precise edit with Ideogram 4.5", "Slug": "post-precise-edit-image-v2-ideogram45", - "Description": "Edit an image with Ideogram 4.5, returning output at that image\u0027s exact\nwidth and height. An image too large for the model is scaled down to\nfit while keeping its exact proportion, and one whose aspect ratio is\noutside 1:6 to 6:1 is rejected \u2014 this endpoint never reshapes, so there\nis no size to reshape it to. Unlike\n\u0060POST /v2/image/generate/ideogram-4-5\u0060, this endpoint takes no \u0060size\u0060:\nthe output always matches the image being edited, so the edit drops\nback into whatever it came from without reframing.\n\nWhen the output is delivered at the image\u0027s own size (every image the\nmodel can hold), pixels the edit did not meaningfully change are\nrestored exactly from the image being edited, with the edited region\nblended smoothly into its surroundings \u2014 untouched areas stay\nidentical across repeated edits. An image too large for the model is\ndelivered at the scaled-down size, where every pixel is resampled, so\nit is returned as rendered.\n\nSupply the image to edit as an \u0060image_asset_identifier\u0060 reference or as\nraw \u0060image\u0060 bytes (multipart requests only); if both are supplied, the\nreference wins and the bytes are ignored. Add up to four more images\nvia \u0060reference_image_asset_identifiers\u0060 or \u0060reference_images\u0060 to guide\nthe edit \u2014 those are never edited themselves.\n\nSupply a \u0060mask\u0060 to confine the edit to part of the image being edited.\nThe mask is optional \u2014 without one the prompt is applied to the whole\nimage. Masks are read as an additional reference image, so a masked\nrequest may carry at most three \u0060reference_images\u0060.\n\nThe \u0060prompt\u0060 is the edit instruction. It accepts either natural\nlanguage or a structured JSON prompt; the server detects which was\nsupplied. A natural-language instruction is automatically rewritten\ninto the model\u0027s structured edit contract, while a prompt that is\nalready valid structured JSON is consumed directly.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Edit an image with Ideogram 4.5 and get the result back at that image\u0027s\nexact width and height. Upload the image as \u0060image\u0060 using\n\u0060multipart/form-data\u0060, with optional \u0060reference_images\u0060 and a \u0060mask\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Edit an image with Ideogram 4.5, keeping the source\u0027s exact geometry\n# @name post_precise_edit_image_v2_ideogram45\nPOST {{host}}/v2/image/precise-edit/ideogram-4-5?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_images\u0022; filename=\u0022reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nmedium\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The edited images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Precise edit with Ideogram 4.5\n# @name post_precise_edit_image_v2_ideogram45\nPOST {{host}}/v2/image/precise-edit/ideogram-4-5?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_images\u0022; filename=\u0022reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nmedium\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The edited images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_precise_edit_image_v2_ideogram45", "Setup": null }, { - "Order": 107, - "Title": "Reframe an image with Ideogram 3.0, by asset id or by uploaded bytes", + "Order": 109, + "Title": "Reframe with Ideogram 3.0", "Slug": "post-reframe-image-v2-ideogram-v3", - "Description": "Expand an image to a new Ideogram 3.0 resolution. The source pixels\nare preserved in the center and Ideogram fills the new area. Supply\nexactly one source: an \u0060AssetIdentifier\u0060 reference\n(\u0060image_asset_identifier\u0060) or raw image bytes (\u0060image\u0060, multipart\nrequests only). Supplying both forms, or neither, is rejected.\n\nOptional style controls are mutually exclusive. Supply at most one of\n\u0060style_preset\u0060, \u0060style_codes\u0060, \u0060style_reference_asset_identifiers\u0060, or\nraw \u0060style_reference_images\u0060 (multipart requests only). Each style\nreference transport accepts at most 10 images.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately, then poll\n\u0060GET /v1/generations/{generation_id}\u0060.", + "Description": "Expand an image to a new Ideogram 3.0 resolution, keeping the source\npixels in the center and filling the new area. Upload the source\n\u0060image\u0060 using \u0060multipart/form-data\u0060. Returns results directly by\ndefault; set \u0060async\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Reframe an image with Ideogram 3.0, by asset id or by uploaded bytes\n# @name post_reframe_image_v2_ideogram_v3\nPOST {{host}}/v2/image/reframe/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nbright_art\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The reframed images, or an acknowledgement for an asynchronous request.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced source or style asset was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Reframe with Ideogram 3.0\n# @name post_reframe_image_v2_ideogram_v3\nPOST {{host}}/v2/image/reframe/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nbright_art\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The reframed images, or an acknowledgement for an asynchronous request.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced resource was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_reframe_image_v2_ideogram_v3", "Setup": null }, { - "Order": 108, - "Title": "Reframe an image with Nano Banana 2", + "Order": 110, + "Title": "Reframe with Nano Banana 2", "Slug": "post-reframe-image-nano-banana2", - "Description": "Expand one image to a new aspect ratio with Nano Banana 2.\nSupply either an existing Ideogram image asset or raw image bytes,\nbut not both. The requested aspect ratio is resolved to the closest\nsupported 1K output dimensions.\n\nThis operation is asynchronous. It returns as soon as the request is\naccepted; poll \u0060GET /v1/generations/{generation_id}\u0060 for completion\nand results.", + "Description": "Expand an image to a new aspect ratio with Nano Banana 2. Upload the\nsource \u0060image\u0060 using \u0060multipart/form-data\u0060. Always asynchronous:\nreturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nfor results.", "Language": "http", - "Code": "### Reframe an image with Nano Banana 2\n# @name post_reframe_image_nano_banana2\nPOST {{host}}/v2/image/reframe/nano-banana-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\n969\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source asset was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Reframe with Nano Banana 2\n# @name post_reframe_image_nano_banana2\nPOST {{host}}/v2/image/reframe/nano-banana-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\n969\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced resource was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_reframe_image_nano_banana2", "Setup": null }, { - "Order": 109, - "Title": "Remix an existing image with Ideogram 3.0, guided by a prompt", + "Order": 111, + "Title": "Remix with Ideogram 3.0", "Slug": "post-remix-image-v2-ideogram-v3", - "Description": "Transform an existing image with Ideogram 3.0, guided by a text\nprompt. Supply the source either as an \u0060image_asset_identifier\u0060\nreference (an image already stored with Ideogram) or as raw \u0060image\u0060\nbytes (multipart requests only). Supplying both is rejected rather\nthan one being ignored. \u0060image_weight\u0060 controls how closely the\nresult follows the source; when omitted the server picks a value from\nyour prompt.\n\nOmit \u0060resolution\u0060 and \u0060aspect_ratio\u0060 to keep the source image\u0027s\nshape. If you request a different shape, the source is center-cropped\nto fit it first, and whatever falls outside the new shape is\ndiscarded.\n\nOptional style controls work as on the Ideogram 3.0 generate\nendpoint: style codes, a style preset, a color palette, or style\nreference images.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Transform an existing image with Ideogram 3.0, guided by a text\nprompt. Upload the source \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Remix an existing image with Ideogram 3.0, guided by a prompt\n# @name post_remix_image_v2_ideogram_v3\nPOST {{host}}/v2/image/remix/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_weight\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\n1x3\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\ngeneral\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The remixed images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source or style asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Remix with Ideogram 3.0\n# @name post_remix_image_v2_ideogram_v3\nPOST {{host}}/v2/image/remix/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_weight\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\n1x3\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\ngeneral\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The remixed images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_remix_image_v2_ideogram_v3", "Setup": null }, { - "Order": 110, - "Title": "Remix an existing image with Ideogram 3.0, featuring a consistent character", + "Order": 112, + "Title": "Remix a consistent character with Ideogram 3.0", "Slug": "post-remix-image-v2-ideogram-v3-character", - "Description": "Transform an existing image with Ideogram 3.0, guided by a text\nprompt and featuring a consistent character. Supply the source either\nas an \u0060image_asset_identifier\u0060 reference (an image already stored\nwith Ideogram) or as raw \u0060image\u0060 bytes (multipart requests only).\nSupplying both is rejected rather than one being ignored.\n\u0060image_weight\u0060 controls how closely the result follows the source;\nwhen omitted the server picks a value from your prompt.\n\nSupply the character as a saved character\n(\u0060character_reference_collection_id\u0060), as\n\u0060character_reference_asset_identifiers\u0060 references, or as raw\n\u0060character_reference_images\u0060 bytes (multipart requests only, with an\noptional \u0060character_reference_mask\u0060 marking where the character is in\nthe reference). If more than one form is supplied, the collection\nwins over the identifiers, and the identifiers win over the bytes.\n\nOmit \u0060resolution\u0060 and \u0060aspect_ratio\u0060 to keep the source image\u0027s\nshape. If you request a different shape, the source is center-cropped\nto fit it first, and whatever falls outside the new shape is\ndiscarded.\n\nStyle references may be supplied as a saved style\n(\u0060style_reference_collection_id\u0060), as\n\u0060style_reference_asset_identifiers\u0060 references, or as raw\n\u0060style_reference_images\u0060 bytes, with the same precedence as the\ncharacter forms.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Transform an existing image with Ideogram 3.0 so it features a\nconsistent character, guided by a text prompt. Upload the source\n\u0060image\u0060 and a \u0060character_reference_images\u0060 image (or use a saved\ncharacter) using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Remix an existing image with Ideogram 3.0, featuring a consistent character\n# @name post_remix_image_v2_ideogram_v3_character\nPOST {{host}}/v2/image/remix/ideogram-3-character?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_weight\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_images\u0022; filename=\u0022character_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_mask\u0022; filename=\u0022character_reference_mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\n1x3\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The remixed images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced asset or collection was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Remix a consistent character with Ideogram 3.0\n# @name post_remix_image_v2_ideogram_v3_character\nPOST {{host}}/v2/image/remix/ideogram-3-character?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_weight\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_images\u0022; filename=\u0022character_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022character_reference_mask\u0022; filename=\u0022character_reference_mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./character_reference_mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\n1x3\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_type\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_collection_version_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The remixed images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_remix_image_v2_ideogram_v3_character", "Setup": null }, { - "Order": 111, - "Title": "Remix an existing image with a custom Ideogram 3.0 model", + "Order": 113, + "Title": "Remix with a custom Ideogram 3.0 model", "Slug": "post-remix-image-v2-ideogram-v3-custom-model", - "Description": "Transform an existing image with a custom Ideogram 3.0 model that the\nauthenticated user or organization can access, guided by a text\nprompt. Supply the source either as an \u0060image_asset_identifier\u0060\nreference (an image already stored with Ideogram) or as raw \u0060image\u0060\nbytes (multipart requests only). Supplying both is rejected rather\nthan one being ignored. \u0060image_weight\u0060 controls how closely the\nresult follows the source; when omitted the server picks a value from\nyour prompt.\n\nOmit \u0060resolution\u0060 and \u0060aspect_ratio\u0060 to keep the source image\u0027s\nshape. If you request a different shape, the source is center-cropped\nto fit it first, and whatever falls outside the new shape is\ndiscarded.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Transform an existing image with a custom Ideogram 3.0 model that your\nuser or organization can access, guided by a text prompt. Upload the\nsource \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Remix an existing image with a custom Ideogram 3.0 model\n# @name post_remix_image_v2_ideogram_v3_custom_model\nPOST {{host}}/v2/image/remix/ideogram-3-custom-model?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022custom_model_uri\u0022\n\nmodel/my-custom-model/version/1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_weight\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\n1x3\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\nturbo\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The remixed images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input or an unsupported model option.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: The custom model does not exist or is not accessible to this user or organization.\n# 404\n# Description: The referenced source or style asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Remix with a custom Ideogram 3.0 model\n# @name post_remix_image_v2_ideogram_v3_custom_model\nPOST {{host}}/v2/image/remix/ideogram-3-custom-model?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022custom_model_uri\u0022\n\nmodel/my-custom-model/version/1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_weight\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n1280x800\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\n1x3\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\nturbo\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022magic_prompt\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_palette\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_codes\u0022\n\nABCD1234\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_preset\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022style_reference_images\u0022; filename=\u0022style_reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./style_reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The remixed images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input or an unsupported model option.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: The custom model does not exist or is not accessible to this user or organization.\n# 404\n# Description: A referenced resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_remix_image_v2_ideogram_v3_custom_model", "Setup": null }, { - "Order": 112, - "Title": "Remix an existing image with Ideogram 4.0, guided by a prompt", + "Order": 114, + "Title": "Remix with Ideogram 4.0", "Slug": "post-remix-image-v2-ideogram-v4", - "Description": "Transform an existing image with Ideogram 4.0, guided by a text\nprompt. Supply the source either as an \u0060image_asset_identifier\u0060\nreference (an image already stored with Ideogram) or as raw \u0060image\u0060\nbytes (multipart requests only). Supplying both is rejected rather\nthan one being ignored. \u0060image_weight\u0060 controls how closely the\nresult follows the source; when omitted the server picks a value from\nyour prompt.\n\nOmit \u0060resolution\u0060 to keep the source image\u0027s shape. A \u0060resolution\u0060\nwhose aspect ratio differs from the source\u0027s cannot be combined with\n\u0060image_weight\u0060 \u2014 that request is rejected with a 400.\n\nThe prompt is always interpreted by an instruction-editing model, so\nthere is no \u0060magic_prompt\u0060 option. Remixes are not reproducible, so\nno seed is accepted; the response reports the seed the request\nresolved to.\n\nBy default the request blocks until the images are ready and returns\nthem in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Transform an existing image with Ideogram 4.0, guided by a text\nprompt. Upload the source \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Remix an existing image with Ideogram 4.0, guided by a prompt\n# @name post_remix_image_v2_ideogram_v4\nPOST {{host}}/v2/image/remix/ideogram-4?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_weight\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The remixed images (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Remix with Ideogram 4.0\n# @name post_remix_image_v2_ideogram_v4\nPOST {{host}}/v2/image/remix/ideogram-4?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_weight\u0022\n\n0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enable_copyright_detection\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The remixed images (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: A referenced resource was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_remix_image_v2_ideogram_v4", "Setup": null }, { - "Order": 113, - "Title": "Upscale an image with Nano Banana Pro, by asset id or by uploaded bytes", + "Order": 115, + "Title": "Upscale with Nano Banana Pro", "Slug": "post-upscale-image-nano-banana-pro", - "Description": "Regenerate the source image at a higher resolution tier (1K, 2K, or\n4K) while preserving its content, composition, and style. Supply the\nsource either as an \u0060image_asset_identifier\u0060 reference (an image\nalready stored with Ideogram) or as raw \u0060image\u0060 bytes (multipart\nrequests only) \u2014 callers are never required to upload the asset\nfirst. If both are supplied, the reference wins and the bytes are\nignored. Uploaded bytes are used for this request only and are not\nstored as an asset; upscales of a referenced asset keep a visible\nlink to their source image.\n\nAn optional \u0060prompt\u0060 adds short guidance for the enhancement; the\nimage is otherwise upscaled as-is. The source must be smaller than\nthe requested \u0060resolution_tier\u0060.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after\nthe request is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Regenerate an image at a higher \u0060resolution_tier\u0060 (1K, 2K, or 4K) while\npreserving its content, composition, and style. Upload the source\n\u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Upscale an image with Nano Banana Pro, by asset id or by uploaded bytes\n# @name post_upscale_image_nano_banana_pro\nPOST {{host}}/v2/image/upscale/nano-banana-pro?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution_tier\u0022\n\n2K\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Upscale with Nano Banana Pro\n# @name post_upscale_image_nano_banana_pro\nPOST {{host}}/v2/image/upscale/nano-banana-pro?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution_tier\u0022\n\n2K\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The source image was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_upscale_image_nano_banana_pro", "Setup": null }, { - "Order": 114, - "Title": "Upscale an image with Topaz Bloom 2, by asset id or by uploaded bytes", + "Order": 116, + "Title": "Upscale with Topaz Bloom 2", "Slug": "post-upscale-image-topaz-bloom2", - "Description": "Creatively upscale one image to 2x, 4x, or 8x its original resolution,\nup to a maximum output of 8192px per side. Supply the source either as\nan \u0060image_asset_identifier\u0060 reference (an image already stored with\nIdeogram) or as raw \u0060image\u0060 bytes (multipart requests only) \u2014 callers\nare never required to upload the asset first. If both are supplied,\nthe reference wins and the bytes are ignored. Uploaded bytes are used\nfor this request only and are not stored as an asset; upscales of a\nreferenced asset keep a visible link to their source image.\n\nAn optional \u0060prompt\u0060 guides the regenerated detail, and \u0060creativity\u0060\ncontrols how strongly the model reinterprets the source while\nenlarging it.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after\nthe request is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Creatively upscale an image to 2x, 4x, or 8x its original resolution,\noptionally guided by a \u0060prompt\u0060. Upload the source \u0060image\u0060 using\n\u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Upscale an image with Topaz Bloom 2, by asset id or by uploaded bytes\n# @name post_upscale_image_topaz_bloom2\nPOST {{host}}/v2/image/upscale/topaz-bloom-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022creativity\u0022\n\n3\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_preservation\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Upscale with Topaz Bloom 2\n# @name post_upscale_image_topaz_bloom2\nPOST {{host}}/v2/image/upscale/topaz-bloom-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022creativity\u0022\n\n3\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022color_preservation\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The source image was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_upscale_image_topaz_bloom2", "Setup": null }, { - "Order": 115, - "Title": "Upscale an image with Topaz Redefine, by asset id or by uploaded bytes", + "Order": 117, + "Title": "Upscale with Topaz Redefine", "Slug": "post-upscale-image-topaz-redefine", - "Description": "Creatively upscale one image to 2x, 4x, or 8x its original resolution,\nup to a maximum output of 8192px per side. Supply the source either as\nan \u0060image_asset_identifier\u0060 reference (an image already stored with\nIdeogram) or as raw \u0060image\u0060 bytes (multipart requests only) \u2014 callers\nare never required to upload the asset first. If both are supplied,\nthe reference wins and the bytes are ignored. Uploaded bytes are used\nfor this request only and are not stored as an asset; upscales of a\nreferenced asset keep a visible link to their source image.\n\nAn optional \u0060prompt\u0060 guides the regenerated detail, or \u0060autoprompt\u0060\nlets the model describe the image itself. \u0060creativity\u0060 controls how\nstrongly the model reinterprets the source, \u0060texture\u0060 how much fine\ntexture it adds, and the precision knobs (sharpen, denoise, detail,\nface enhancement, subject detection) refine the result.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after\nthe request is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Creatively upscale an image to 2x, 4x, or 8x its original resolution,\nguided by an optional \u0060prompt\u0060 or \u0060autoprompt\u0060. Upload the source\n\u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Upscale an image with Topaz Redefine, by asset id or by uploaded bytes\n# @name post_upscale_image_topaz_redefine\nPOST {{host}}/v2/image/upscale/topaz-redefine?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022creativity\u0022\n\n3\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022autoprompt\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022texture\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022detail\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022detail_strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022sharpen\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022denoise\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_creativity\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022subject_detection\u0022\n\nall\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Upscale with Topaz Redefine\n# @name post_upscale_image_topaz_redefine\nPOST {{host}}/v2/image/upscale/topaz-redefine?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022creativity\u0022\n\n3\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022autoprompt\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022texture\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022detail\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022detail_strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022sharpen\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022denoise\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_creativity\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022subject_detection\u0022\n\nall\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The source image was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_upscale_image_topaz_redefine", "Setup": null }, { - "Order": 116, - "Title": "Upscale an image with Topaz Standard V2, by asset id or by uploaded bytes", + "Order": 118, + "Title": "Upscale with Topaz Standard V2", "Slug": "post-upscale-image-topaz-standard-v2", - "Description": "Upscale one image to 2x, 4x, or 8x its original resolution, up to a\nmaximum output of 8192px per side. Supply the source either as an\n\u0060image_asset_identifier\u0060 reference (an image already stored with\nIdeogram) or as raw \u0060image\u0060 bytes (multipart requests only) \u2014 callers\nare never required to upload the asset first. If both are supplied,\nthe reference wins and the bytes are ignored. Uploaded bytes are used\nfor this request only and are not stored as an asset; upscales of a\nreferenced asset keep a visible link to their source image.\n\nUpscaling takes no prompt: the model enhances the source image as-is.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after\nthe request is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is\nneeded. Upload the source \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Upscale an image with Topaz Standard V2, by asset id or by uploaded bytes\n# @name post_upscale_image_topaz_standard_v2\nPOST {{host}}/v2/image/upscale/topaz-standard-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022sharpen\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022denoise\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022fix_compression\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_creativity\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022subject_detection\u0022\n\nall\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source asset was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Upscale with Topaz Standard V2\n# @name post_upscale_image_topaz_standard_v2\nPOST {{host}}/v2/image/upscale/topaz-standard-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022sharpen\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022denoise\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022fix_compression\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_creativity\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022subject_detection\u0022\n\nall\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The source image was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_upscale_image_topaz_standard_v2", "Setup": null }, { - "Order": 117, - "Title": "Upscale an image with Topaz Text Refine, by asset id or by uploaded bytes", + "Order": 119, + "Title": "Upscale with Topaz Text Refine", "Slug": "post-upscale-image-topaz-text-refine", - "Description": "Upscale one image to 2x, 4x, or 8x its original resolution, up to a\nmaximum output of 8192px per side. Supply the source either as an\n\u0060image_asset_identifier\u0060 reference (an image already stored with\nIdeogram) or as raw \u0060image\u0060 bytes (multipart requests only) \u2014 callers\nare never required to upload the asset first. If both are supplied,\nthe reference wins and the bytes are ignored. Uploaded bytes are used\nfor this request only and are not stored as an asset; upscales of a\nreferenced asset keep a visible link to their source image.\n\nUpscaling takes no prompt: the model enhances the source image as-is.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after\nthe request is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is\nneeded. Upload the source \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Upscale an image with Topaz Text Refine, by asset id or by uploaded bytes\n# @name post_upscale_image_topaz_text_refine\nPOST {{host}}/v2/image/upscale/topaz-text-refine?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022sharpen\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022denoise\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022fix_compression\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_creativity\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022subject_detection\u0022\n\nall\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source asset was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Upscale with Topaz Text Refine\n# @name post_upscale_image_topaz_text_refine\nPOST {{host}}/v2/image/upscale/topaz-text-refine?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022sharpen\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022denoise\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022fix_compression\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_strength\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022face_enhancement_creativity\u0022\n\n0.0\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022subject_detection\u0022\n\nall\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The source image was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_upscale_image_topaz_text_refine", "Setup": null }, { - "Order": 118, - "Title": "Upscale an image with Topaz Wonder 3.5, by asset id or by uploaded bytes", + "Order": 120, + "Title": "Upscale with Topaz Wonder 3.5", "Slug": "post-upscale-image-topaz-wonder35", - "Description": "Upscale one image to 2x, 4x, or 8x its original resolution, up to a\nmaximum output of 8192px per side. Supply the source either as an\n\u0060image_asset_identifier\u0060 reference (an image already stored with\nIdeogram) or as raw \u0060image\u0060 bytes (multipart requests only) \u2014 callers\nare never required to upload the asset first. If both are supplied,\nthe reference wins and the bytes are ignored. Uploaded bytes are used\nfor this request only and are not stored as an asset; upscales of a\nreferenced asset keep a visible link to their source image.\n\nUpscaling takes no prompt: the model enhances the source image as-is.\nUse \u0060enhancement_strength\u0060 to control how strongly the generative\nmodel reconstructs detail.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after\nthe request is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Upscale an image to 2x, 4x, or 8x its original resolution, with\n\u0060enhancement_strength\u0060 controlling how strongly detail is reconstructed.\nUpload the source \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Upscale an image with Topaz Wonder 3.5, by asset id or by uploaded bytes\n# @name post_upscale_image_topaz_wonder35\nPOST {{host}}/v2/image/upscale/topaz-wonder-3-5?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enhancement_strength\u0022\n\nhigh\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The referenced source asset was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Upscale with Topaz Wonder 3.5\n# @name post_upscale_image_topaz_wonder35\nPOST {{host}}/v2/image/upscale/topaz-wonder-3-5?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022enhancement_strength\u0022\n\nhigh\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 404\n# Description: The source image was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_upscale_image_topaz_wonder35", "Setup": null }, { - "Order": 119, + "Order": 121, "Title": "Fetch the media bytes for an integration asset", "Slug": "get-integration-asset-delivery", "Description": "Redeems the short-lived signed delivery reference returned by an integration asset search and streams the asset\u0027s media bytes. The signed reference is the sole authorization for this endpoint; it is rejected once it expires or when the integration it names has changed.", @@ -1310,7 +1332,7 @@ "Setup": null }, { - "Order": 120, + "Order": 122, "Title": "List enabled integration types", "Slug": "get-integrations", "Description": "Lists the distinct integration types enabled for the authenticated organization. The response does not expose configured integration rows, provider details, configuration, or credentials.", @@ -1321,7 +1343,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 121, + "Order": 123, "Title": "Search assets from an enabled integration type", "Slug": "post-integration-assets-search", "Description": "Generated from OpenAPI examples.", @@ -1332,7 +1354,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 122, + "Order": 124, "Title": "Testing", "Slug": "post-internal-testing", "Description": "Just a testing endpoint", @@ -1343,7 +1365,7 @@ "Setup": null }, { - "Order": 123, + "Order": 125, "Title": "Add members to a specific organization", "Slug": "add-organization-members", "Description": "Generated from OpenAPI examples.", @@ -1354,7 +1376,7 @@ "Setup": null }, { - "Order": 124, + "Order": 126, "Title": "Cancel a pending invite for an organization", "Slug": "cancel-organization-invite", "Description": "Generated from OpenAPI examples.", @@ -1365,7 +1387,7 @@ "Setup": null }, { - "Order": 125, + "Order": 127, "Title": "Creates an API key.", "Slug": "create-api-key", "Description": "Generated from OpenAPI examples.", @@ -1376,7 +1398,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 126, + "Order": 128, "Title": "Create an API key for a specific organization", "Slug": "create-api-key-v2", "Description": "Generated from OpenAPI examples.", @@ -1387,7 +1409,7 @@ "Setup": null }, { - "Order": 127, + "Order": 129, "Title": "Create a payment setup session for inline card collection.", "Slug": "create-api-payment", "Description": "Returns a client_secret for the org\u0027s payment customer so the inline payment\nmodal can save a card without leaving the app.\n\nSoft-deprecated: the inline Elements flow was removed in the Stripe.js\neager-bundle incident (2026-05-20). New clients should use the\nstripe_payment_setup_url field on ManageApiStripeSubscriptionResponse, which\nreturns a hosted Stripe Checkout URL instead. This endpoint will be formally\ndeprecated and then removed once no callers reference it.", @@ -1398,7 +1420,7 @@ "Setup": null }, { - "Order": 128, + "Order": 130, "Title": "Delete an API key.", "Slug": "delete-single-api-key", "Description": "Generated from OpenAPI examples.", @@ -1409,7 +1431,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 129, + "Order": 131, "Title": "Demote admins back to member role in a TEAM_API or ENTERPRISE_API organization", "Slug": "demote-organization-admins", "Description": "Generated from OpenAPI examples.", @@ -1420,7 +1442,7 @@ "Setup": null }, { - "Order": 130, + "Order": 132, "Title": "Lifetime credit totals for the API user\u0027s account.", "Slug": "get-api-credit-summary", "Description": "Returns the lifetime credit KPIs (consumed, expired, issued) used to\nrender the API credit dashboard strip. All values default to $0 when\nMetronome is unavailable so the FE can always render.", @@ -1431,7 +1453,7 @@ "Setup": null }, { - "Order": 131, + "Order": 133, "Title": "Retrieve current API keys and their respective data.", "Slug": "get-api-keys", "Description": "Generated from OpenAPI examples.", @@ -1442,7 +1464,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 132, + "Order": 134, "Title": "Retrieve API keys for a specific organization", "Slug": "get-api-keys-v2", "Description": "Generated from OpenAPI examples.", @@ -1453,7 +1475,7 @@ "Setup": null }, { - "Order": 133, + "Order": 135, "Title": "Get search results for user handles with suggestions for a particular organization.", "Slug": "get-api-organization-user-suggestions", "Description": "Generated from OpenAPI examples.", @@ -1464,7 +1486,7 @@ "Setup": null }, { - "Order": 134, + "Order": 136, "Title": "Retrieve the user\u0027s current API profiles", "Slug": "get-api-profiles", "Description": "Generated from OpenAPI examples.", @@ -1475,7 +1497,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 135, + "Order": 137, "Title": "Retrieve data relevant to connecting to Stripe.", "Slug": "get-api-stripe-subscription", "Description": "Generated from OpenAPI examples.", @@ -1486,7 +1508,7 @@ "Setup": null }, { - "Order": 136, + "Order": 138, "Title": "Retrieve data relevant to creating an API subscription.", "Slug": "get-api-subscription", "Description": "Generated from OpenAPI examples.", @@ -1497,7 +1519,7 @@ "Setup": null }, { - "Order": 137, + "Order": 139, "Title": "Retrieve the latest terms of service for API usage.", "Slug": "get-api-terms", "Description": "Generated from OpenAPI examples.", @@ -1508,7 +1530,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 138, + "Order": 140, "Title": "Retrieve the Stripe billing portal URL for a specific organization", "Slug": "get-organization-billing-portal", "Description": "Generated from OpenAPI examples.", @@ -1519,7 +1541,7 @@ "Setup": null }, { - "Order": 139, + "Order": 141, "Title": "Retrieve members of a specific organization", "Slug": "get-organization-members", "Description": "Returns both active members and pending invites for the organization. A pending invite is identified by a non-null invite_status (e.g. PENDING); active members have a null invite_status.", @@ -1530,7 +1552,7 @@ "Setup": null }, { - "Order": 140, + "Order": 142, "Title": "Retrieve usage information segmented by time period with tool-specific breakdowns", "Slug": "get-usage-info", "Description": "Generated from OpenAPI examples.", @@ -1541,7 +1563,7 @@ "Setup": null }, { - "Order": 141, + "Order": 143, "Title": "Retrieve user credit information and spending metrics", "Slug": "get-user-credits", "Description": "Generated from OpenAPI examples.", @@ -1552,7 +1574,7 @@ "Setup": null }, { - "Order": 142, + "Order": 144, "Title": "Retrieve user spend commit information", "Slug": "get-user-spend-commit-info", "Description": "Generated from OpenAPI examples.", @@ -1563,7 +1585,7 @@ "Setup": null }, { - "Order": 143, + "Order": 145, "Title": "Retrieve invoices for a specific organization", "Slug": "list-organization-invoices", "Description": "Generated from OpenAPI examples.", @@ -1574,7 +1596,7 @@ "Setup": null }, { - "Order": 144, + "Order": 146, "Title": "Add credits to an API user\u0027s account.", "Slug": "post-add-credits-for-api", "Description": "Generated from OpenAPI examples.", @@ -1585,7 +1607,7 @@ "Setup": null }, { - "Order": 145, + "Order": 147, "Title": "Update API subscription settings", "Slug": "post-api-subscription", "Description": "Generated from OpenAPI examples.", @@ -1596,7 +1618,7 @@ "Setup": null }, { - "Order": 146, + "Order": 148, "Title": "Accept terms", "Slug": "post-api-terms", "Description": "Generated from OpenAPI examples.", @@ -1607,7 +1629,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 147, + "Order": 149, "Title": "Promote members to ADMIN role in a TEAM_API or ENTERPRISE_API organization", "Slug": "promote-organization-admins", "Description": "Generated from OpenAPI examples.", @@ -1618,7 +1640,7 @@ "Setup": null }, { - "Order": 148, + "Order": 150, "Title": "Remove members from a specific organization", "Slug": "remove-organization-members", "Description": "Generated from OpenAPI examples.", @@ -1629,7 +1651,7 @@ "Setup": null }, { - "Order": 149, + "Order": 151, "Title": "Resend a pending invite for an organization", "Slug": "resend-organization-invite", "Description": "Generated from OpenAPI examples.", @@ -1640,7 +1662,7 @@ "Setup": null }, { - "Order": 150, + "Order": 152, "Title": "Update a single field on an organization\u0027s API properties.", "Slug": "update-organization-api-properties", "Description": "Lets an organization owner toggle API-only settings such as\ncopyright_detection_enabled. Updates only the fields explicitly present\nin the request body; absent fields are left unchanged.", @@ -1651,7 +1673,7 @@ "Setup": null }, { - "Order": 151, + "Order": 153, "Title": "Update an API key\u0027s user-supplied label.", "Slug": "update-single-api-key", "Description": "Generated from OpenAPI examples.", @@ -1662,7 +1684,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 152, + "Order": 154, "Title": "Get stale mini-app preview entries", "Slug": "get-stale-preview-mini-apps", "Description": "Returns preview ids whose most recent successful publish is older than the cutoff. This read-only endpoint does not delete preview entries.", @@ -1673,7 +1695,7 @@ "Setup": null }, { - "Order": 153, + "Order": 155, "Title": "Publish a mini-app catalog entry", "Slug": "publish-mini-app", "Description": "Publishes a mini-app\u0027s catalog entry. Called by the mini-apps deploy pipeline after a deploy to register or refresh a single app, keyed by its unique slug. Re-publishing an existing app refreshes the deploy-managed fields (label, description, embed mode, scopes, image-input support, deployment details, and website) while leaving administrator-managed settings and artwork untouched. Artwork from the request is used only when creating a new app.", @@ -1684,7 +1706,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 154, + "Order": 156, "Title": "Publish a mini-app preview entry", "Slug": "publish-preview-mini-app", "Description": "Publishes a mini-app preview entry. Called by the mini-apps preview deploy pipeline to register a throwaway preview deploy, keyed by its unique preview id. Re-publishing an existing preview id refreshes every deploy-managed field. Preview entries are independent from the main catalog: they carry no slug, owner, or membership gating, and anyone with the preview link can access the app.", @@ -1695,7 +1717,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 155, + "Order": 157, "Title": "Unpublish a mini-app preview entry", "Slug": "unpublish-preview-mini-app", "Description": "Deletes a mini-app preview entry by its preview id. Repeated requests succeed when the entry is already absent, so preview teardown can retry safely.", @@ -1706,7 +1728,7 @@ "Setup": null }, { - "Order": 156, + "Order": 158, "Title": "Get model details", "Slug": "get-custom-model", "Description": "Get detailed information about a specific custom model. The user must either own the model or the model must be shared with the user\u0027s organization via the model registry. Returns 404 if the model is not found or not accessible.", @@ -1717,7 +1739,7 @@ "Setup": null }, { - "Order": 157, + "Order": 159, "Title": "List models", "Slug": "list-custom-models", "Description": "Lists custom models for the authenticated user. Use the \u0060scope\u0060 parameter to control which models are returned. If omitted, returns both owned models and models shared with the user\u0027s organization via the model registry. \u0060owned\u0060 returns only models created by the user. \u0060shared\u0060 returns only models shared via the model registry, excluding the user\u0027s own models.", @@ -1728,7 +1750,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 158, + "Order": 160, "Title": "Train a custom Ideogram v3 model", "Slug": "train-model-v3", "Description": "Start training a custom Ideogram v3 model from a dataset using default hyperparameters. The dataset must contain at least 15 images and a maximum of 100 images.", @@ -1739,7 +1761,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 159, + "Order": 161, "Title": "Train a custom Ideogram v3 model with advanced hyperparameters", "Slug": "train-model-v3-advanced", "Description": "Start training a custom Ideogram v3 model from a dataset with caller-supplied hyperparameters (training steps, LoRA rank, EMA decay, learning rate). All hyperparameters are optional and fall back to defaults when omitted. The dataset must contain at least 15 images and a maximum of 100 images. Returns the model ID and training status.", @@ -1750,7 +1772,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 160, + "Order": 162, "Title": "Train a custom Ideogram v4 model", "Slug": "train-model-v4", "Description": "Start training a custom Ideogram v4 model from a dataset using default hyperparameters. The dataset must contain at least 15 images and a maximum of 100 images.", @@ -1761,7 +1783,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 161, + "Order": 163, "Title": "Train a custom Ideogram v4 model with advanced hyperparameters", "Slug": "train-model-v4-advanced", "Description": "Start training a custom Ideogram v4 model from a dataset with caller-supplied hyperparameters (training steps, LoRA rank, EMA decay, learning rate). All hyperparameters are optional and fall back to defaults when omitted. The dataset must contain at least 15 images and a maximum of 100 images. Returns the model ID and training status.", @@ -1772,18 +1794,18 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 162, - "Title": "Remove a masked object from an image, by asset id or by uploaded bytes", + "Order": 164, + "Title": "Remove an object", "Slug": "post-remove-object-from-v2-assets", - "Description": "Remove a masked object from an image. For each of the source image and the\nmask, supply either an \u0060AssetIdentifier\u0060 reference (\u0060image_asset_identifier\u0060\n/ \u0060mask_asset_identifier\u0060) or the raw image bytes directly (\u0060image\u0060 / \u0060mask\u0060,\nmultipart requests only) \u2014 callers are never required to call\n\u0060POST /v2/assets\u0060 first. If both a reference and bytes are supplied for the\nsame input, the reference wins and the bytes are ignored.\n\nPoll for completion with \u0060GET /v1/generations/{generation_id}\u0060 using the\nreturned \u0060generation_id\u0060.\n\nThis is the \u0060/v2\u0060 capability-first shape; no \u0060model\u0060 or \u0060model_uri\u0060 field is\nexposed until a second backend exists.", + "Description": "Remove a masked object from an image. Upload the source \u0060image\u0060 and a\n\u0060mask\u0060 of the same size using \u0060multipart/form-data\u0060. Returns a\n\u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060 for the\nresult.", "Language": "http", - "Code": "### Remove a masked object from an image, by asset id or by uploaded bytes\n# @name post_remove_object_from_v2_assets\nPOST {{host}}/v2/image/remove-object/ideogram-1?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022store_assets\u0022\n\nfalse\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Object removal request accepted; poll for completion with \u0060GET /v1/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to remove an object.\n# 404\n# Description: A referenced source or mask asset was not found.\n# 413\n# Description: An uploaded source or mask image is too large.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Remove an object\n# @name post_remove_object_from_v2_assets\nPOST {{host}}/v2/image/remove-object/ideogram-1?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022mask\u0022; filename=\u0022mask.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./mask.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022store_assets\u0022\n\nfalse\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Object removal request accepted; poll for completion with \u0060GET /v2/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to remove an object.\n# 404\n# Description: The source image or mask was not found.\n# 413\n# Description: An uploaded source or mask image is too large.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_remove_object_from_v2_assets", "Setup": null }, { - "Order": 163, + "Order": 165, "Title": "Generate Magic Prompt", "Slug": "post-magic-prompt", "Description": "Transforms basic prompts into a magic prompt. Internal use only (feature flagged). TODO: update description if enabled externally.", @@ -1794,7 +1816,7 @@ "Setup": null }, { - "Order": 164, + "Order": 166, "Title": "Generate a Magic Prompt with Ideogram 4.0", "Slug": "post-magic-prompt-v4", "Description": "Transforms a basic prompt into an enhanced Ideogram 4.0 magic prompt.\nThe magic prompt model version is fixed; callers cannot select it.\nWhen \u0060aspect_ratio\u0060 is \u0060AUTO\u0060 (the default), the model selects the most\nsuitable aspect ratio for the prompt and returns it in the response.", @@ -1805,7 +1827,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 165, + "Order": 167, "Title": "Check whether content was created by Ideogram", "Slug": "post-provenance-verify", "Description": "Checks image content for an Ideogram provenance manifest (C2PA Content\nCredentials) and returns the disclosure it carries: the provider name,\nthe generating system and its version, the creation time, and the\ncontent\u0027s unique identifier.\n\nUpload the image to verify as the \u0060content\u0060 part.\n\nThis endpoint is public and unauthenticated \u2014 no API key is required.\nSubmitted content is analyzed in memory and never stored.", @@ -1816,65 +1838,65 @@ "Setup": null }, { - "Order": 166, - "Title": "Remove an image background", + "Order": 168, + "Title": "Remove background", "Slug": "post-remove-background-v2", - "Description": "Remove the background from one image and return a foreground PNG with\ntransparency. Supply exactly one source: raw \u0060image\u0060 bytes in a\nmultipart request, or an existing \u0060image_asset_identifier\u0060 in JSON or\nmultipart form.\n\nBy default the request blocks until the foreground image is ready and\nreturns it in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after\nthe request is accepted, then poll \u0060GET /v1/generations/{generation_id}\u0060.\n\nAPI-key requests use the organization bound to the key. Firebase Bearer\nrequests use their selected organization, and Mini App context tokens\nremain bound to the organization in the token. When \u0060private\u0060 is omitted,\nBearer and Mini App callers inherit their plan\u0027s private-generation\ndefault; Enterprise generations are always private.", + "Description": "Remove the background from an image and return the foreground as a\ntransparent PNG. Upload the source \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns the result directly by default; set \u0060async\u0060 to get a\n\u0060generation_id\u0060 and poll \u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Remove an image background\n# @name post_remove_background_v2\nPOST {{host}}/v2/image/remove-background/ideogram-1?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The foreground image (synchronous requests), or an acknowledgement to poll (\u0060async\u0060 requests). If a synchronous failure occurs after heartbeat streaming begins, the HTTP status is already committed; the response instead contains \u0060error\u0060 and \u0060status_code\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: The selected organization or Mini App scope is not authorized.\n# 404\n# Description: A referenced source asset was not found or is not readable.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: The background-removal request failed.\n# 503\n# Description: Background removal is temporarily unavailable.", + "Code": "### Remove background\n# @name post_remove_background_v2\nPOST {{host}}/v2/image/remove-background/ideogram-1?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The foreground image (synchronous requests), or an acknowledgement to poll (\u0060async\u0060 requests). If a synchronous request fails after the response has started streaming, the HTTP status is already 200; the body contains \u0060error\u0060 and \u0060status_code\u0060 instead.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to remove backgrounds.\n# 404\n# Description: The source image was not found or is not readable.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: The background-removal request failed.\n# 503\n# Description: Background removal is temporarily unavailable.", "Format": "http", "OperationId": "post_remove_background_v2", "Setup": null }, { - "Order": 167, - "Title": "Replace an image background", + "Order": 169, + "Title": "Replace background with GPT Image 2", "Slug": "post-replace-background", - "Description": "Replaces the background of one image from a text prompt while preserving\nthe foreground subject. The foreground mask is detected automatically;\ncallers do not provide a mask.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.\n\nSupply exactly one source transport: an existing \u0060AssetIdentifier\u0060 in\n\u0060image_asset_identifier\u0060, or raw \u0060image\u0060 bytes in a multipart request.\nSupplying both or neither is rejected with a 400.", + "Description": "Replace the background of an image from a text prompt while keeping the\nautomatically detected foreground subject; no mask is needed. Upload\nthe source \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Replace an image background\n# @name post_replace_background\nPOST {{host}}/v2/image/replace-background/gpt-image-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nhigh\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Background replacement accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to replace backgrounds.\n# 404\n# Description: The source asset was not found or is not readable.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 503\n# Description: Background replacement is temporarily unavailable.", + "Code": "### Replace background with GPT Image 2\n# @name post_replace_background\nPOST {{host}}/v2/image/replace-background/gpt-image-2?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022quality\u0022\n\nhigh\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Background replacement accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to replace backgrounds.\n# 404\n# Description: The source image was not found or is not readable.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 503\n# Description: Background replacement is temporarily unavailable.", "Format": "http", "OperationId": "post_replace_background", "Setup": null }, { - "Order": 168, - "Title": "Replace an image background with Ideogram 3.0", + "Order": 170, + "Title": "Replace background with Ideogram 3.0", "Slug": "post-replace-background-ideogram-v3", - "Description": "Replaces the background of one image from a text prompt while preserving\nthe foreground subject, generated by Ideogram 3.0 inpainting. The\nforeground mask is detected automatically; callers do not provide a mask.\n\nThe request is processed asynchronously. Poll\n\u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060\nuntil the generation is completed or failed.\n\nSupply exactly one source transport: an existing \u0060AssetIdentifier\u0060 in\n\u0060image_asset_identifier\u0060, or raw \u0060image\u0060 bytes in a multipart request.\nSupplying both or neither is rejected with a 400. The source\u0027s longer\nside must be at most 3 times its shorter side; wider aspect ratios are\nrejected with a 400.", + "Description": "Replace the background of an image from a text prompt with Ideogram 3.0,\nkeeping the automatically detected foreground subject; no mask is\nneeded. Upload the source \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Replace an image background with Ideogram 3.0\n# @name post_replace_background_ideogram_v3\nPOST {{host}}/v2/image/replace-background/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Background replacement accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to replace backgrounds.\n# 404\n# Description: The source asset was not found or is not readable.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 503\n# Description: Background replacement is temporarily unavailable.", + "Code": "### Replace background with Ideogram 3.0\n# @name post_replace_background_ideogram_v3\nPOST {{host}}/v2/image/replace-background/ideogram-3?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022rendering_speed\u0022\n\ndefault\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022num_images\u0022\n\n1\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: Background replacement accepted for asynchronous processing.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to replace backgrounds.\n# 404\n# Description: The source image was not found or is not readable.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 503\n# Description: Background replacement is temporarily unavailable.", "Format": "http", "OperationId": "post_replace_background_ideogram_v3", "Setup": null }, { - "Order": 169, - "Title": "Upscale an image", + "Order": 171, + "Title": "Upscale with automatic model selection", "Slug": "post-upscale", - "Description": "Upscale one image to 2x, 4x, or 8x its original resolution, up to a\nmaximum output of 8192px per side. Ideogram selects the best upscaling\nmodel for each request, and the selection may change over time; callers\nnever choose a model.\n\nSupply the source either as an \u0060image_asset_identifier\u0060 reference (an\nimage already stored with Ideogram) or as raw \u0060image\u0060 bytes (multipart\nrequests only). Provide exactly one of the two forms; supplying both,\nor neither, is rejected with a 400. Uploaded bytes are used for this\nrequest only and are not stored as an asset; upscales of a referenced\nasset keep a visible link to their source image.\n\nUpscaling takes no prompt: the source image is enhanced as-is.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in \u0060data\u0060. Set \u0060async\u0060 to true to return immediately after\nthe request is accepted, then poll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using the returned\n\u0060generation_id\u0060.\n\nSupplying a \u0060webhook_url\u0060 makes the request asynchronous whatever\n\u0060async\u0060 says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "Description": "Upscale an image to 2x, 4x, or 8x its original resolution with a model\nIdeogram picks per request; the choice may change over time. Upload the\nsource \u0060image\u0060 using \u0060multipart/form-data\u0060.\nReturns results directly by default; set \u0060async\u0060 or supply a\n\u0060webhook_url\u0060 to get a \u0060generation_id\u0060 and poll\n\u0060GET /v2/generations/{generation_id}\u0060.", "Language": "http", - "Code": "### Upscale an image\n# @name post_upscale\nPOST {{host}}/v2/image/upscale/auto?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022internal\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to upscale images.\n# 404\n# Description: The referenced source asset was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Upscale with automatic model selection\n# @name post_upscale\nPOST {{host}}/v2/image/upscale/auto?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022upscale_factor\u0022\n\nx2\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022seed\u0022\n\n12345\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022internal\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022async\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: The upscaled image (synchronous requests), or an acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060 (\u0060async\u0060 requests).\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided, or the output would exceed the 8K limit.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: Not authorized to upscale images.\n# 404\n# Description: The source image was not found.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_upscale", "Setup": null }, { - "Order": 170, - "Title": "Produce a video from reference media with MiniMax H3", + "Order": 172, + "Title": "Reference to video with MiniMax H3", "Slug": "post-edit-video-minimax-h3-reference-to-video", - "Description": "Produce a video from a text prompt and reference media with MiniMax H3.\n\nThe prompt addresses the references by position: the first reference\nimage is \u0060Image 1\u0060, the second \u0060Image 2\u0060, the first reference video is\n\u0060Video 1\u0060, and the first reference audio is \u0060Audio 1\u0060. Supply reference\nimages either as\n\u0060reference_image_asset_identifiers\u0060 (images already stored with\nIdeogram) or as raw \u0060reference_images\u0060 bytes (multipart requests only);\nsupplying both is rejected, and uploaded bytes are used for this request\nonly and are not stored as an asset. Supply reference videos as\n\u0060reference_video_asset_identifiers\u0060, which must reference videos\ngenerated or uploaded with Ideogram. At most 9 reference images and 3 reference\nvideos are accepted, and reference videos are capped again on clip\nlength. Optional \u0060reference_audios\u0060 accepts MP3/WAV uploads alongside\nan image or video. Audio and video references must total at most 15\nseconds; at most 12 references are accepted across all media.\n\nReferences are optional. With none, the video is produced from the\nprompt alone.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Produce a video from a text prompt and optional reference media with\nMiniMax H3. Upload \u0060reference_images\u0060 and \u0060reference_audios\u0060 using\n\u0060multipart/form-data\u0060, and address them in the prompt by position\n(\u0060Image 1\u0060, \u0060Audio 1\u0060, \u2026). Returns a \u0060generation_id\u0060; poll\n\u0060GET /v2/generations/{generation_id}\u0060 or supply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Produce a video from reference media with MiniMax H3\n# @name post_edit_video_minimax_h3_reference_to_video\nPOST {{host}}/v2/video/generate/minimax-h3-reference-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nImage 1 walks through the snowy forest at dawn.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_images\u0022; filename=\u0022reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_video_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_audios\u0022; filename=\u0022reference_audios.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_audios.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\n16x9\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n2K\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt_expansion_mode\u0022\n\nbalanced\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: A referenced asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Reference to video with MiniMax H3\n# @name post_edit_video_minimax_h3_reference_to_video\nPOST {{host}}/v2/video/generate/minimax-h3-reference-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nImage 1 walks through the snowy forest at dawn.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_images\u0022; filename=\u0022reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_video_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_audios\u0022; filename=\u0022reference_audios.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_audios.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\n16x9\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n2K\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt_expansion_mode\u0022\n\nbalanced\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: A referenced asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_edit_video_minimax_h3_reference_to_video", "Setup": null }, { - "Order": 171, - "Title": "Edit a video with Seedance 2.0 by regenerating from frames of it", + "Order": 173, + "Title": "Edit video with Seedance 2.0", "Slug": "post-edit-video-seed-dance2", - "Description": "Edit a video you already have stored with Ideogram by replacing part of\nit. Reference the source video with \u0060video_asset_identifier\u0060 and mark the\nspan to replace with \u0060start_frame_time\u0060 and \u0060end_frame_time\u0060, in seconds.\nSeedance 2.0 generates a new clip for that span from your prompt, and the\nresult is the source video with the generated clip spliced in over the\nspan: everything before \u0060start_frame_time\u0060, then the generated clip, then\neverything from \u0060end_frame_time\u0060 on. That edited video is the asset the\nrequest produces.\n\n\u0060is_start_frame_included\u0060 and \u0060is_end_frame_included\u0060 anchor the generated\nclip on the span\u0027s own end frames, so it joins the surrounding footage\ninstead of cutting to something unrelated. Anchoring the start opens the\nclip on the frame already at \u0060start_frame_time\u0060; anchoring the end lands\nit on the frame at \u0060end_frame_time\u0060; anchoring both joins at each seam. At\nleast one must be anchored.\n\nThe generated clip is used at its own length, which the model rarely makes\nexactly the span\u0027s, so the edited video is usually a different length from\nthe source. Request a \u0060duration\u0060 close to the span to keep them near each\nother. The clip is scaled and cropped to fill the source\u0027s frame and\nconformed to its frame rate, so resolution and aspect ratio follow the\nsource rather than being requested.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Edit a video you already have stored with Ideogram by replacing part of\nit. Reference the source video with \u0060video_asset_identifier\u0060 and mark the\nspan to replace with \u0060start_frame_time\u0060 and \u0060end_frame_time\u0060, in seconds.\nSeedance 2.0 generates a new clip for that span from your prompt, and the\nresult is the source video with the generated clip spliced in over the\nspan: everything before \u0060start_frame_time\u0060, then the generated clip, then\neverything from \u0060end_frame_time\u0060 on. That edited video is the asset the\nrequest produces.\n\n\u0060is_start_frame_included\u0060 and \u0060is_end_frame_included\u0060 anchor the generated\nclip on the span\u0027s own end frames, so it joins the surrounding footage\ninstead of cutting to something unrelated. Anchoring the start opens the\nclip on the frame already at \u0060start_frame_time\u0060; anchoring the end lands\nit on the frame at \u0060end_frame_time\u0060; anchoring both joins at each seam. At\nleast one must be anchored.\n\nThe generated clip is used at its own length, which the model rarely makes\nexactly the span\u0027s, so the edited video is usually a different length from\nthe source. Request a \u0060duration\u0060 close to the span to keep them near each\nother. The clip is scaled and cropped to fill the source\u0027s frame and\nconformed to its frame rate, so resolution and aspect ratio follow the\nsource rather than being requested.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v2/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.EditVideoSeedDance2Request\u003E(\n @\u0022{\n \u0022\u0022duration\u0022\u0022: 5,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022end_frame_time\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022is_end_frame_included\u0022\u0022: false,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022video_asset_identifier\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022generate_audio\u0022\u0022: false,\n \u0022\u0022is_start_frame_included\u0022\u0022: true,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022The camera pushes in as the dancer turns towards the light.\u0022\u0022,\n \u0022\u0022resolution\u0022\u0022: \u0022\u0022\u0022\u0022,\n \u0022\u0022start_frame_time\u0022\u0022: \u0022\u0022\u0022\u0022\n}\u0022)!;\n\nvar response = await client.VideoEdit.PostEditVideoSeedDance2Async(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022,\n// \u0022created\u0022: \u00222000-01-23T04:56:07\\u002B00:00\u0022\n// }", "Format": "sdk", @@ -1882,21 +1904,21 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 172, - "Title": "Generate a video from a first frame with Kling v3 Standard, by asset id or by uploaded bytes", + "Order": 174, + "Title": "Image to video with Kling v3 Standard", "Slug": "post-generate-video-kling-v3-standard-image-to-video", - "Description": "Generate a video from a first-frame image and a text prompt with Kling\nv3 Standard. Supply the first frame either as an\n\u0060image_asset_identifier\u0060 reference (an image already stored with\nIdeogram) or as raw \u0060image\u0060 bytes (multipart requests only) \u2014 callers\nare never required to upload the asset first. Exactly one source is\nrequired; supplying neither or both is rejected. Only image assets are\naccepted as a first frame. Uploaded bytes are used for this request\nonly and are not stored as an asset.\n\nTo generate a transition between two stills, supply a final frame as\nwell, in either of the same two forms: \u0060end_image_asset_identifier\u0060 or\n\u0060end_image\u0060. The final frame is optional and follows the same\none-form-only rule.\n\nThe generated video takes its aspect ratio from the first frame, so\nthere is no aspect ratio to set.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Generate a video from a first-frame image and a text prompt with Kling\nv3 Standard. Upload the first frame as \u0060image\u0060, and optionally a final\nframe as \u0060end_image\u0060, using \u0060multipart/form-data\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Generate a video from a first frame with Kling v3 Standard, by asset id or by uploaded bytes\n# @name post_generate_video_kling_v3_standard_image_to_video\nPOST {{host}}/v2/video/generate/kling-3-standard-image-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image\u0022; filename=\u0022end_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./end_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nThe camera slowly pans right as the waves roll in.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022generate_audio\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022shot_type\u0022\n\ncustomize\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022cfg_scale\u0022\n\n0.5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: The referenced first-frame asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Image to video with Kling v3 Standard\n# @name post_generate_video_kling_v3_standard_image_to_video\nPOST {{host}}/v2/video/generate/kling-3-standard-image-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image\u0022; filename=\u0022end_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./end_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nThe camera slowly pans right as the waves roll in.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022negative_prompt\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022generate_audio\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022shot_type\u0022\n\ncustomize\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022cfg_scale\u0022\n\n0.5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: The first-frame image was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_video_kling_v3_standard_image_to_video", "Setup": null }, { - "Order": 173, - "Title": "Generate a video from a text prompt with Kling v3 Standard", + "Order": 175, + "Title": "Text to video with Kling v3 Standard", "Slug": "post-generate-video-kling-v3-standard-text-to-video", - "Description": "Generate a video from a text prompt with Kling v3 Standard.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Generate a video from a text prompt with Kling v3 Standard.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateVideoKlingV3StandardTextToVideoRequest\u003E(\n @\u0022{\n \u0022\u0022duration\u0022\u0022: 5,\n \u0022\u0022shot_type\u0022\u0022: null,\n \u0022\u0022aspect_ratio\u0022\u0022: null,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022negative_prompt\u0022\u0022: \u0022\u0022negative_prompt\u0022\u0022,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022generate_audio\u0022\u0022: false,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022A red fox running through a snowy forest at dawn.\u0022\u0022,\n \u0022\u0022cfg_scale\u0022\u0022: 0.5\n}\u0022)!;\n\nvar response = await client.VideoGenerate.PostGenerateVideoKlingV3StandardTextToVideoAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022,\n// \u0022created\u0022: \u00222000-01-23T04:56:07\\u002B00:00\u0022\n// }", "Format": "sdk", @@ -1904,21 +1926,21 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 174, - "Title": "Generate a video from a first frame with MiniMax H3, by asset id or by uploaded bytes", + "Order": 176, + "Title": "Image to video with MiniMax H3", "Slug": "post-generate-video-minimax-h3-image-to-video", - "Description": "Generate a video from a first-frame image and a text prompt with\nMiniMax H3. Supply the first frame either as an\n\u0060image_asset_identifier\u0060 reference (an image already stored with\nIdeogram) or as raw \u0060image\u0060 bytes (multipart requests only) \u2014 callers\nare never required to upload the asset first. Exactly one source is\nrequired; supplying neither or both is rejected. Only image assets are\naccepted as a first frame. Uploaded bytes are used for this request\nonly and are not stored as an asset.\n\nTo generate a transition between two stills, supply a final frame as\nwell, in either of the same two forms: \u0060end_image_asset_identifier\u0060 or\n\u0060end_image\u0060. The final frame is optional and follows the same\none-form-only rule.\n\nThe generated video takes its aspect ratio from the first frame, so\nthis endpoint accepts no \u0060aspect_ratio\u0060.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Generate a video from a first-frame image and a text prompt with\nMiniMax H3. Upload the first frame as \u0060image\u0060, and optionally a final\nframe as \u0060end_image\u0060, using \u0060multipart/form-data\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Generate a video from a first frame with MiniMax H3, by asset id or by uploaded bytes\n# @name post_generate_video_minimax_h3_image_to_video\nPOST {{host}}/v2/video/generate/minimax-h3-image-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image\u0022; filename=\u0022end_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./end_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nThe camera slowly pans right as the waves roll in.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n2K\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: The referenced first-frame asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Image to video with MiniMax H3\n# @name post_generate_video_minimax_h3_image_to_video\nPOST {{host}}/v2/video/generate/minimax-h3-image-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image\u0022; filename=\u0022end_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./end_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nThe camera slowly pans right as the waves roll in.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n2K\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: The first-frame image was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_video_minimax_h3_image_to_video", "Setup": null }, { - "Order": 175, - "Title": "Generate a video from a text prompt with MiniMax H3", + "Order": 177, + "Title": "Text to video with MiniMax H3", "Slug": "post-generate-video-minimax-h3-text-to-video", - "Description": "Generate a video from a text prompt with MiniMax H3.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Generate a video from a text prompt with MiniMax H3.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateVideoMinimaxH3TextToVideoRequest\u003E(\n @\u0022{\n \u0022\u0022duration\u0022\u0022: 5,\n \u0022\u0022aspect_ratio\u0022\u0022: null,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022A red fox running through a snowy forest at dawn.\u0022\u0022,\n \u0022\u0022resolution\u0022\u0022: null\n}\u0022)!;\n\nvar response = await client.VideoGenerate.PostGenerateVideoMinimaxH3TextToVideoAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022,\n// \u0022created\u0022: \u00222000-01-23T04:56:07\\u002B00:00\u0022\n// }", "Format": "sdk", @@ -1926,32 +1948,32 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 176, - "Title": "Generate a video from a first frame with Seedance 2.5, by asset id or by uploaded bytes", + "Order": 178, + "Title": "Image to video with Seedance 2.5", "Slug": "post-generate-video-seed-dance25-image-to-video", - "Description": "Generate a video from a first-frame image and a text prompt with\nSeedance 2.5. Supply the first frame either as an\n\u0060image_asset_identifier\u0060 reference (an image already stored with\nIdeogram) or as raw \u0060image\u0060 bytes (multipart requests only) \u2014 callers\nare never required to upload the asset first. Exactly one source is\nrequired; supplying neither or both is rejected. Only image assets are\naccepted as a first frame. Uploaded bytes are used for this request\nonly and are not stored as an asset.\n\nTo generate a transition between two stills, supply a final frame as\nwell, in either of the same two forms: \u0060end_image_asset_identifier\u0060 or\n\u0060end_image\u0060. The final frame is optional and follows the same\none-form-only rule.\n\nSeedance 2.5 always derives an image-to-video result\u0027s aspect ratio\nfrom its first frame, so this endpoint takes no \u0060aspect_ratio\u0060.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Generate a video from a first-frame image and a text prompt with\nSeedance 2.5. Upload the first frame as \u0060image\u0060, and optionally a final\nframe as \u0060end_image\u0060, using \u0060multipart/form-data\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Generate a video from a first frame with Seedance 2.5, by asset id or by uploaded bytes\n# @name post_generate_video_seed_dance25_image_to_video\nPOST {{host}}/v2/video/generate/seedance-2-5-image-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image\u0022; filename=\u0022end_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./end_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nThe camera slowly pans right as the waves roll in.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n720p\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022generate_audio\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: The referenced first-frame asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Image to video with Seedance 2.5\n# @name post_generate_video_seed_dance25_image_to_video\nPOST {{host}}/v2/video/generate/seedance-2-5-image-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image\u0022; filename=\u0022end_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./end_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nThe camera slowly pans right as the waves roll in.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n720p\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022generate_audio\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: The first-frame image was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_video_seed_dance25_image_to_video", "Setup": null }, { - "Order": 177, - "Title": "Produce a video from reference images and videos with Seedance 2.5", + "Order": 179, + "Title": "Reference to video with Seedance 2.5", "Slug": "post-generate-video-seed-dance25-reference-to-video", - "Description": "Produce a video from a text prompt and reference media with\nSeedance 2.5.\n\nThe prompt addresses the references by position: the first reference\nimage is \u0060[Image1]\u0060, the second\n\u0060[Image2]\u0060, the first reference video is\n\u0060[Video1]\u0060, and so on. Supply reference images\neither as \u0060reference_image_asset_identifiers\u0060 (images already stored\nwith Ideogram) or as raw \u0060reference_images\u0060 bytes (multipart requests\nonly); supplying both is rejected, and uploaded bytes are used for this\nrequest only and are not stored as an asset. Supply reference videos as\n\u0060reference_video_asset_identifiers\u0060, which can reference uploaded or generated videos. At most 9 reference images and 10\nreference videos are accepted, and reference videos are capped again on\nclip length: each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds.\nSupply up to 10 MP3/WAV \u0060reference_audios\u0060 as multipart files, at most 15 MB each.\nEach audio clip must be 2\u201330 seconds, with at most 30 seconds total. Reference\nthem as \u0060[Audio1]\u0060, \u0060[Audio2]\u0060, and so on. Audio is used for this request only.\n\nAt least one reference image or video is required: the model\nconditions every generation on the media it is given, so a request\nwith no references is rejected.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Generate a video from a text prompt and reference media with\nSeedance 2.5. Upload at least one image in \u0060reference_images\u0060, plus optional\n\u0060reference_audios\u0060, using \u0060multipart/form-data\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Produce a video from reference images and videos with Seedance 2.5\n# @name post_generate_video_seed_dance25_reference_to_video\nPOST {{host}}/v2/video/generate/seedance-2-5-reference-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\n[Image1] walks through the snowy forest at dawn.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_images\u0022; filename=\u0022reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_video_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_audios\u0022; filename=\u0022reference_audios.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_audios.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n720p\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022generate_audio\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: A referenced asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Reference to video with Seedance 2.5\n# @name post_generate_video_seed_dance25_reference_to_video\nPOST {{host}}/v2/video/generate/seedance-2-5-reference-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\n[Image1] walks through the snowy forest at dawn.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_images\u0022; filename=\u0022reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_video_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_audios\u0022; filename=\u0022reference_audios.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_audios.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n720p\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022generate_audio\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: A reference was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_video_seed_dance25_reference_to_video", "Setup": null }, { - "Order": 178, - "Title": "Generate a video from a text prompt with Seedance 2.5", + "Order": 180, + "Title": "Text to video with Seedance 2.5", "Slug": "post-generate-video-seed-dance25-text-to-video", - "Description": "Generate a video from a text prompt with Seedance 2.5, which serves\nresolutions up to 1080p and durations up to 30 seconds.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Generate a video from a text prompt with Seedance 2.5, at up to 1080p and\n30 seconds. Returns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateVideoSeedDance25TextToVideoRequest\u003E(\n @\u0022{\n \u0022\u0022duration\u0022\u0022: 5,\n \u0022\u0022aspect_ratio\u0022\u0022: null,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022generate_audio\u0022\u0022: false,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022A red fox running through a snowy forest at dawn.\u0022\u0022,\n \u0022\u0022resolution\u0022\u0022: null\n}\u0022)!;\n\nvar response = await client.VideoGenerate.PostGenerateVideoSeedDance25TextToVideoAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022,\n// \u0022created\u0022: \u00222000-01-23T04:56:07\\u002B00:00\u0022\n// }", "Format": "sdk", @@ -1959,32 +1981,32 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 179, - "Title": "Generate a video from a first frame with Seedance 2.0, by asset id or by uploaded bytes", + "Order": 181, + "Title": "Image to video with Seedance 2.0", "Slug": "post-generate-video-seed-dance2-image-to-video", - "Description": "Generate one or more videos from a first-frame image and a text prompt\nwith Seedance 2.0. Supply the first frame either as an\n\u0060image_asset_identifier\u0060 reference (an image already stored with\nIdeogram) or as raw \u0060image\u0060 bytes (multipart requests only) \u2014 callers\nare never required to upload the asset first. Exactly one source is\nrequired; supplying neither or both is rejected. Only image assets are\naccepted as a first frame. Uploaded bytes are used for this request\nonly and are not stored as an asset.\n\nTo generate a transition between two stills, supply a final frame as\nwell, in either of the same two forms: \u0060end_image_asset_identifier\u0060 or\n\u0060end_image\u0060. The final frame is optional, follows the same one-form-only\nrule, and requires a first frame.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Generate one or more videos from a first-frame image and a text prompt\nwith Seedance 2.0. Upload the first frame as \u0060image\u0060, and optionally a final\nframe as \u0060end_image\u0060, using \u0060multipart/form-data\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Generate a video from a first frame with Seedance 2.0, by asset id or by uploaded bytes\n# @name post_generate_video_seed_dance2_image_to_video\nPOST {{host}}/v2/video/generate/seedance-2-image-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image\u0022; filename=\u0022end_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./end_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nThe camera slowly pans right as the waves roll in.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n720p\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022generate_audio\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: The referenced first-frame asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Image to video with Seedance 2.0\n# @name post_generate_video_seed_dance2_image_to_video\nPOST {{host}}/v2/video/generate/seedance-2-image-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022image\u0022; filename=\u0022image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image_asset_identifier\u0022\n\nstring\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022end_image\u0022; filename=\u0022end_image.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./end_image.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\nThe camera slowly pans right as the waves roll in.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n720p\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022generate_audio\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: The first-frame image was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_video_seed_dance2_image_to_video", "Setup": null }, { - "Order": 180, - "Title": "Produce a video from reference images and videos with Seedance 2.0", + "Order": 182, + "Title": "Reference to video with Seedance 2.0", "Slug": "post-generate-video-seed-dance2-reference-to-video", - "Description": "Produce a video from a text prompt and reference media with\nSeedance 2.0.\n\nThe prompt addresses the references by position: the first reference\nimage is \u0060@Image1\u0060, the second\n\u0060@Image2\u0060, the first reference video is\n\u0060@Video1\u0060, and so on. Supply reference images\neither as \u0060reference_image_asset_identifiers\u0060 (images already stored\nwith Ideogram) or as raw \u0060reference_images\u0060 bytes (multipart requests\nonly); supplying both is rejected, and uploaded bytes are used for this\nrequest only and are not stored as an asset. Supply reference videos as\n\u0060reference_video_asset_identifiers\u0060, which can reference uploaded or generated videos. At most 9 reference images and 3\nreference videos are accepted, and reference videos are capped again on\nclip length: each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds.\nSupply up to 3 MP3/WAV \u0060reference_audios\u0060 as multipart files, at most 15 MB each.\nEach audio clip must be 2\u201315 seconds, with at most 15 seconds total. Reference\nthem as \u0060@Audio1\u0060, \u0060@Audio2\u0060, and so on. Audio is used for this request only.\nImages, videos, and audio combined must not exceed 12 references.\n\nAt least one reference image or video is required: the model\nconditions every generation on the media it is given, so a request\nwith no references is rejected.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Generate a video from a text prompt and reference media with\nSeedance 2.0. Upload at least one image in \u0060reference_images\u0060, plus optional\n\u0060reference_audios\u0060, using \u0060multipart/form-data\u0060.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "http", - "Code": "### Produce a video from reference images and videos with Seedance 2.0\n# @name post_generate_video_seed_dance2_reference_to_video\nPOST {{host}}/v2/video/generate/seedance-2-reference-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\n@Image1 walks through the snowy forest at dawn.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_images\u0022; filename=\u0022reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_video_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_audios\u0022; filename=\u0022reference_audios.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_audios.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n720p\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022generate_audio\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v1/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: A referenced asset was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", + "Code": "### Reference to video with Seedance 2.0\n# @name post_generate_video_seed_dance2_reference_to_video\nPOST {{host}}/v2/video/generate/seedance-2-reference-to-video?dry_run=false\nAuthorization: Bearer {{token}}\nContent-Type: multipart/form-data; boundary=AutoSDKBoundary\nAccept: application/json\n\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022prompt\u0022\n\n@Image1 walks through the snowy forest at dawn.\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_image_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_images\u0022; filename=\u0022reference_images.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_images.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_video_asset_identifiers\u0022\n\n{\u0022asset_type\u0022:\u0022RESPONSE\u0022,\u0022asset_id\u0022:\u00227uS_VESkRI6O3-sVgHQp_A\u0022}\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022reference_audios\u0022; filename=\u0022reference_audios.bin\u0022\nContent-Type: application/octet-stream\n\n\u003C ./reference_audios.bin\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022aspect_ratio\u0022\n\nauto\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022resolution\u0022\n\n720p\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022duration\u0022\n\n5\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022generate_audio\u0022\n\nfalse\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022webhook_url\u0022\n\nhttps://api.example.com/webhooks/ideogram\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022private\u0022\n\ntrue\n--AutoSDKBoundary\nContent-Disposition: form-data; name=\u0022target_collection_id\u0022\n\nstring\n--AutoSDKBoundary--\n\n## Responses\n# 200\n# Description: An acknowledgement to poll with \u0060GET /v2/generations/{generation_id}\u0060.\n# Content-Type: application/json\n# 400\n# Description: Invalid input provided.\n# 401\n# Description: Unauthorized.\n# 402\n# Description: Insufficient credits or quota.\n# Content-Type: application/json\n# 403\n# Description: This account does not have access to this model.\n# 404\n# Description: A reference was not found.\n# 422\n# Description: The prompt did not pass safety checks.\n# 429\n# Description: Too many requests.\n# Content-Type: application/json\n# 500\n# Description: Internal server error.\n# 503\n# Description: The endpoint is temporarily unavailable.", "Format": "http", "OperationId": "post_generate_video_seed_dance2_reference_to_video", "Setup": null }, { - "Order": 181, - "Title": "Generate a video from a text prompt with Seedance 2.0", + "Order": 183, + "Title": "Text to video with Seedance 2.0", "Slug": "post-generate-video-seed-dance2-text-to-video", - "Description": "Generate one or more videos from a text prompt with Seedance 2.0.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a \u0060generation_id\u0060.\nPoll for completion and results with\n\u0060GET /v1/generations/{generation_id}\u0060 using that id, or supply a\n\u0060webhook_url\u0060 to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.", + "Description": "Generate one or more videos from a text prompt with Seedance 2.0.\nReturns a \u0060generation_id\u0060; poll \u0060GET /v2/generations/{generation_id}\u0060\nor supply a \u0060webhook_url\u0060.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.GenerateVideoSeedDance2TextToVideoRequest\u003E(\n @\u0022{\n \u0022\u0022duration\u0022\u0022: 5,\n \u0022\u0022aspect_ratio\u0022\u0022: null,\n \u0022\u0022private\u0022\u0022: true,\n \u0022\u0022webhook_url\u0022\u0022: \u0022\u0022https://api.example.com/webhooks/ideogram\u0022\u0022,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022generate_audio\u0022\u0022: false,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022A red fox running through a snowy forest at dawn.\u0022\u0022,\n \u0022\u0022resolution\u0022\u0022: null\n}\u0022)!;\n\nvar response = await client.VideoGenerate.PostGenerateVideoSeedDance2TextToVideoAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022,\n// \u0022created\u0022: \u00222000-01-23T04:56:07\\u002B00:00\u0022\n// }", "Format": "sdk", @@ -1992,10 +2014,21 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 182, - "Title": "Create a looping 360-degree product video", + "Order": 184, + "Title": "Turn a still image into a subtle looping video", + "Slug": "post-living-image", + "Description": "Animates one image into a short, loop-ready clip for use as a living background. The camera stays fixed and only the parts of the scene that would move in real life move: water, light, mist, particles, fabric, creatures. Ideogram inspects the image and writes the motion prompt, so the request needs only the image.\nVideo generation runs asynchronously. Poll \u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060 until the generation completes or fails.", + "Language": "csharp", + "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.LivingImageRequest\u003E(\n @\u0022{\n \u0022\u0022duration\u0022\u0022: 8,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022image_asset_identifier\u0022\u0022: {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n \u0022\u0022quality\u0022\u0022: null\n}\u0022)!;\n\nvar response = await client.VideoGenerate.PostLivingImageAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022,\n// \u0022created\u0022: \u00222000-01-23T04:56:07\\u002B00:00\u0022\n// }", + "Format": "sdk", + "OperationId": "post_living_image", + "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." + }, + { + "Order": 185, + "Title": "Product 360 Video", "Slug": "post-product360-video", - "Description": "Animates one product image through a complete turntable revolution and returns to the starting pose so the result loops cleanly.\nVideo generation runs asynchronously. Poll \u0060GET /v1/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060 until the generation completes or fails.", + "Description": "Animates one product image through a complete turntable revolution and returns to the starting pose so the result loops cleanly.\nVideo generation runs asynchronously. Poll \u0060GET /v2/generations/{generation_id}\u0060 with the returned \u0060generation_id\u0060 until the generation completes or fails.", "Language": "csharp", "Code": "using var client = new IdeogramClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Ideogram.Product360VideoRequest\u003E(\n @\u0022{\n \u0022\u0022duration\u0022\u0022: 5,\n \u0022\u0022target_collection_id\u0022\u0022: \u0022\u0022target_collection_id\u0022\u0022,\n \u0022\u0022image_asset_identifier\u0022\u0022: {\n \u0022\u0022asset_type\u0022\u0022: \u0022\u0022RESPONSE\u0022\u0022,\n \u0022\u0022asset_id\u0022\u0022: \u0022\u00227uS_VESkRI6O3-sVgHQp_A\u0022\u0022\n },\n \u0022\u0022product_description\u0022\u0022: \u0022\u0022product_description\u0022\u0022,\n \u0022\u0022resolution\u0022\u0022: null,\n \u0022\u0022direction\u0022\u0022: null\n}\u0022)!;\n\nvar response = await client.VideoGenerate.PostProduct360VideoAsync(\n request: request\n);\n\n// Example response:\n// {\n// \u0022generation_id\u0022: \u0022generation_id\u0022,\n// \u0022created\u0022: \u00222000-01-23T04:56:07\\u002B00:00\u0022\n// }", "Format": "sdk", @@ -2003,7 +2036,7 @@ "Setup": "This example assumes \u0060using Ideogram;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential." }, { - "Order": 183, + "Order": 186, "Title": "Describe", "Slug": "post-describe", "Description": "Describe an image.\n\nSupported image formats include JPEG, PNG, and WebP.", @@ -2014,7 +2047,7 @@ "Setup": null }, { - "Order": 184, + "Order": 187, "Title": "Describe with Ideogram 4.0", "Slug": "post-describe-v4", "Description": "Describe an image with Ideogram 4.0 and return a structured\n\u0060V4JsonPrompt\u0060. The returned \u0060json_prompt\u0060 is a working JSON prompt\nthat can be passed directly as \u0060json_prompt\u0060 to the\n\u0060/v1/ideogram-v4/generate\u0060 family of endpoints.\n\nSupported image formats include JPEG, PNG, and WebP.", @@ -2025,7 +2058,7 @@ "Setup": null }, { - "Order": 185, + "Order": 188, "Title": "Get the public keys used to verify webhook signatures", "Slug": "get-webhook-signing-jwks", "Description": "Returns the set of Ed25519 public keys Ideogram uses to sign outbound\nwebhook payloads. Customers verify incoming webhooks by recomputing the\ncanonical signed message (\u0060request_id\\nuser_id\\ntimestamp\\nsha256_hex(body)\u0060)\nand checking the \u0060X-Ideogram-Webhook-Signature\u0060 header against any key\nin this document.\n\nThe document includes the current signing key plus any keys recently\nrotated out, so signatures already in flight remain verifiable across\nrotations. Cache for up to 24 hours; refresh sooner if a signature\nfails to verify against the cached set.\n\nThis endpoint is public and unauthenticated \u2014 no API key is required.", diff --git a/src/libs/Ideogram/openapi.json b/src/libs/Ideogram/openapi.json index d7eee817..aa134b70 100644 --- a/src/libs/Ideogram/openapi.json +++ b/src/libs/Ideogram/openapi.json @@ -96,7 +96,7 @@ "name": "integrations" }, { - "description": "Remove unwanted objects from existing image assets. Requests use\n`AssetIdentifier` references and return a generation id that can be\npolled via `GET /v1/generations/{generation_id}`.\n", + "description": "Remove unwanted objects from an image. Requests return a generation id\nto poll with `GET /v2/generations/{generation_id}`.\n", "externalDocs": { "description": "Find out more", "url": "https://docs.ideogram.ai" @@ -104,7 +104,7 @@ "name": "object-removal" }, { - "description": "Edit existing images from a plain-language instruction. Requests supply\nsources by `AssetIdentifier` reference or as uploaded bytes and return a\ngeneration id that can be polled via `GET /v1/generations/{generation_id}`.\n", + "description": "Edit images from a plain-language instruction. Requests return a\ngeneration id to poll with `GET /v2/generations/{generation_id}`.\n", "externalDocs": { "description": "Find out more", "url": "https://docs.ideogram.ai" @@ -136,7 +136,7 @@ "name": "precise-masked-edit" }, { - "description": "Generate images with a specific model contract. Requests are JSON\n(Ideogram 3.0 also accepts multipart for style reference bytes) and\nreturn a generation id that can be polled via\n`GET /v1/generations/{generation_id}`.\n", + "description": "Generate images with a specific model contract. Requests are JSON\n(Ideogram 3.0 also accepts multipart for style reference bytes) and\nreturn a generation id that can be polled via\n`GET /v2/generations/{generation_id}`.\n", "externalDocs": { "description": "Find out more", "url": "https://docs.ideogram.ai" @@ -144,7 +144,7 @@ "name": "images-generate" }, { - "description": "Transform an existing image with a specific model contract, guided by\na prompt. Requests supply the source by `AssetIdentifier` reference or\nas uploaded bytes, and return a generation id that can be polled via\n`GET /v1/generations/{generation_id}`.\n", + "description": "Transform an image with a specific model, guided by a prompt.\n", "externalDocs": { "description": "Find out more", "url": "https://docs.ideogram.ai" @@ -156,7 +156,7 @@ "name": "images-precise-edit" }, { - "description": "Repaint a masked region of an image with a specific model contract.\nRequests supply the source image and mask by `AssetIdentifier`\nreference or as uploaded bytes and return a generation id that can be\npolled via `GET /v1/generations/{generation_id}`.\n", + "description": "Repaint a masked region of an image with a specific model.\n", "externalDocs": { "description": "Find out more", "url": "https://docs.ideogram.ai" @@ -172,7 +172,7 @@ "name": "tool" }, { - "description": "Model-agnostic endpoints where the server selects the model for each\nrequest. Requests are JSON and return a generation id that can be\npolled via `GET /v1/generations/{generation_id}`.\n", + "description": "Model-agnostic endpoints where the server selects the model for each\nrequest. Requests are JSON and return a generation id that can be\npolled via `GET /v2/generations/{generation_id}`.\n", "externalDocs": { "description": "Find out more", "url": "https://docs.ideogram.ai" @@ -5844,11 +5844,6 @@ "tags": [ "generate" ], - "x-playground-endpoint": { - "id": "generate-v4", - "label": "Generate", - "order": 1 - }, "x-openapi-router-controller": "external_api.generated.openapi.controllers.generate_controller" } }, @@ -6228,11 +6223,6 @@ "tags": [ "generate" ], - "x-playground-endpoint": { - "id": "remix-v4", - "label": "Remix", - "order": 2 - }, "x-openapi-router-controller": "external_api.generated.openapi.controllers.generate_controller" } }, @@ -6463,12 +6453,6 @@ "tags": [ "generate" ], - "x-playground-endpoint": { - "id": "generate-v45", - "label": "Generate", - "order": 1, - "feature_flag": "access_to_v45" - }, "x-openapi-router-controller": "external_api.generated.openapi.controllers.generate_controller" } }, @@ -6877,11 +6861,6 @@ "tags": [ "generate" ], - "x-playground-endpoint": { - "id": "remove-background", - "label": "Remove background", - "order": 3 - }, "x-openapi-router-controller": "external_api.generated.openapi.controllers.generate_controller" } }, @@ -7195,7 +7174,7 @@ "description": "No organization with billing access was found for this credential." } }, - "summary": "List your organization's API keys", + "summary": "List API keys", "tags": [ "account" ], @@ -7224,7 +7203,7 @@ "description": "No organization with billing access was found for this credential." } }, - "summary": "List your organization's invoices", + "summary": "List invoices", "tags": [ "account" ], @@ -7359,16 +7338,80 @@ "description": "Too many requests." } }, - "summary": "Retrieve your organization's API usage and spend over time", + "summary": "Get usage and spend", "tags": [ "account" ], "x-openapi-router-controller": "external_api.generated.openapi.controllers.account_controller" } }, + "/v2/assets/reference-usage": { + "get": { + "description": "Counts completed requests made by the authenticated organization that used each existing asset as an edit input during the UTC date range. Direct file uploads without saved asset identifiers are excluded. Results are independent of current asset ownership, collection membership, and sharing. Returning an identifier does not grant access to its image. Tracking begins when enabled; earlier history is not included. Returns 50 assets per page. Rankings may change between pages when daily counts are updated; cursors do not pin a historical snapshot.", + "operationId": "get_asset_reference_usage", + "parameters": [ + { + "description": "Inclusive UTC usage date.", + "in": "query", + "name": "start_date", + "required": true, + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "Exclusive UTC usage date, later than start_date.", + "in": "query", + "name": "end_date", + "required": true, + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "Opaque next-page cursor. Keep the same date range on every page.", + "in": "query", + "name": "cursor", + "required": false, + "schema": { + "maxLength": 2048, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AssetReferenceUsageResponse" + } + } + }, + "description": "Ranked edit reference assets" + }, + "400": { + "description": "Invalid date range or cursor, or missing organization context" + }, + "401": { + "description": "Unauthorized" + }, + "503": { + "description": "Usage data temporarily unavailable" + } + }, + "summary": "Rank edit reference assets used by organization requests", + "tags": [ + "asset-reference-usage" + ], + "x-openapi-router-controller": "external_api.generated.openapi.controllers.asset_reference_usage_controller" + } + }, "/v2/design/layerize/ideogram-3": { "post": { - "description": "Decompose a flat image into an editable design: the text in the image\nis detected, erased from the image, and returned as positioned text\nblocks with matched fonts, sizes, and colors, alongside a text-free\nbase image.\n\nSupply the source either as an `image_asset_identifier` reference (an\nimage already stored with Ideogram) or as raw `image` bytes (multipart\nrequests only). Provide exactly one of the two forms; supplying both,\nor neither, is rejected with a 400.\n\nA `prompt` describing the image can guide text detection; when\nomitted, detection runs on the image alone.\n\nBy default the request blocks until layerization is complete and\nreturns the result in `data`. Set `async` to true to return\nimmediately after the request is accepted, then poll for completion\nand results with `GET /v1/generations/{generation_id}` using the\nreturned `generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Turn a flat image into an editable design: detected text is returned as\npositioned text blocks with matched fonts, sizes, and colors, alongside\na text-free base image. Upload the image as `image` using\n`multipart/form-data`. Returns results directly by default; set `async`\nor supply a `webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_layerize_design_ideogram_v3", "parameters": [ { @@ -7400,7 +7443,7 @@ } } }, - "description": "A request to layerize the text in one image. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to layerize the text in one image. Send it as `multipart/form-data` with the source `image`.", "required": true, "x-body-name": "body" }, @@ -7413,7 +7456,7 @@ } } }, - "description": "The layerized design (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The layerized design (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -7422,15 +7465,29 @@ "description": "Unauthorized." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "403": { "description": "Not authorized to layerize images." }, "404": { - "description": "The referenced source asset was not found." + "description": "The source image was not found." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." }, "500": { @@ -7440,16 +7497,64 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Layerize the text in an image", + "summary": "Layerize text with Ideogram 3.0", "tags": [ "design" ], "x-openapi-router-controller": "external_api.generated.openapi.controllers.design_controller" } }, + "/v2/generations/{generation_id}": { + "get": { + "description": "Retrieves the current status of an asynchronous generation, and its\nresults once complete. Use the `generation_id` returned by any `/v2`\nendpoint that runs asynchronously: every video and tool endpoint, and\nany image endpoint called with `async` or a `webhook_url`.\n\nWhile the generation is `pending` or has `failed`, the response\ncontains only `generation_id`, `status`, and `created` (plus\n`failure_reason` once failed). Once `status` is `completed`, the\nresponse includes `response_type` and `data`. Each `data` item carries\nan `object_type` that identifies its shape, so image and video results\ncan be told apart. `usage_cost_usd_micros` reports the amount billed\nwhen the request uses variable usage-based pricing.\n\nPolling is rate limited per organization; a 429 response carries a\n`Retry-After` header with the number of seconds to wait.", + "operationId": "get_generation_v2", + "parameters": [ + { + "description": "URL-safe base64 ID of the generation, as returned when the request was accepted.", + "explode": false, + "in": "path", + "name": "generation_id", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationResponse" + } + } + }, + "description": "Generation status retrieved successfully." + }, + "400": { + "description": "The generation ID is not a valid URL-safe base64 ID." + }, + "401": { + "description": "Not authorized." + }, + "404": { + "description": "Generation not found." + }, + "429": { + "description": "Too many requests." + } + }, + "summary": "Poll a generation", + "tags": [ + "generations" + ], + "x-openapi-router-controller": "external_api.generated.openapi.controllers.generations_controller" + } + }, "/v2/image/describe/ideogram-3": { "post": { - "description": "Generate a natural-language description of an image using Ideogram's\n3.0-generation image captioner (a fine-tune of the Qwen2-VL\nvision-language model).\n\nSupply the source either as an `image_asset_identifier` reference (an\nimage already stored with Ideogram) or as raw `image` bytes (multipart\nrequests only). Provide exactly one of the two forms; supplying both,\nor neither, is rejected with a 400.\n\nSupported image formats include JPEG, PNG, and WebP.\n", + "description": "Generate a natural-language description of an image with Ideogram's 3.0\nimage captioner (a fine-tune of the Qwen2-VL vision-language model).\nUpload the image as `image` using `multipart/form-data`; the description\nis returned directly.\n", "operationId": "post_describe_image_ideogram_v3", "requestBody": { "content": { @@ -7469,7 +7574,7 @@ } } }, - "description": "A request to describe one image. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to describe one image. Send it as `multipart/form-data` with the `image` to describe.", "required": true, "x-body-name": "body" }, @@ -7501,7 +7606,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source asset was not found." + "description": "The source image was not found." }, "422": { "content": { @@ -7539,7 +7644,7 @@ }, "/v2/image/describe/ideogram-4": { "post": { - "description": "Describe an image using Ideogram's 4.0-generation image captioner (a\nfine-tune of the Qwen3-VL vision-language model) and return a\nstructured `V4JsonPrompt`. The\nreturned `json_prompt` is a working JSON prompt that can be passed\ndirectly as `json_prompt` to the `/v1/ideogram-v4/generate` family of\nendpoints.\n\nSupply the source either as an `image_asset_identifier` reference (an\nimage already stored with Ideogram) or as raw `image` bytes (multipart\nrequests only). Provide exactly one of the two forms; supplying both,\nor neither, is rejected with a 400.\n\nSupported image formats include JPEG, PNG, and WebP.\n", + "description": "Describe an image as a structured `V4JsonPrompt` with Ideogram's 4.0\nimage captioner (a fine-tune of the Qwen3-VL vision-language model).\nUpload the image as `image` using `multipart/form-data`; the\n`json_prompt` is returned directly and can be passed to the\n`/v1/ideogram-v4/generate` endpoints.\n", "operationId": "post_describe_image_ideogram_v4", "requestBody": { "content": { @@ -7559,7 +7664,7 @@ } } }, - "description": "A request to describe one image. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to describe one image. Send it as `multipart/form-data` with the `image` to describe.", "required": true, "x-body-name": "body" }, @@ -7591,7 +7696,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source asset was not found." + "description": "The source image was not found." }, "422": { "content": { @@ -7629,7 +7734,7 @@ }, "/v2/image/generate/auto": { "post": { - "description": "Generate one or more images without choosing a model. The server\nselects the model best suited to the request and may route different\nrequests to different models.\n\nSupplying source images turns the request into a transform: the server\npicks a model that can edit, and the prompt describes the change to\napply. Provide the sources either as `image_asset_identifiers`\nreferences (images already stored with Ideogram) or as raw `images`\nbytes (multipart requests only) — if both are supplied, the references\nwin and the bytes are ignored. `negative_prompt` and\n`style_reference_asset_identifiers` only apply without source images;\ncombining them with sources is rejected with a 422 rather than\nsilently ignored.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n", + "description": "Generate images with the model Ideogram picks as best suited to each\nrequest. Optionally upload source images as `images` using\n`multipart/form-data` to edit them with the prompt. Returns results\ndirectly by default; set `async` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_auto", "parameters": [ { @@ -7664,7 +7769,7 @@ } } }, - "description": "A request to generate images with a server-selected model, optionally conditioned on source images. Use `multipart/form-data` to upload `images` bytes directly, or `application/json` (or multipart with `image_asset_identifiers`) to reference existing assets instead.", + "description": "A request to generate images with an automatically selected model. Send it as `application/json`, or as `multipart/form-data` to include source `images`.", "required": true, "x-body-name": "body" }, @@ -7677,7 +7782,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -7696,7 +7801,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "A referenced source asset was not found." + "description": "A source image was not found." }, "422": { "description": "The prompt did not pass safety checks, or the request combined source images with text-to-image-only fields." @@ -7718,7 +7823,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate or transform images, letting the server pick the best model", + "summary": "Generate with automatic model selection", "tags": [ "auto-model" ], @@ -7727,7 +7832,7 @@ }, "/v2/image/generate/gpt-image-2": { "post": { - "description": "Generate one or more images with GPT Image 2. The prompt is consumed\nby the model directly, without rewriting.\n\nSupplying source images turns the request into an edit: the model\napplies the prompt to the sources. Provide them either as\n`image_asset_identifiers` references (images already stored with\nIdeogram) or as raw `images` bytes (multipart requests only) — if both\nare supplied, the references win and the bytes are ignored. Without\nsource images the prompt alone drives the generation.\n\nThe output size follows `resolution` when provided, otherwise the\nclosest size the model supports for `aspect_ratio`.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images with GPT Image 2. Optionally upload source images as\n`images` using `multipart/form-data` to edit them with the prompt.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_gpt_image2", "parameters": [ { @@ -7759,7 +7864,7 @@ } } }, - "description": "A request to generate images with GPT Image 2, optionally conditioned on source images. Use `multipart/form-data` to upload `images` bytes directly, or `application/json` (or multipart with `image_asset_identifiers`) to reference existing assets instead.", + "description": "A request to generate images with GPT Image 2. Send it as `application/json`, or as `multipart/form-data` to include source `images`.", "required": true, "x-body-name": "body" }, @@ -7772,7 +7877,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -7810,7 +7915,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with GPT Image 2, from a text prompt or by editing source images", + "summary": "Generate with GPT Image 2", "tags": [ "images-generate" ], @@ -7819,7 +7924,7 @@ }, "/v2/image/generate/gpt-image-2-5-flare": { "post": { - "description": "Generate one or more images with GPT Image 2.5 Flare — the fast\nvariant of GPT Image 2.5, optimized for speed at quality comparable\nto GPT Image 2. The prompt is consumed by the model directly, without\nrewriting.\n\nSupplying source images turns the request into an edit: the model\napplies the prompt to the sources. Provide them either as\n`image_asset_identifiers` references (images already stored with\nIdeogram) or as raw `images` bytes (multipart requests only) — if both\nare supplied, the references win and the bytes are ignored. Without\nsource images the prompt alone drives the generation.\n\nThe output size follows `resolution` when provided, otherwise the\nclosest size the model supports for `aspect_ratio`.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images with GPT Image 2.5 Flare, the fast variant of GPT Image\n2.5. Optionally upload source images as `images` using\n`multipart/form-data` to edit them with the prompt. Returns results\ndirectly by default; set `async` or supply a `webhook_url` to get a\n`generation_id` and poll `GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_gpt_image25_flare", "parameters": [ { @@ -7851,7 +7956,7 @@ } } }, - "description": "A request to generate images with GPT Image 2.5 Flare, optionally conditioned on source images. Use `multipart/form-data` to upload `images` bytes directly, or `application/json` (or multipart with `image_asset_identifiers`) to reference existing assets instead.", + "description": "A request to generate images with GPT Image 2.5 Flare. Send it as `application/json`, or as `multipart/form-data` to include source `images`.", "required": true, "x-body-name": "body" }, @@ -7864,7 +7969,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -7902,7 +8007,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with GPT Image 2.5 Flare, from a text prompt or by editing source images", + "summary": "Generate with GPT Image 2.5 Flare", "tags": [ "images-generate" ], @@ -7911,7 +8016,7 @@ }, "/v2/image/generate/gpt-image-2-5-sunburst": { "post": { - "description": "Generate one or more images with GPT Image 2.5 Sunburst — the quality\nvariant of GPT Image 2.5, optimized for fine detail at higher\nlatency than Flare. The prompt is consumed by the model directly, without\nrewriting.\n\nSupplying source images turns the request into an edit: the model\napplies the prompt to the sources. Provide them either as\n`image_asset_identifiers` references (images already stored with\nIdeogram) or as raw `images` bytes (multipart requests only) — if both\nare supplied, the references win and the bytes are ignored. Without\nsource images the prompt alone drives the generation.\n\nThe output size follows `resolution` when provided, otherwise the\nclosest size the model supports for `aspect_ratio`.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images with GPT Image 2.5 Sunburst, the quality variant of GPT\nImage 2.5, with finer detail at higher latency than Flare. Optionally\nupload source images as `images` using `multipart/form-data` to edit\nthem with the prompt. Returns results directly by default; set `async`\nor supply a `webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_gpt_image25_sunburst", "parameters": [ { @@ -7943,7 +8048,7 @@ } } }, - "description": "A request to generate images with GPT Image 2.5 Sunburst, optionally conditioned on source images. Use `multipart/form-data` to upload `images` bytes directly, or `application/json` (or multipart with `image_asset_identifiers`) to reference existing assets instead.", + "description": "A request to generate images with GPT Image 2.5 Sunburst. Send it as `application/json`, or as `multipart/form-data` to include source `images`.", "required": true, "x-body-name": "body" }, @@ -7956,7 +8061,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -7994,7 +8099,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with GPT Image 2.5 Sunburst, from a text prompt or by editing source images", + "summary": "Generate with GPT Image 2.5 Sunburst", "tags": [ "images-generate" ], @@ -8003,7 +8108,7 @@ }, "/v2/image/generate/ideogram-2": { "post": { - "description": "Generate one or more images from a text prompt with Ideogram 2.0,\nwith an optional style type and negative prompt. Set\n`rendering_speed` to `turbo` for faster, lower-cost generation.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images from a text prompt with Ideogram 2.0. Returns results\ndirectly by default; set `async` or supply a `webhook_url` to get a\n`generation_id` and poll `GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_ideogram_v2", "parameters": [ { @@ -8038,7 +8143,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -8076,7 +8181,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with Ideogram 2.0 from a text prompt", + "summary": "Generate with Ideogram 2.0", "tags": [ "images-generate" ], @@ -8085,7 +8190,7 @@ }, "/v2/image/generate/ideogram-2a": { "post": { - "description": "Generate one or more images from a text prompt with Ideogram 2a, a\nfast, lower-cost model, with an optional style type. Set\n`rendering_speed` to `turbo` for even faster generation.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images from a text prompt with Ideogram 2a, a fast, lower-cost\nmodel. Returns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_ideogram_v2_a", "parameters": [ { @@ -8120,7 +8225,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -8158,7 +8263,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with Ideogram 2a from a text prompt", + "summary": "Generate with Ideogram 2a", "tags": [ "images-generate" ], @@ -8167,7 +8272,7 @@ }, "/v2/image/generate/ideogram-3": { "post": { - "description": "Generate one or more images from a text prompt with Ideogram 3.0,\nwith optional style controls: style codes, a style preset, a color\npalette, or style references. Supply style references as a saved style\n(`style_reference_collection_id`), as\n`style_reference_asset_identifiers` references (images already stored\nwith Ideogram), or as raw `style_reference_images` bytes (multipart\nrequests only). These three style reference forms cannot be combined.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "description": "Generate images from a text prompt with Ideogram 3.0. Optional style\ncontrols include style codes, a style preset, a color palette, and style\nreferences (uploaded `style_reference_images`). Returns\nresults directly by default; set `async` or supply a `webhook_url` to\nget a `generation_id` and poll `GET /v2/generations/{generation_id}`.", "operationId": "post_generate_image_v2_ideogram_v3", "parameters": [ { @@ -8202,7 +8307,7 @@ } } }, - "description": "A request to generate images with Ideogram 3.0. Use `multipart/form-data` to upload `style_reference_images` bytes directly, or `application/json` (or multipart with the collection id or asset identifier forms) to reference a saved style or existing assets instead.", + "description": "A request to generate images with Ideogram 3.0. Send it as `application/json`, or as `multipart/form-data` to include `style_reference_images`.", "required": true, "x-body-name": "body" }, @@ -8215,7 +8320,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -8234,7 +8339,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "A referenced style collection or asset was not found." + "description": "A referenced resource was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -8256,7 +8361,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with Ideogram 3.0 from a text prompt", + "summary": "Generate with Ideogram 3.0", "tags": [ "images-generate" ], @@ -8265,7 +8370,7 @@ }, "/v2/image/generate/ideogram-3-character": { "post": { - "description": "Generate one or more images featuring a consistent character with\nIdeogram 3.0. Supply the character as a saved character\n(`character_reference_collection_id`), as\n`character_reference_asset_identifiers` references (an image already\nstored with Ideogram), or as raw `character_reference_images` bytes\n(multipart requests only, with an optional\n`character_reference_mask` marking where the character is in the\nreference). If more than one form is supplied, the collection wins\nover the identifiers, and the identifiers win over the bytes.\n\nStyle references may be combined with the character on accounts with\naccess; otherwise the combination returns a 400. Supply them as a\nsaved style (`style_reference_collection_id`), as\n`style_reference_asset_identifiers` references, or as raw\n`style_reference_images` bytes, with the same precedence as the\ncharacter forms.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images featuring a consistent character with Ideogram 3.0.\nUpload the character as `character_reference_images` using\n`multipart/form-data`. Returns\nresults directly by default; set `async` or supply a `webhook_url` to\nget a `generation_id` and poll `GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_ideogram_v3_character", "parameters": [ { @@ -8300,7 +8405,7 @@ } } }, - "description": "A request to generate images of a consistent character with Ideogram 3.0. Use `multipart/form-data` to upload `character_reference_images` or `style_reference_images` bytes directly, or `application/json` (or multipart with the collection id or asset identifier forms) to reference saved characters, styles, or existing assets instead.", + "description": "A request to generate images of a consistent character with Ideogram 3.0. Send it as `multipart/form-data` to upload `character_reference_images` and any `style_reference_images`.", "required": true, "x-body-name": "body" }, @@ -8313,7 +8418,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -8332,7 +8437,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "A referenced asset or collection was not found." + "description": "A referenced resource was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -8354,7 +8459,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images of a consistent character with Ideogram 3.0", + "summary": "Generate a consistent character with Ideogram 3.0", "tags": [ "images-generate" ], @@ -8363,7 +8468,7 @@ }, "/v2/image/generate/ideogram-3-custom-model": { "post": { - "description": "Generate one or more images with a custom Ideogram 3.0 model that the\nauthenticated user or organization can access. The model registry\ncontrols the model's supported rendering speeds and whether it removes\nbackgrounds automatically.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images with a custom Ideogram 3.0 model that you or your\norganization can access, selected by `custom_model_uri`. Returns results\ndirectly by default; set `async` or supply a `webhook_url` to get a\n`generation_id` and poll `GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_ideogram_v3_custom_model", "parameters": [ { @@ -8398,7 +8503,7 @@ } } }, - "description": "A request to generate images with an accessible custom Ideogram 3.0 model. Use `multipart/form-data` to upload `style_reference_images` bytes directly, or `application/json` (or multipart with `style_reference_asset_identifiers`) to reference existing assets instead.", + "description": "A request to generate images with an accessible custom Ideogram 3.0 model. Send it as `application/json`, or as `multipart/form-data` to include `style_reference_images`.", "required": true, "x-body-name": "body" }, @@ -8411,7 +8516,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input or an unsupported model option." @@ -8433,7 +8538,7 @@ "description": "The custom model does not exist or is not accessible to this user or organization." }, "404": { - "description": "A referenced style asset was not found." + "description": "A requested resource was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -8455,7 +8560,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with a custom Ideogram 3.0 model", + "summary": "Generate with a custom Ideogram 3.0 model", "tags": [ "images-generate" ], @@ -8464,7 +8569,7 @@ }, "/v2/image/generate/ideogram-3-transparent": { "post": { - "description": "Generate one or more images on a transparent background with\nIdeogram 3.0, delivered as PNGs with alpha. An optional\n`upscale_factor` increases the output size after generation.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images on a transparent background with Ideogram 3.0, delivered\nas PNGs with alpha. Returns results directly by default; set `async` or\nsupply a `webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_ideogram_v3_transparent", "parameters": [ { @@ -8499,7 +8604,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -8537,7 +8642,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate transparent-background images with Ideogram 3.0", + "summary": "Generate transparent images with Ideogram 3.0", "tags": [ "images-generate" ], @@ -8546,7 +8651,7 @@ }, "/v2/image/generate/ideogram-4": { "post": { - "description": "Generate one or more images from a prompt with Ideogram 4.0. The\n`prompt` accepts either natural language or a structured Ideogram 4.0\nJSON prompt; the server detects which was supplied. A structured JSON\nprompt is consumed by the model directly and skips magic prompt.\n\n`magic_prompt` controls how a natural-language prompt is prepared:\n`auto`/`on` rewrite and expand the prompt before generation, while\n`off` keeps your wording and only converts the prompt into the\nstructured format the model consumes.\n\nWhen `resolution` is omitted, the server picks an aspect ratio\nautomatically based on the prompt.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images with Ideogram 4.0 from a natural-language or structured\nJSON prompt. Returns results directly by default; set `async` or supply\na `webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_ideogram_v4", "parameters": [ { @@ -8581,7 +8686,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -8619,16 +8724,21 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with Ideogram 4.0 from a text or structured prompt", + "summary": "Generate with Ideogram 4.0", "tags": [ "images-generate" ], + "x-playground-endpoint": { + "id": "generate-v4", + "label": "Generate 4.0", + "order": 1 + }, "x-openapi-router-controller": "external_api.generated.openapi.controllers.images_generate_controller" } }, "/v2/image/generate/ideogram-4-5": { "post": { - "description": "Generate one or more images with Ideogram 4.5. Supplying source\nimages turns the request into an image-to-image transform: the model\nconditions on the sources, the prompt becomes optional guidance, and\n`size` may be \"source\" to keep the first source's own size or \"auto\"\nto let the server pick the canvas from the sources and the prompt.\nProvide sources either as `image_asset_identifiers` references or as\nraw `images` bytes (multipart requests only); if both are supplied,\nthe references win and the bytes are ignored. The `prompt` accepts\neither natural language or a structured Ideogram 4.0 JSON prompt; the\nserver detects which was supplied.\n\n`magic_prompt` controls automatic prompt rewriting: `auto` (the\ndefault) and `on` rewrite a natural-language prompt, a prompt that is\nalready a valid structured JSON prompt is always consumed directly,\nand `off` disables rewriting entirely so the model receives your\nprompt verbatim.\n\nIdeogram 4.5 renders a fixed set of output sizes. When `size`\nis omitted, the server picks a supported size automatically based on\nthe prompt, and on the source images when there are any.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images with Ideogram 4.5 from a natural-language or structured\nJSON prompt. Optionally upload source images as `images` using\n`multipart/form-data` to edit them with the prompt. Returns results\ndirectly by default; set `async` or supply a `webhook_url` to get a\n`generation_id` and poll `GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_ideogram45", "parameters": [ { @@ -8660,7 +8770,7 @@ } } }, - "description": "A request to generate images with Ideogram 4.5, optionally conditioned on source images. Use `multipart/form-data` to upload `images` bytes directly, or `application/json` (or multipart with `image_asset_identifiers`) to reference existing assets instead.", + "description": "A request to generate images with Ideogram 4.5. Send it as `application/json`, or as `multipart/form-data` to include source `images`.", "required": true, "x-body-name": "body" }, @@ -8673,7 +8783,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -8711,16 +8821,22 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with Ideogram 4.5, from a prompt or by transforming source images", + "summary": "Generate with Ideogram 4.5", "tags": [ "images-generate" ], + "x-playground-endpoint": { + "id": "generate-v45", + "label": "Generate 4.5", + "order": 1, + "feature_flag": "access_to_v45" + }, "x-openapi-router-controller": "external_api.generated.openapi.controllers.images_generate_controller" } }, "/v2/image/generate/ideogram-4-custom-model": { "post": { - "description": "Generate one or more images with a custom Ideogram 4.0 model that the\nauthenticated user or organization can access. The model registry\ncontrols the model's supported rendering speeds.\n\nThe `prompt` accepts either natural language or a structured Ideogram\n4.0 JSON prompt; the server detects which was supplied. A structured\nJSON prompt is consumed by the model directly and skips magic prompt.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images with a custom Ideogram 4.0 model that you or your\norganization can access, selected by `custom_model_uri`. Returns results\ndirectly by default; set `async` or supply a `webhook_url` to get a\n`generation_id` and poll `GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_ideogram_v4_custom_model", "parameters": [ { @@ -8755,7 +8871,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input or an unsupported model option." @@ -8796,7 +8912,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with a custom Ideogram 4.0 model", + "summary": "Generate with a custom Ideogram 4.0 model", "tags": [ "images-generate" ], @@ -8805,7 +8921,7 @@ }, "/v2/image/generate/ideogram-4-transparent": { "post": { - "description": "Generate one or more images on a transparent background with\nIdeogram 4.0, delivered as PNGs with alpha. The `prompt` accepts\neither natural language or a structured Ideogram 4.0 JSON prompt; a\nstructured prompt is consumed directly and skips magic prompt, except\nthat its background description is replaced with a\ntransparent-background directive.\n\n`magic_prompt` controls how a natural-language prompt is prepared:\n`auto`/`on` rewrite and expand the prompt before generation, while\n`off` keeps your wording and only converts the prompt into the\nstructured format the model consumes.\n\n`output_resolution` selects the output tier (1k to 8k); tiers above\n2K are produced by upscaling after generation.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images on a transparent background with Ideogram 4.0, delivered\nas PNGs with alpha. Returns results directly by default; set `async` or\nsupply a `webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_ideogram_v4_transparent", "parameters": [ { @@ -8840,7 +8956,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -8878,7 +8994,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate transparent-background images with Ideogram 4.0", + "summary": "Generate transparent images with Ideogram 4.0", "tags": [ "images-generate" ], @@ -8887,7 +9003,7 @@ }, "/v2/image/generate/nano-banana-2": { "post": { - "description": "Generate one or more images with Nano Banana 2. The prompt is\nconsumed by the model directly, without rewriting.\n\nSupplying source images turns the request into an edit: the model\napplies the prompt to the sources. Provide them either as\n`image_asset_identifiers` references (images already stored with\nIdeogram) or as raw `images` bytes (multipart requests only) — if both\nare supplied, the references win and the bytes are ignored. Without\nsource images the prompt alone drives the generation.\n\nThe output is served at the closest aspect ratio the model supports,\nat the requested `resolution_tier` (1K by default).\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images with Nano Banana 2. Optionally upload source images as\n`images` using `multipart/form-data` to edit them with the prompt.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_nano_banana2", "parameters": [ { @@ -8919,7 +9035,7 @@ } } }, - "description": "A request to generate images with Nano Banana 2, optionally conditioned on source images. Use `multipart/form-data` to upload `images` bytes directly, or `application/json` (or multipart with `image_asset_identifiers`) to reference existing assets instead.", + "description": "A request to generate images with Nano Banana 2. Send it as `application/json`, or as `multipart/form-data` to include source `images`.", "required": true, "x-body-name": "body" }, @@ -8932,7 +9048,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -8970,7 +9086,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with Nano Banana 2, from a text prompt or by editing source images", + "summary": "Generate with Nano Banana 2", "tags": [ "images-generate" ], @@ -8979,7 +9095,7 @@ }, "/v2/image/generate/nano-banana-pro": { "post": { - "description": "Generate one or more images with Nano Banana Pro. The prompt is\nconsumed by the model directly, without rewriting.\n\nSupplying source images turns the request into an edit: the model\napplies the prompt to the sources. Provide them either as\n`image_asset_identifiers` references (images already stored with\nIdeogram) or as raw `images` bytes (multipart requests only) — if both\nare supplied, the references win and the bytes are ignored. Without\nsource images the prompt alone drives the generation.\n\nThe output is served at the closest aspect ratio the model supports,\nat the requested `resolution_tier` (1K by default).\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images with Nano Banana Pro. Optionally upload source images as\n`images` using `multipart/form-data` to edit them with the prompt.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_nano_banana_pro", "parameters": [ { @@ -9011,7 +9127,7 @@ } } }, - "description": "A request to generate images with Nano Banana Pro, optionally conditioned on source images. Use `multipart/form-data` to upload `images` bytes directly, or `application/json` (or multipart with `image_asset_identifiers`) to reference existing assets instead.", + "description": "A request to generate images with Nano Banana Pro. Send it as `application/json`, or as `multipart/form-data` to include source `images`.", "required": true, "x-body-name": "body" }, @@ -9024,7 +9140,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -9062,7 +9178,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with Nano Banana Pro, from a text prompt or by editing source images", + "summary": "Generate with Nano Banana Pro", "tags": [ "images-generate" ], @@ -9071,7 +9187,7 @@ }, "/v2/image/generate/p-image-ideogram": { "post": { - "description": "Generate one or more images with P-Image Ideogram, a fast model with\nselectable quality and resolution tiers. The `prompt` accepts either\nnatural language or a structured Ideogram 4.0 JSON prompt; the server\ndetects which was supplied.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images with P-Image Ideogram, a fast model with selectable\nquality and resolution tiers. Returns results directly by default; set\n`async` or supply a `webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_p_image_ideogram", "parameters": [ { @@ -9106,7 +9222,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -9144,7 +9260,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with P-Image Ideogram from a text or structured prompt", + "summary": "Generate with P-Image Ideogram", "tags": [ "images-generate" ], @@ -9153,7 +9269,7 @@ }, "/v2/image/generate/z-image": { "post": { - "description": "Generate one or more images from a text prompt with Z-Image. The base\nmodel is pinned server-side.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Generate images from a text prompt with Z-Image. Returns results\ndirectly by default; set `async` or supply a `webhook_url` to get a\n`generation_id` and poll `GET /v2/generations/{generation_id}`.\n", "operationId": "post_generate_image_v2_z_image", "parameters": [ { @@ -9188,7 +9304,7 @@ } } }, - "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -9226,7 +9342,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate images with Z-Image from a text prompt", + "summary": "Generate with Z-Image", "tags": [ "images-generate" ], @@ -9235,7 +9351,7 @@ }, "/v2/image/inpaint/ideogram-3": { "post": { - "description": "Repaint the masked region of a source image from a text prompt with\nIdeogram 3.0. For each of the source image and the mask, supply either\nan `AssetIdentifier` reference (`image_asset_identifier` /\n`mask_asset_identifier`) or the raw image bytes directly (`image` /\n`mask`, multipart requests only). If both a reference and bytes are\nsupplied for the same input, the reference wins and the bytes are\nignored.\n\nOptional style controls: style codes, a style preset, or style\nreference images.\nSupply style references as a saved style\n(`style_reference_collection_id`), as\n`style_reference_asset_identifiers` references (images already stored\nwith Ideogram), or as raw `style_reference_images` bytes (multipart\nrequests only). If more than one form is supplied, the collection wins\nover the identifiers, and the identifiers win over the bytes.\n\nThe output matches the size of the source image (snapped to the\nnearest resolution the model renders). By default the request blocks\nuntil the images are ready and returns them in `data`. Set `async` to\ntrue to return immediately after the request is accepted, then poll\nfor completion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "description": "Repaint the masked region of a source image with Ideogram 3.0, guided\nby a text prompt. Upload the source `image` and its `mask` using\n`multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.", "operationId": "post_inpaint_image_v2_ideogram_v3", "parameters": [ { @@ -9273,7 +9389,7 @@ } } }, - "description": "A request to repaint the masked region of a source image with Ideogram 3.0. Use `multipart/form-data` to upload `image` / `mask` bytes directly, or `application/json` (or multipart with `image_asset_identifier` / `mask_asset_identifier`) to reference existing assets instead.", + "description": "Use `multipart/form-data` to upload the source `image`, its `mask`, and any `style_reference_images`.", "required": true, "x-body-name": "body" }, @@ -9286,7 +9402,7 @@ } } }, - "description": "The repainted images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The repainted images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -9305,7 +9421,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "A referenced asset or style collection was not found." + "description": "A referenced resource was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -9327,7 +9443,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Repaint a masked region with Ideogram 3.0, by asset id or by uploaded bytes", + "summary": "Inpaint with Ideogram 3.0", "tags": [ "images-inpaint" ], @@ -9336,7 +9452,7 @@ }, "/v2/image/inpaint/ideogram-3-character": { "post": { - "description": "Repaint the masked region of a source image so it features a\nconsistent character, with Ideogram 3.0. For each of the source image\nand the mask, supply either an `AssetIdentifier` reference\n(`image_asset_identifier` / `mask_asset_identifier`) or the raw image\nbytes directly (`image` / `mask`, multipart requests only). If both a\nreference and bytes are supplied for the same input, the reference\nwins and the bytes are ignored.\n\nSupply the character as a saved character\n(`character_reference_collection_id`), as\n`character_reference_asset_identifiers` references (an image already\nstored with Ideogram), or as raw `character_reference_images` bytes\n(multipart requests only, with an optional\n`character_reference_mask` marking where the character is in the\nreference). If more than one form is supplied, the collection wins\nover the identifiers, and the identifiers win over the bytes.\n\nOptional style controls may be combined with the character when\n`style_type` is `auto`. Supply either style codes or style references.\nSupply style references as a saved style\n(`style_reference_collection_id`), as\n`style_reference_asset_identifiers` references, or as raw\n`style_reference_images` bytes (multipart requests only). If more than\none reference form is supplied, the collection wins over the\nidentifiers, and the identifiers win over the bytes. API-key callers\nalso need access to the style-with-character API rollout.\n\nThe output matches the size of the source image (snapped to the\nnearest resolution the model renders). By default the request blocks\nuntil the images are ready and returns them in `data`. Set `async` to\ntrue to return immediately after the request is accepted, then poll\nfor completion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "description": "Repaint the masked region of a source image with Ideogram 3.0 so it\nfeatures a consistent character. Upload the source `image`, its\n`mask`, and a `character_reference_images` image (or use a saved\ncharacter) using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.", "operationId": "post_inpaint_image_v2_ideogram_v3_character", "parameters": [ { @@ -9377,7 +9493,7 @@ } } }, - "description": "A request to repaint the masked region of a source image with a consistent character with Ideogram 3.0. Use `multipart/form-data` to upload `image` / `mask` / `character_reference_images` bytes directly, or `application/json` (or multipart with the collection id or asset identifier forms) to reference saved characters or existing assets instead.", + "description": "Use `multipart/form-data` to upload the source `image`, its `mask`, and any `character_reference_images` or `style_reference_images`.", "required": true, "x-body-name": "body" }, @@ -9390,7 +9506,7 @@ } } }, - "description": "The repainted images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The repainted images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -9409,7 +9525,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "A referenced asset or collection was not found." + "description": "A referenced resource was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -9431,7 +9547,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Repaint a masked region with a consistent character with Ideogram 3.0", + "summary": "Inpaint a consistent character with Ideogram 3.0", "tags": [ "images-inpaint" ], @@ -9440,7 +9556,7 @@ }, "/v2/image/inpaint/ideogram-3-custom-model": { "post": { - "description": "Repaint the masked region of a source image with a custom Ideogram 3.0\nmodel the authenticated user or organization can access. Supply the\nmodel URI returned by the custom-model API as `custom_model_uri`.\n\nFor each of the source image and mask, supply either an\n`AssetIdentifier` reference (`image_asset_identifier` /\n`mask_asset_identifier`) or raw bytes (`image` / `mask`, multipart\nrequests only). A reference wins if both forms are supplied.\n\nOptional style controls are style codes, a style preset, or style\nreference images. Supply style references as a saved style, existing\nasset identifiers, or raw image bytes. Only one style control may be\nused; when multiple reference forms are supplied, the collection wins\nover identifiers, and identifiers win over bytes.\n\nBy default the request blocks until the images are ready. Set `async`\nto true to return after dispatch and poll\n`GET /v1/generations/{generation_id}`.", + "description": "Repaint the masked region of a source image with a custom Ideogram 3.0\nmodel, passed as `custom_model_uri`. Upload the source `image` and its\n`mask` using `multipart/form-data`. Returns results directly by\ndefault; set `async` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.", "operationId": "post_inpaint_image_v2_ideogram_v3_custom_model", "parameters": [ { @@ -9478,7 +9594,7 @@ } } }, - "description": "A custom-model V3 inpaint request. Use multipart/form-data for raw image bytes or application/json to reference existing assets.", + "description": "Use `multipart/form-data` to upload the source `image`, its `mask`, and any `style_reference_images`.", "required": true, "x-body-name": "body" }, @@ -9500,18 +9616,32 @@ "description": "Unauthorized." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "403": { "description": "The caller cannot use the requested custom model." }, "404": { - "description": "A referenced asset or style collection was not found." + "description": "A referenced resource was not found." }, "422": { "description": "The prompt did not pass safety checks." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." }, "500": { @@ -9521,7 +9651,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Repaint a masked region with a custom Ideogram 3.0 model", + "summary": "Inpaint with a custom Ideogram 3.0 model", "tags": [ "images-inpaint" ], @@ -9530,7 +9660,7 @@ }, "/v2/image/precise-edit/ideogram-4-5": { "post": { - "description": "Edit an image with Ideogram 4.5, returning output at that image's exact\nwidth and height. An image too large for the model is scaled down to\nfit while keeping its exact proportion, and one whose aspect ratio is\noutside 1:6 to 6:1 is rejected — this endpoint never reshapes, so there\nis no size to reshape it to. Unlike\n`POST /v2/image/generate/ideogram-4-5`, this endpoint takes no `size`:\nthe output always matches the image being edited, so the edit drops\nback into whatever it came from without reframing.\n\nWhen the output is delivered at the image's own size (every image the\nmodel can hold), pixels the edit did not meaningfully change are\nrestored exactly from the image being edited, with the edited region\nblended smoothly into its surroundings — untouched areas stay\nidentical across repeated edits. An image too large for the model is\ndelivered at the scaled-down size, where every pixel is resampled, so\nit is returned as rendered.\n\nSupply the image to edit as an `image_asset_identifier` reference or as\nraw `image` bytes (multipart requests only); if both are supplied, the\nreference wins and the bytes are ignored. Add up to four more images\nvia `reference_image_asset_identifiers` or `reference_images` to guide\nthe edit — those are never edited themselves.\n\nSupply a `mask` to confine the edit to part of the image being edited.\nThe mask is optional — without one the prompt is applied to the whole\nimage. Masks are read as an additional reference image, so a masked\nrequest may carry at most three `reference_images`.\n\nThe `prompt` is the edit instruction. It accepts either natural\nlanguage or a structured JSON prompt; the server detects which was\nsupplied. A natural-language instruction is automatically rewritten\ninto the model's structured edit contract, while a prompt that is\nalready valid structured JSON is consumed directly.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Edit an image with Ideogram 4.5 and get the result back at that image's\nexact width and height. Upload the image as `image` using\n`multipart/form-data`, with optional `reference_images` and a `mask`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_precise_edit_image_v2_ideogram45", "parameters": [ { @@ -9565,7 +9695,7 @@ } } }, - "description": "A request to edit an image with Ideogram 4.5 at that image's own size. Use `multipart/form-data` to upload `image`, `reference_images` and `mask` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference existing assets instead.", + "description": "A request to edit an image with Ideogram 4.5 at that image's own size. Send it as `multipart/form-data` with the `image` to edit and any `reference_images` and `mask`.", "required": true, "x-body-name": "body" }, @@ -9578,7 +9708,7 @@ } } }, - "description": "The edited images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The edited images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -9616,7 +9746,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Edit an image with Ideogram 4.5, keeping the source's exact geometry", + "summary": "Precise edit with Ideogram 4.5", "tags": [ "images-precise-edit" ], @@ -9625,7 +9755,7 @@ }, "/v2/image/reframe/ideogram-3": { "post": { - "description": "Expand an image to a new Ideogram 3.0 resolution. The source pixels\nare preserved in the center and Ideogram fills the new area. Supply\nexactly one source: an `AssetIdentifier` reference\n(`image_asset_identifier`) or raw image bytes (`image`, multipart\nrequests only). Supplying both forms, or neither, is rejected.\n\nOptional style controls are mutually exclusive. Supply at most one of\n`style_preset`, `style_codes`, `style_reference_asset_identifiers`, or\nraw `style_reference_images` (multipart requests only). Each style\nreference transport accepts at most 10 images.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately, then poll\n`GET /v1/generations/{generation_id}`.\n", + "description": "Expand an image to a new Ideogram 3.0 resolution, keeping the source\npixels in the center and filling the new area. Upload the source\n`image` using `multipart/form-data`. Returns results directly by\ndefault; set `async` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_reframe_image_v2_ideogram_v3", "parameters": [ { @@ -9663,7 +9793,7 @@ } } }, - "description": "Use `multipart/form-data` to upload `image` or `style_reference_images` bytes directly. Use `application/json` (or multipart fields with JSON content) to reference existing source or style assets by `AssetIdentifier`.", + "description": "Use `multipart/form-data` to upload the source `image` and any `style_reference_images`.", "required": true, "x-body-name": "body" }, @@ -9695,7 +9825,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "A referenced source or style asset was not found." + "description": "A referenced resource was not found." }, "429": { "content": { @@ -9714,7 +9844,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Reframe an image with Ideogram 3.0, by asset id or by uploaded bytes", + "summary": "Reframe with Ideogram 3.0", "tags": [ "images-reframe" ], @@ -9728,7 +9858,7 @@ }, "/v2/image/reframe/nano-banana-2": { "post": { - "description": "Expand one image to a new aspect ratio with Nano Banana 2.\nSupply either an existing Ideogram image asset or raw image bytes,\nbut not both. The requested aspect ratio is resolved to the closest\nsupported 1K output dimensions.\n\nThis operation is asynchronous. It returns as soon as the request is\naccepted; poll `GET /v1/generations/{generation_id}` for completion\nand results.\n", + "description": "Expand an image to a new aspect ratio with Nano Banana 2. Upload the\nsource `image` using `multipart/form-data`. Always asynchronous:\nreturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nfor results.\n", "operationId": "post_reframe_image_nano_banana2", "parameters": [ { @@ -9772,7 +9902,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -9791,7 +9921,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source asset was not found." + "description": "A referenced resource was not found." }, "429": { "content": { @@ -9810,7 +9940,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Reframe an image with Nano Banana 2", + "summary": "Reframe with Nano Banana 2", "tags": [ "images-reframe" ], @@ -9824,7 +9954,7 @@ }, "/v2/image/remix/auto": { "post": { - "description": "Transform an existing image with a server-selected model, guided by a\ntext prompt. Supply the source as `image` bytes (multipart requests\nonly). `image_weight` controls how closely the result follows the\nsource; when omitted the selected model chooses its usual strength.\n\nThe server chooses a model that supports the requested remix controls:\nstyle references (ad hoc or saved), a color palette, style codes, a\nstyle preset, and a non-`auto` style type each\nrestrict the request to a compatible model and to the 1K tier;\nremixes without those controls use the default model. Omit\n`resolution` and `aspect_ratio` to keep the source image's shape.\nSupplying `image_weight` together with a `resolution` or\n`aspect_ratio` that changes the source's aspect ratio routes the\nrequest to a model that crops the source to the new shape; that\ncombination is served only at the 1K tier and is rejected at 2K.\n(The model-pinned remix endpoints such as\n`/v2/image/remix/ideogram-4` reject the combination outright.)\n`seed` is honored only on the compatible model; the default model\nsynthesizes an unseeded instruction prompt, so results are not\nreproducible there.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.", + "description": "Remix an image guided by a text prompt, with Ideogram choosing the\nmodel. Upload the source image as `image` using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.", "operationId": "post_tool_remix", "parameters": [ { @@ -9862,7 +9992,7 @@ } } }, - "description": "A request to remix one image with a server-selected model. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead. Supplying both source forms is rejected rather than one being ignored.", + "description": "A request to remix one image with an automatically selected model. Send it as `multipart/form-data` with the source `image`.", "required": true, "x-body-name": "body" }, @@ -9875,7 +10005,7 @@ } } }, - "description": "The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -9884,15 +10014,29 @@ "description": "Unauthorized." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "404": { - "description": "A referenced source, reference asset, or saved collection was not found." + "description": "A referenced resource was not found." }, "422": { "description": "The prompt did not pass safety checks." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." }, "500": { @@ -9902,7 +10046,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Remix an existing image, letting the server pick the best model", + "summary": "Remix with automatic model selection", "tags": [ "auto-model" ], @@ -9911,7 +10055,7 @@ }, "/v2/image/remix/ideogram-3": { "post": { - "description": "Transform an existing image with Ideogram 3.0, guided by a text\nprompt. Supply the source either as an `image_asset_identifier`\nreference (an image already stored with Ideogram) or as raw `image`\nbytes (multipart requests only). Supplying both is rejected rather\nthan one being ignored. `image_weight` controls how closely the\nresult follows the source; when omitted the server picks a value from\nyour prompt.\n\nOmit `resolution` and `aspect_ratio` to keep the source image's\nshape. If you request a different shape, the source is center-cropped\nto fit it first, and whatever falls outside the new shape is\ndiscarded.\n\nOptional style controls work as on the Ideogram 3.0 generate\nendpoint: style codes, a style preset, a color palette, or style\nreference images.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Transform an existing image with Ideogram 3.0, guided by a text\nprompt. Upload the source `image` using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_remix_image_v2_ideogram_v3", "parameters": [ { @@ -9949,7 +10093,7 @@ } } }, - "description": "A request to remix one image with Ideogram 3.0. Use `multipart/form-data` to upload `image` or `style_reference_images` bytes directly, or `application/json` (or multipart with the `*_asset_identifier` fields) to reference existing assets instead. Supplying both source forms is rejected rather than one being ignored.", + "description": "Use `multipart/form-data` to upload the source `image` and any `style_reference_images`.", "required": true, "x-body-name": "body" }, @@ -9962,7 +10106,7 @@ } } }, - "description": "The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -9981,7 +10125,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source or style asset was not found." + "description": "A referenced resource was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -10003,7 +10147,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Remix an existing image with Ideogram 3.0, guided by a prompt", + "summary": "Remix with Ideogram 3.0", "tags": [ "images-remix" ], @@ -10012,7 +10156,7 @@ }, "/v2/image/remix/ideogram-3-character": { "post": { - "description": "Transform an existing image with Ideogram 3.0, guided by a text\nprompt and featuring a consistent character. Supply the source either\nas an `image_asset_identifier` reference (an image already stored\nwith Ideogram) or as raw `image` bytes (multipart requests only).\nSupplying both is rejected rather than one being ignored.\n`image_weight` controls how closely the result follows the source;\nwhen omitted the server picks a value from your prompt.\n\nSupply the character as a saved character\n(`character_reference_collection_id`), as\n`character_reference_asset_identifiers` references, or as raw\n`character_reference_images` bytes (multipart requests only, with an\noptional `character_reference_mask` marking where the character is in\nthe reference). If more than one form is supplied, the collection\nwins over the identifiers, and the identifiers win over the bytes.\n\nOmit `resolution` and `aspect_ratio` to keep the source image's\nshape. If you request a different shape, the source is center-cropped\nto fit it first, and whatever falls outside the new shape is\ndiscarded.\n\nStyle references may be supplied as a saved style\n(`style_reference_collection_id`), as\n`style_reference_asset_identifiers` references, or as raw\n`style_reference_images` bytes, with the same precedence as the\ncharacter forms.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Transform an existing image with Ideogram 3.0 so it features a\nconsistent character, guided by a text prompt. Upload the source\n`image` and a `character_reference_images` image (or use a saved\ncharacter) using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_remix_image_v2_ideogram_v3_character", "parameters": [ { @@ -10050,7 +10194,7 @@ } } }, - "description": "A request to remix one image with Ideogram 3.0, featuring a consistent character. Use `multipart/form-data` to upload `image`, `character_reference_images`, or `style_reference_images` bytes directly, or `application/json` (or multipart with the collection id or asset identifier forms) to reference saved characters, styles, or existing assets instead. Supplying both source forms is rejected rather than one being ignored.", + "description": "Use `multipart/form-data` to upload the source `image` and any `character_reference_images` or `style_reference_images`.", "required": true, "x-body-name": "body" }, @@ -10063,7 +10207,7 @@ } } }, - "description": "The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -10082,7 +10226,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "A referenced asset or collection was not found." + "description": "A referenced resource was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -10104,7 +10248,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Remix an existing image with Ideogram 3.0, featuring a consistent character", + "summary": "Remix a consistent character with Ideogram 3.0", "tags": [ "images-remix" ], @@ -10113,7 +10257,7 @@ }, "/v2/image/remix/ideogram-3-custom-model": { "post": { - "description": "Transform an existing image with a custom Ideogram 3.0 model that the\nauthenticated user or organization can access, guided by a text\nprompt. Supply the source either as an `image_asset_identifier`\nreference (an image already stored with Ideogram) or as raw `image`\nbytes (multipart requests only). Supplying both is rejected rather\nthan one being ignored. `image_weight` controls how closely the\nresult follows the source; when omitted the server picks a value from\nyour prompt.\n\nOmit `resolution` and `aspect_ratio` to keep the source image's\nshape. If you request a different shape, the source is center-cropped\nto fit it first, and whatever falls outside the new shape is\ndiscarded.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Transform an existing image with a custom Ideogram 3.0 model that your\nuser or organization can access, guided by a text prompt. Upload the\nsource `image` using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_remix_image_v2_ideogram_v3_custom_model", "parameters": [ { @@ -10151,7 +10295,7 @@ } } }, - "description": "A request to remix one image with an accessible custom Ideogram 3.0 model. Use `multipart/form-data` to upload `image` or `style_reference_images` bytes directly, or `application/json` (or multipart with the `*_asset_identifier` fields) to reference existing assets instead. Supplying both source forms is rejected rather than one being ignored.", + "description": "Use `multipart/form-data` to upload the source `image` and any `style_reference_images`.", "required": true, "x-body-name": "body" }, @@ -10164,7 +10308,7 @@ } } }, - "description": "The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input or an unsupported model option." @@ -10186,7 +10330,7 @@ "description": "The custom model does not exist or is not accessible to this user or organization." }, "404": { - "description": "The referenced source or style asset was not found." + "description": "A referenced resource was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -10208,7 +10352,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Remix an existing image with a custom Ideogram 3.0 model", + "summary": "Remix with a custom Ideogram 3.0 model", "tags": [ "images-remix" ], @@ -10217,7 +10361,7 @@ }, "/v2/image/remix/ideogram-4": { "post": { - "description": "Transform an existing image with Ideogram 4.0, guided by a text\nprompt. Supply the source either as an `image_asset_identifier`\nreference (an image already stored with Ideogram) or as raw `image`\nbytes (multipart requests only). Supplying both is rejected rather\nthan one being ignored. `image_weight` controls how closely the\nresult follows the source; when omitted the server picks a value from\nyour prompt.\n\nOmit `resolution` to keep the source image's shape. A `resolution`\nwhose aspect ratio differs from the source's cannot be combined with\n`image_weight` — that request is rejected with a 400.\n\nThe prompt is always interpreted by an instruction-editing model, so\nthere is no `magic_prompt` option. Remixes are not reproducible, so\nno seed is accepted; the response reports the seed the request\nresolved to.\n\nBy default the request blocks until the images are ready and returns\nthem in `data`. Set `async` to true to return immediately after the\nrequest is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Transform an existing image with Ideogram 4.0, guided by a text\nprompt. Upload the source `image` using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_remix_image_v2_ideogram_v4", "parameters": [ { @@ -10249,7 +10393,7 @@ } } }, - "description": "A request to remix one image with Ideogram 4.0. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead. Supplying both is rejected rather than one being ignored.", + "description": "Use `multipart/form-data` to upload the source `image`.", "required": true, "x-body-name": "body" }, @@ -10262,7 +10406,7 @@ } } }, - "description": "The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -10281,7 +10425,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source asset was not found." + "description": "A referenced resource was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -10303,16 +10447,21 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Remix an existing image with Ideogram 4.0, guided by a prompt", + "summary": "Remix with Ideogram 4.0", "tags": [ "images-remix" ], + "x-playground-endpoint": { + "id": "remix-v4", + "label": "Remix", + "order": 2 + }, "x-openapi-router-controller": "external_api.generated.openapi.controllers.images_remix_controller" } }, "/v2/image/remove-background/ideogram-1": { "post": { - "description": "Remove the background from one image and return a foreground PNG with\ntransparency. Supply exactly one source: raw `image` bytes in a\nmultipart request, or an existing `image_asset_identifier` in JSON or\nmultipart form.\n\nBy default the request blocks until the foreground image is ready and\nreturns it in `data`. Set `async` to true to return immediately after\nthe request is accepted, then poll `GET /v1/generations/{generation_id}`.\n\nAPI-key requests use the organization bound to the key. Firebase Bearer\nrequests use their selected organization, and Mini App context tokens\nremain bound to the organization in the token. When `private` is omitted,\nBearer and Mini App callers inherit their plan's private-generation\ndefault; Enterprise generations are always private.\n", + "description": "Remove the background from an image and return the foreground as a\ntransparent PNG. Upload the source `image` using `multipart/form-data`.\nReturns the result directly by default; set `async` to get a\n`generation_id` and poll `GET /v2/generations/{generation_id}`.\n", "operationId": "post_remove_background_v2", "parameters": [ { @@ -10356,7 +10505,7 @@ } } }, - "description": "The foreground image (synchronous requests), or an acknowledgement to poll (`async` requests). If a synchronous failure occurs after heartbeat streaming begins, the HTTP status is already committed; the response instead contains `error` and `status_code`." + "description": "The foreground image (synchronous requests), or an acknowledgement to poll (`async` requests). If a synchronous request fails after the response has started streaming, the HTTP status is already 200; the body contains `error` and `status_code` instead." }, "400": { "description": "Invalid input provided." @@ -10375,10 +10524,10 @@ "description": "Insufficient credits or quota." }, "403": { - "description": "The selected organization or Mini App scope is not authorized." + "description": "Not authorized to remove backgrounds." }, "404": { - "description": "A referenced source asset was not found or is not readable." + "description": "The source image was not found or is not readable." }, "429": { "content": { @@ -10397,23 +10546,23 @@ "description": "Background removal is temporarily unavailable." } }, - "summary": "Remove an image background", + "summary": "Remove background", "tags": [ "tool" ], "x-fern-sdk-group-name": "tool", "x-fern-sdk-method-name": "removeBackground", "x-playground-endpoint": { - "id": "remove-background-v2", - "label": "Remove background V2", - "order": 4 + "id": "remove-background", + "label": "Remove background", + "order": 3 }, "x-openapi-router-controller": "external_api.generated.openapi.controllers.tool_controller" } }, "/v2/image/remove-object/ideogram-1": { "post": { - "description": "Remove a masked object from an image. For each of the source image and the\nmask, supply either an `AssetIdentifier` reference (`image_asset_identifier`\n/ `mask_asset_identifier`) or the raw image bytes directly (`image` / `mask`,\nmultipart requests only) — callers are never required to call\n`POST /v2/assets` first. If both a reference and bytes are supplied for the\nsame input, the reference wins and the bytes are ignored.\n\nPoll for completion with `GET /v1/generations/{generation_id}` using the\nreturned `generation_id`.\n\nThis is the `/v2` capability-first shape; no `model` or `model_uri` field is\nexposed until a second backend exists.\n", + "description": "Remove a masked object from an image. Upload the source `image` and a\n`mask` of the same size using `multipart/form-data`. Returns a\n`generation_id`; poll `GET /v2/generations/{generation_id}` for the\nresult.\n", "operationId": "post_remove_object_from_v2_assets", "parameters": [ { @@ -10448,7 +10597,7 @@ } } }, - "description": "A request to remove a masked object from an image. Use `multipart/form-data` to upload `image` / `mask` bytes directly, or `application/json` (or multipart with `image_asset_identifier` / `mask_asset_identifier`) to reference existing assets instead.", + "description": "The source `image` and `mask`, uploaded using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -10461,7 +10610,7 @@ } } }, - "description": "Object removal request accepted; poll for completion with `GET /v1/generations/{generation_id}`." + "description": "Object removal request accepted; poll for completion with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -10483,7 +10632,7 @@ "description": "Not authorized to remove an object." }, "404": { - "description": "A referenced source or mask asset was not found." + "description": "The source image or mask was not found." }, "413": { "description": "An uploaded source or mask image is too large." @@ -10502,7 +10651,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Remove a masked object from an image, by asset id or by uploaded bytes", + "summary": "Remove an object", "tags": [ "object-removal" ], @@ -10511,7 +10660,7 @@ }, "/v2/image/replace-background/gpt-image-2": { "post": { - "description": "Replaces the background of one image from a text prompt while preserving\nthe foreground subject. The foreground mask is detected automatically;\ncallers do not provide a mask.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n\nSupply exactly one source transport: an existing `AssetIdentifier` in\n`image_asset_identifier`, or raw `image` bytes in a multipart request.\nSupplying both or neither is rejected with a 400.\n", + "description": "Replace the background of an image from a text prompt while keeping the\nautomatically detected foreground subject; no mask is needed. Upload\nthe source `image` using `multipart/form-data`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_replace_background", "parameters": [ { @@ -10578,7 +10727,7 @@ "description": "Not authorized to replace backgrounds." }, "404": { - "description": "The source asset was not found or is not readable." + "description": "The source image was not found or is not readable." }, "422": { "description": "The prompt did not pass safety checks." @@ -10597,7 +10746,7 @@ "description": "Background replacement is temporarily unavailable." } }, - "summary": "Replace an image background", + "summary": "Replace background with GPT Image 2", "tags": [ "edit-workflow" ], @@ -10608,7 +10757,7 @@ }, "/v2/image/replace-background/ideogram-3": { "post": { - "description": "Replaces the background of one image from a text prompt while preserving\nthe foreground subject, generated by Ideogram 3.0 inpainting. The\nforeground mask is detected automatically; callers do not provide a mask.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n\nSupply exactly one source transport: an existing `AssetIdentifier` in\n`image_asset_identifier`, or raw `image` bytes in a multipart request.\nSupplying both or neither is rejected with a 400. The source's longer\nside must be at most 3 times its shorter side; wider aspect ratios are\nrejected with a 400.\n", + "description": "Replace the background of an image from a text prompt with Ideogram 3.0,\nkeeping the automatically detected foreground subject; no mask is\nneeded. Upload the source `image` using `multipart/form-data`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_replace_background_ideogram_v3", "parameters": [ { @@ -10675,7 +10824,7 @@ "description": "Not authorized to replace backgrounds." }, "404": { - "description": "The source asset was not found or is not readable." + "description": "The source image was not found or is not readable." }, "422": { "description": "The prompt did not pass safety checks." @@ -10694,7 +10843,7 @@ "description": "Background replacement is temporarily unavailable." } }, - "summary": "Replace an image background with Ideogram 3.0", + "summary": "Replace background with Ideogram 3.0", "tags": [ "edit-workflow" ], @@ -10705,7 +10854,7 @@ }, "/v2/image/upscale/auto": { "post": { - "description": "Upscale one image to 2x, 4x, or 8x its original resolution, up to a\nmaximum output of 8192px per side. Ideogram selects the best upscaling\nmodel for each request, and the selection may change over time; callers\nnever choose a model.\n\nSupply the source either as an `image_asset_identifier` reference (an\nimage already stored with Ideogram) or as raw `image` bytes (multipart\nrequests only). Provide exactly one of the two forms; supplying both,\nor neither, is rejected with a 400. Uploaded bytes are used for this\nrequest only and are not stored as an asset; upscales of a referenced\nasset keep a visible link to their source image.\n\nUpscaling takes no prompt: the source image is enhanced as-is.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in `data`. Set `async` to true to return immediately after\nthe request is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Upscale an image to 2x, 4x, or 8x its original resolution with a model\nIdeogram picks per request; the choice may change over time. Upload the\nsource `image` using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_upscale", "parameters": [ { @@ -10737,7 +10886,7 @@ } } }, - "description": "A request to upscale one image. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to upscale one image. Upload the source `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -10750,7 +10899,7 @@ } } }, - "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided, or the output would exceed the 8K limit." @@ -10772,7 +10921,7 @@ "description": "Not authorized to upscale images." }, "404": { - "description": "The referenced source asset was not found." + "description": "The source image was not found." }, "429": { "content": { @@ -10791,7 +10940,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Upscale an image", + "summary": "Upscale with automatic model selection", "tags": [ "tools" ], @@ -10800,7 +10949,7 @@ }, "/v2/image/upscale/nano-banana-pro": { "post": { - "description": "Regenerate the source image at a higher resolution tier (1K, 2K, or\n4K) while preserving its content, composition, and style. Supply the\nsource either as an `image_asset_identifier` reference (an image\nalready stored with Ideogram) or as raw `image` bytes (multipart\nrequests only) — callers are never required to upload the asset\nfirst. If both are supplied, the reference wins and the bytes are\nignored. Uploaded bytes are used for this request only and are not\nstored as an asset; upscales of a referenced asset keep a visible\nlink to their source image.\n\nAn optional `prompt` adds short guidance for the enhancement; the\nimage is otherwise upscaled as-is. The source must be smaller than\nthe requested `resolution_tier`.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in `data`. Set `async` to true to return immediately after\nthe request is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Regenerate an image at a higher `resolution_tier` (1K, 2K, or 4K) while\npreserving its content, composition, and style. Upload the source\n`image` using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_upscale_image_nano_banana_pro", "parameters": [ { @@ -10832,7 +10981,7 @@ } } }, - "description": "A request to upscale one image with Nano Banana Pro. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to upscale one image with Nano Banana Pro. Upload the source `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -10845,7 +10994,7 @@ } } }, - "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided." @@ -10864,7 +11013,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source asset was not found." + "description": "The source image was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -10886,7 +11035,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Upscale an image with Nano Banana Pro, by asset id or by uploaded bytes", + "summary": "Upscale with Nano Banana Pro", "tags": [ "images-upscale" ], @@ -10895,7 +11044,7 @@ }, "/v2/image/upscale/topaz-bloom-2": { "post": { - "description": "Creatively upscale one image to 2x, 4x, or 8x its original resolution,\nup to a maximum output of 8192px per side. Supply the source either as\nan `image_asset_identifier` reference (an image already stored with\nIdeogram) or as raw `image` bytes (multipart requests only) — callers\nare never required to upload the asset first. If both are supplied,\nthe reference wins and the bytes are ignored. Uploaded bytes are used\nfor this request only and are not stored as an asset; upscales of a\nreferenced asset keep a visible link to their source image.\n\nAn optional `prompt` guides the regenerated detail, and `creativity`\ncontrols how strongly the model reinterprets the source while\nenlarging it.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in `data`. Set `async` to true to return immediately after\nthe request is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Creatively upscale an image to 2x, 4x, or 8x its original resolution,\noptionally guided by a `prompt`. Upload the source `image` using\n`multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_upscale_image_topaz_bloom2", "parameters": [ { @@ -10927,7 +11076,7 @@ } } }, - "description": "A request to upscale one image with Topaz Bloom 2. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to upscale one image with Topaz Bloom 2. Upload the source `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -10940,7 +11089,7 @@ } } }, - "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided, or the output would exceed the 8K limit." @@ -10959,7 +11108,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source asset was not found." + "description": "The source image was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -10981,7 +11130,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Upscale an image with Topaz Bloom 2, by asset id or by uploaded bytes", + "summary": "Upscale with Topaz Bloom 2", "tags": [ "images-upscale" ], @@ -10990,7 +11139,7 @@ }, "/v2/image/upscale/topaz-redefine": { "post": { - "description": "Creatively upscale one image to 2x, 4x, or 8x its original resolution,\nup to a maximum output of 8192px per side. Supply the source either as\nan `image_asset_identifier` reference (an image already stored with\nIdeogram) or as raw `image` bytes (multipart requests only) — callers\nare never required to upload the asset first. If both are supplied,\nthe reference wins and the bytes are ignored. Uploaded bytes are used\nfor this request only and are not stored as an asset; upscales of a\nreferenced asset keep a visible link to their source image.\n\nAn optional `prompt` guides the regenerated detail, or `autoprompt`\nlets the model describe the image itself. `creativity` controls how\nstrongly the model reinterprets the source, `texture` how much fine\ntexture it adds, and the precision knobs (sharpen, denoise, detail,\nface enhancement, subject detection) refine the result.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in `data`. Set `async` to true to return immediately after\nthe request is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Creatively upscale an image to 2x, 4x, or 8x its original resolution,\nguided by an optional `prompt` or `autoprompt`. Upload the source\n`image` using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_upscale_image_topaz_redefine", "parameters": [ { @@ -11022,7 +11171,7 @@ } } }, - "description": "A request to upscale one image with Topaz Redefine. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to upscale one image with Topaz Redefine. Upload the source `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -11035,7 +11184,7 @@ } } }, - "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided, or the output would exceed the 8K limit." @@ -11054,7 +11203,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source asset was not found." + "description": "The source image was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -11076,7 +11225,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Upscale an image with Topaz Redefine, by asset id or by uploaded bytes", + "summary": "Upscale with Topaz Redefine", "tags": [ "images-upscale" ], @@ -11085,7 +11234,7 @@ }, "/v2/image/upscale/topaz-standard-2": { "post": { - "description": "Upscale one image to 2x, 4x, or 8x its original resolution, up to a\nmaximum output of 8192px per side. Supply the source either as an\n`image_asset_identifier` reference (an image already stored with\nIdeogram) or as raw `image` bytes (multipart requests only) — callers\nare never required to upload the asset first. If both are supplied,\nthe reference wins and the bytes are ignored. Uploaded bytes are used\nfor this request only and are not stored as an asset; upscales of a\nreferenced asset keep a visible link to their source image.\n\nUpscaling takes no prompt: the model enhances the source image as-is.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in `data`. Set `async` to true to return immediately after\nthe request is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is\nneeded. Upload the source `image` using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_upscale_image_topaz_standard_v2", "parameters": [ { @@ -11117,7 +11266,7 @@ } } }, - "description": "A request to upscale one image with Topaz Standard V2. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to upscale one image with Topaz Standard V2. Upload the source `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -11130,7 +11279,7 @@ } } }, - "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided, or the output would exceed the 8K limit." @@ -11149,7 +11298,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source asset was not found." + "description": "The source image was not found." }, "429": { "content": { @@ -11168,7 +11317,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Upscale an image with Topaz Standard V2, by asset id or by uploaded bytes", + "summary": "Upscale with Topaz Standard V2", "tags": [ "images-upscale" ], @@ -11177,7 +11326,7 @@ }, "/v2/image/upscale/topaz-text-refine": { "post": { - "description": "Upscale one image to 2x, 4x, or 8x its original resolution, up to a\nmaximum output of 8192px per side. Supply the source either as an\n`image_asset_identifier` reference (an image already stored with\nIdeogram) or as raw `image` bytes (multipart requests only) — callers\nare never required to upload the asset first. If both are supplied,\nthe reference wins and the bytes are ignored. Uploaded bytes are used\nfor this request only and are not stored as an asset; upscales of a\nreferenced asset keep a visible link to their source image.\n\nUpscaling takes no prompt: the model enhances the source image as-is.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in `data`. Set `async` to true to return immediately after\nthe request is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Upscale an image to 2x, 4x, or 8x its original resolution; no prompt is\nneeded. Upload the source `image` using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_upscale_image_topaz_text_refine", "parameters": [ { @@ -11209,7 +11358,7 @@ } } }, - "description": "A request to upscale one image with Topaz Text Refine. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to upscale one image with Topaz Text Refine. Upload the source `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -11222,7 +11371,7 @@ } } }, - "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided, or the output would exceed the 8K limit." @@ -11241,7 +11390,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source asset was not found." + "description": "The source image was not found." }, "429": { "content": { @@ -11260,7 +11409,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Upscale an image with Topaz Text Refine, by asset id or by uploaded bytes", + "summary": "Upscale with Topaz Text Refine", "tags": [ "images-upscale" ], @@ -11269,7 +11418,7 @@ }, "/v2/image/upscale/topaz-wonder-3-5": { "post": { - "description": "Upscale one image to 2x, 4x, or 8x its original resolution, up to a\nmaximum output of 8192px per side. Supply the source either as an\n`image_asset_identifier` reference (an image already stored with\nIdeogram) or as raw `image` bytes (multipart requests only) — callers\nare never required to upload the asset first. If both are supplied,\nthe reference wins and the bytes are ignored. Uploaded bytes are used\nfor this request only and are not stored as an asset; upscales of a\nreferenced asset keep a visible link to their source image.\n\nUpscaling takes no prompt: the model enhances the source image as-is.\nUse `enhancement_strength` to control how strongly the generative\nmodel reconstructs detail.\n\nBy default the request blocks until the upscaled image is ready and\nreturns it in `data`. Set `async` to true to return immediately after\nthe request is accepted, then poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`.\n\nSupplying a `webhook_url` makes the request asynchronous whatever\n`async` says: the response returns as soon as the request is accepted,\nand the finished result is POSTed to that URL.\n", + "description": "Upscale an image to 2x, 4x, or 8x its original resolution, with\n`enhancement_strength` controlling how strongly detail is reconstructed.\nUpload the source `image` using `multipart/form-data`.\nReturns results directly by default; set `async` or supply a\n`webhook_url` to get a `generation_id` and poll\n`GET /v2/generations/{generation_id}`.\n", "operationId": "post_upscale_image_topaz_wonder35", "parameters": [ { @@ -11301,7 +11450,7 @@ } } }, - "description": "A request to upscale one image with Topaz Wonder 3.5. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to upscale one image with Topaz Wonder 3.5. Upload the source `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -11314,7 +11463,7 @@ } } }, - "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v1/generations/{generation_id}` (`async` requests)." + "description": "The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests)." }, "400": { "description": "Invalid input provided, or the output would exceed the 8K limit." @@ -11333,7 +11482,7 @@ "description": "Insufficient credits or quota." }, "404": { - "description": "The referenced source asset was not found." + "description": "The source image was not found." }, "429": { "content": { @@ -11352,7 +11501,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Upscale an image with Topaz Wonder 3.5, by asset id or by uploaded bytes", + "summary": "Upscale with Topaz Wonder 3.5", "tags": [ "images-upscale" ], @@ -11494,7 +11643,7 @@ }, "/v2/tool/ad-localizer": { "post": { - "description": "Rebuilds the source advertisement for one target language. Layout,\nlogos, brand type, and the product are preserved; the visible marketing\ncopy is what changes.\n\nWithout `exact_copy` the copy is translated. Supply `exact_copy` to\nplace wording that has already been approved, character for character,\ninstead of translating it.\n\nThe output keeps the source advertisement's own shape and is generated\nat a frame derived from it, so neither the shape nor the size is asked\nfor.\n\nOne request localizes into one language. Localize into several languages\nby submitting one request per language.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n\nSupply the source advertisement as either an `AssetIdentifier` reference\n(`image_asset_identifier`) or the raw image bytes directly (`image`,\nmultipart requests only). Provide exactly one of the two forms;\nsupplying both, or neither, is rejected with a 400.\n", + "description": "Rebuilds an ad in one target language, preserving its layout, logos,\nbrand type, and product so only the visible marketing copy changes.\nUpload the source ad as `image` using `multipart/form-data`; the copy\nis translated unless you supply `exact_copy`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}` or\nsupply a `webhook_url`.\n", "operationId": "post_ad_localizer", "parameters": [ { @@ -11526,7 +11675,7 @@ } } }, - "description": "The source advertisement and the target language. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "The source ad and the target language.", "required": true, "x-body-name": "body" }, @@ -11558,7 +11707,7 @@ "description": "Insufficient credits or quota." }, "403": { - "description": "This account or mini app is not authorized to use Ad Localizer." + "description": "Not authorized to use Ad Localizer." }, "404": { "description": "An input asset was not found or is not readable." @@ -11577,7 +11726,7 @@ "description": "Too many requests." } }, - "summary": "Rebuild an advertisement in another language", + "summary": "Ad Localizer", "tags": [ "edit-workflow" ], @@ -11586,7 +11735,7 @@ }, "/v2/tool/ad-resizer": { "post": { - "description": "Reframes the source creative to the exact requested ad resolution,\nregenerating the layout so text and key elements stay legible at the\ntarget size.\n\nSupply `platform` to keep the whole advertisement clear of that\nplatform's own interface. The advertisement is generated at the largest\nrectangle that fits inside the platform's published safe zone for the\nrequested aspect ratio, placed at that rectangle's position, and the\nspace around it is filled in so the returned image is still exactly the\nrequested resolution. Omit `platform` and the advertisement fills the\nwhole frame.\n\nEach platform accepts only the resolutions for which it publishes a\nsafe zone:\n\n| Platform | Accepted resolutions |\n| --- | --- |\n| `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |\n| `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |\n| `meta_stories` | `1080x1920`, `2160x3840` |\n| `meta_reels` | `1080x1920`, `2160x3840` |\n| `meta` (legacy) | `1080x1920`, `2160x3840` |\n| `snapchat` | `1080x1920`, `2160x3840` |\n\nA `platform` combined with any other `resolution` is rejected with a\n400. When `platform` is omitted, every resolution in the request schema\nis accepted.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed. The completed generation\nreports the exact amount billed for the request in\n`usage_cost_usd_micros`.\n\nSupply the source creative as either an `AssetIdentifier` reference\n(`image_asset_identifier`) or the raw image bytes directly (`image`,\nmultipart requests only). Provide exactly one of the two forms;\nsupplying both, or neither, is rejected with a 400.", + "description": "Reframes an ad creative to an exact ad resolution, regenerating the\nlayout so text and key elements stay legible at the new size. Upload\nthe source creative as `image` using `multipart/form-data`, and supply\n`platform` to keep the ad inside that platform's safe zone.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}` or\nsupply a `webhook_url`.", "operationId": "post_ad_resizer", "parameters": [ { @@ -11618,7 +11767,7 @@ } } }, - "description": "The source creative, the target ad resolution, and optionally the platform whose safe zone the advertisement must stay inside. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "The source creative, the target ad resolution, and optionally the platform whose safe zone the ad must stay inside.", "required": true, "x-body-name": "body" }, @@ -11669,7 +11818,7 @@ "description": "Too many requests." } }, - "summary": "Advertisement Resizer v2", + "summary": "Ad Resizer", "tags": [ "edit-workflow" ], @@ -11703,7 +11852,7 @@ }, "/v2/tool/ad-variations": { "post": { - "description": "Generates a brand-locked creative variation of the source ad along the\nrequested variation axis: different people, a different setting, a\ndifferent group size, or a different scene. Logos, brand colors, the\nproduct, and all on-image text are preserved; only the requested axis\nchanges.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed. The completed generation\nreports the exact amount billed for the request in\n`usage_cost_usd_micros`.\n\nEach returned image is generated at the source creative's own aspect\nratio (the long side to short side ratio is capped at 3:1).\n\nSupply the source creative as either an `AssetIdentifier` reference\n(`image_asset_identifier`) or the raw image bytes directly (`image`,\nmultipart requests only). Provide exactly one of the two forms;\nsupplying both, or neither, is rejected with a 400.\n", + "description": "Creates on-brand variations of an ad along one axis, preserving logos,\nbrand colors, the product, and all on-image text. Upload the source\ncreative as `image` using `multipart/form-data` and choose a\n`variation_type`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}` or\nsupply a `webhook_url`.\n", "operationId": "post_ad_variations", "requestBody": { "content": { @@ -11723,7 +11872,7 @@ } } }, - "description": "The source creative and the variation axis. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "The source creative and the variation axis.", "required": true, "x-body-name": "body" }, @@ -11774,7 +11923,7 @@ "description": "Too many requests." } }, - "summary": "Advertisement Variations", + "summary": "Ad Variations", "tags": [ "edit-workflow" ], @@ -11783,7 +11932,7 @@ }, "/v2/tool/colorways": { "post": { - "description": "Recolors the masked regions of the product photo, each to its own\ntarget color, while preserving the product's geometry, materials,\nprints, logos, and shading, and keeping every region outside the\nmasks unchanged.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n\nSupply the product photo as raw `image` bytes via\n`multipart/form-data`.\n\nSupply the masks marking the regions to recolor as raw `masks` bytes,\npaired by position with `colors` — up to 4 regions; a single-region\nedit is a one-item list. Every mask must have the same pixel\ndimensions as the product photo. White pixels mark the region to\nrecolor; black pixels are preserved. Alpha-only masks are also\nsupported: opaque pixels mark the region to recolor and transparent\npixels are preserved.\n", + "description": "Recolors masked regions of a product photo, each to its own target\ncolor, preserving the product's geometry, materials, prints, logos, and\neverything outside the masks. Upload the `image` and up to 4 `masks`\nusing `multipart/form-data`, with one entry in `colors` per mask.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}` or\nsupply a `webhook_url`.\n", "operationId": "post_colorways", "parameters": [ { @@ -11863,7 +12012,7 @@ "description": "Too many requests." } }, - "summary": "Product Color Change", + "summary": "Colorways", "tags": [ "edit-workflow" ], @@ -11872,7 +12021,7 @@ }, "/v2/tool/ghost-mannequin": { "post": { - "description": "Transforms one or more photographs of the same garment into a polished\nghost-mannequin product image on a clean white studio background. The\ngarment keeps its identity and construction while the source person,\nmannequin, hanger, environment, and other clothing are removed.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n\nSupply one or more garment references. Use the directional fields when\nthe camera direction is known; each direction accepts either an\nexisting `AssetIdentifier` or one raw image, but not both. Additional\nunlabeled references can be supplied through exactly one transport:\n`garment_asset_identifiers`, or multipart `garment_images`.\n", + "description": "Turns photos of one garment into a ghost-mannequin product image on a\nclean white studio background, removing the person, mannequin, hanger,\nand other clothing. Upload the photos using `multipart/form-data`, in\nthe directional fields (such as `front_image`) when the camera\ndirection is known and in `garment_images` otherwise.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}` or\nsupply a `webhook_url`.\n", "operationId": "post_ghost_mannequin", "parameters": [ { @@ -11922,7 +12071,7 @@ } } }, - "description": "Garment references and the requested catalog presentation.", + "description": "The garment photos and the requested output view.", "required": true, "x-body-name": "body" }, @@ -11976,16 +12125,98 @@ "description": "Too many requests." } }, - "summary": "Create ghost-mannequin garment photography", + "summary": "Ghost Mannequin", "tags": [ "edit-workflow" ], "x-openapi-router-controller": "external_api.generated.openapi.controllers.edit_workflow_controller" } }, + "/v2/tool/living-image": { + "post": { + "description": "Animates one image into a short, loop-ready clip for use as a living background. The camera stays fixed and only the parts of the scene that would move in real life move: water, light, mist, particles, fabric, creatures. Ideogram inspects the image and writes the motion prompt, so the request needs only the image.\nVideo generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails.", + "operationId": "post_living_image", + "parameters": [ + { + "description": "When true, the request is validated and priced but not run: nothing is\ngenerated, stored, or billed, and no safety review is performed. The\nresponse is a `PriceQuote` object instead of the usual response for this\nendpoint. Send exactly the request you would send to generate, so the\nquote reflects the same options.\n", + "in": "query", + "name": "dry_run", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LivingImageRequest" + } + } + }, + "description": "The image to bring to life and the output options.", + "required": true, + "x-body-name": "living_image_request" + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LivingImageResponse" + } + } + }, + "description": "Living image accepted for asynchronous processing." + }, + "400": { + "description": "Invalid input provided." + }, + "401": { + "description": "Unauthorized." + }, + "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, + "description": "Insufficient credits or quota." + }, + "403": { + "description": "This account does not have access to video generation." + }, + "404": { + "description": "The image was not found or is not readable." + }, + "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, + "description": "Too many requests." + }, + "503": { + "description": "The endpoint is temporarily unavailable." + } + }, + "summary": "Turn a still image into a subtle looping video", + "tags": [ + "video-generate" + ], + "x-openapi-router-controller": "external_api.generated.openapi.controllers.video_generate_controller" + } + }, "/v2/tool/material-swap": { "post": { - "description": "Re-renders the masked regions of the product photo in the materials\nshown by the reference images — matching each one's color, texture,\npattern scale, and orientation — while preserving the product's\nsilhouette, construction, seams, and shading, and keeping every region\noutside the masks unchanged.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n\nSupply the product photo, the masks marking the regions to\nre-material, and the material reference images as raw bytes (`image`,\n`masks`, and `materials`) via `multipart/form-data` — up to 4 masks; a\nsingle-region edit is a one-item list. Every mask must have the same\npixel dimensions as the product photo. White pixels mark the region to\nchange; black pixels are preserved. Alpha-only masks are also\nsupported: opaque pixels mark the region to change and transparent\npixels are preserved. Send either one material, which every mask\ntakes, or exactly one material per mask, paired by position.\n", + "description": "Re-renders masked regions of a product photo in the materials shown in\nreference images, preserving the product's construction and everything\noutside the masks. Upload the `image`, up to 4 `masks`, and the\n`materials` using `multipart/form-data`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}` or\nsupply a `webhook_url`.\n", "operationId": "post_material_swap", "parameters": [ { @@ -12068,7 +12299,7 @@ "description": "Too many requests." } }, - "summary": "Product Material Change", + "summary": "Material Swap", "tags": [ "edit-workflow" ], @@ -12077,7 +12308,7 @@ }, "/v2/tool/model-pose-variants": { "post": { - "description": "Changes the model's pose or camera presentation while preserving the\nsource model, garment, styling, and scene. An optional pose-reference\nimage supplies body pose and gaze only; it does not supply identity,\nclothing, or styling.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n\nSupply the source as either an `AssetIdentifier` reference\n(`source_asset_identifier`) or raw image bytes (`source_image`,\nmultipart requests only). Provide exactly one source form; supplying\nboth, or neither, is rejected with a 400.\n", + "description": "Changes the model's pose or camera angle in a fashion image while\npreserving the model, garment, styling, and scene. Upload the\n`source_image` using `multipart/form-data` and describe the new pose in\n`instruction`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}` or\nsupply a `webhook_url`.\n", "operationId": "post_model_pose_variants", "requestBody": { "content": { @@ -12100,7 +12331,7 @@ } } }, - "description": "The fashion image to edit, explicit pose direction, and optional pose-reference image. Use `multipart/form-data` to upload `source_image` bytes or `application/json` (or multipart with the asset-identifier fields) to reference existing assets.", + "description": "The fashion image to edit and the pose direction.", "required": true, "x-body-name": "body" }, @@ -12151,7 +12382,7 @@ "description": "Too many requests." } }, - "summary": "Generate pose variants of a fashion image", + "summary": "Model Pose Variants", "tags": [ "edit-workflow" ], @@ -12160,7 +12391,7 @@ }, "/v2/tool/model-swap": { "post": { - "description": "Re-casts a fashion commerce image with the identity shown in one or\nmore ordered target-model references. The workflow uses the working\nimage for the product, pose, scene, lighting, framing, and camera, and\nuses the target references only for identity, hair, skin tone, and body\nproportions. Results are full-frame edits; exact pixel preservation is\nnot guaranteed.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n", + "description": "Replaces the model in a fashion image with the person shown in one to\nfour target-model references, keeping the product, pose, scene,\nlighting, and framing. Upload the working image as `source_image` using\n`multipart/form-data`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}` or\nsupply a `webhook_url`.\n", "operationId": "post_model_swap", "requestBody": { "content": { @@ -12183,7 +12414,7 @@ } } }, - "description": "Supply exactly one working-image transport: an existing `source_asset_identifier`, or raw `source_image` bytes in a multipart request. Target-model references must be existing readable assets and remain in the order supplied.", + "description": "The working image and one to four ordered target-model references.", "required": true, "x-body-name": "body" }, @@ -12234,7 +12465,7 @@ "description": "Too many requests." } }, - "summary": "Replace the model in a commerce image", + "summary": "Model Swap", "tags": [ "edit-workflow" ], @@ -12243,7 +12474,7 @@ }, "/v2/tool/packshots": { "post": { - "description": "Creates one polished product photograph from one or more ordered product\nreferences. An optional style reference may guide framing, crop,\nbackground, and lighting without changing the product's identity.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed. Product fidelity is\nbest-effort and details absent from every reference may be reconstructed.\n", + "description": "Creates one polished product photograph from one or more ordered product\nreferences. An optional style reference may guide framing, crop,\nbackground, and lighting without changing the product's identity.\n\nThe request is processed asynchronously. Poll\n`GET /v2/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed. Product fidelity is\nbest-effort and details absent from every reference may be reconstructed.\n", "operationId": "post_packshots", "requestBody": { "content": { @@ -12298,7 +12529,7 @@ "description": "Too many requests." } }, - "summary": "Create marketplace-ready product packshots", + "summary": "Packshots", "tags": [ "edit-workflow" ], @@ -12307,7 +12538,7 @@ }, "/v2/tool/product-360-video": { "post": { - "description": "Animates one product image through a complete turntable revolution and returns to the starting pose so the result loops cleanly.\nVideo generation runs asynchronously. Poll `GET /v1/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails.", + "description": "Animates one product image through a complete turntable revolution and returns to the starting pose so the result loops cleanly.\nVideo generation runs asynchronously. Poll `GET /v2/generations/{generation_id}` with the returned `generation_id` until the generation completes or fails.", "operationId": "post_product360_video", "parameters": [ { @@ -12383,7 +12614,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Create a looping 360-degree product video", + "summary": "Product 360 Video", "tags": [ "video-generate" ], @@ -12392,7 +12623,7 @@ }, "/v2/tool/skechers-style-editor": { "post": { - "description": "Edits the base image while preserving details the instruction does not\nchange. Image 1 is the base; reference images are numbered from image 2\nin the supplied order. Resolve image mentions to these numbers before\nsubmitting. Descriptions identify the selected view or reference.\n\nPoll GET /v1/generations/{generation_id} with the returned generation_id\nuntil the workflow completes or fails.\n", + "description": "Edits the base image while preserving details the instruction does not\nchange. Image 1 is the base; reference images are numbered from image 2\nin the supplied order. Resolve image mentions to these numbers before\nsubmitting. Descriptions identify the selected view or reference.\n\nPoll GET /v2/generations/{generation_id} with the returned generation_id\nuntil the workflow completes or fails.\n", "operationId": "post_skechers_style_edit", "requestBody": { "content": { @@ -12423,6 +12654,13 @@ "description": "Unauthorized." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "403": { @@ -12435,6 +12673,13 @@ "description": "The instruction or image descriptions did not pass prompt safety checks." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." } }, @@ -12447,7 +12692,7 @@ }, "/v2/tool/sketch-to-render": { "post": { - "description": "Converts one fashion sketch into photorealistic garment or product\nimagery while preserving its silhouette, construction, colors, and\nvisible design details.\n\nThe request runs asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n\nSupply exactly one sketch transport: an existing `AssetIdentifier` in\n`sketch_asset_identifier`, or raw `sketch_image` bytes in a multipart\nrequest. Supplying both or neither is rejected with a 400.\n", + "description": "Turns a fashion sketch into photorealistic garment or product imagery,\npreserving its silhouette, construction, colors, and design details.\nUpload the `sketch_image` using `multipart/form-data` and describe\nmaterials and rendering in `instruction`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}` or\nsupply a `webhook_url`.\n", "operationId": "post_sketch_to_render", "requestBody": { "content": { @@ -12518,7 +12763,7 @@ "description": "Too many requests." } }, - "summary": "Render a fashion sketch as product photography", + "summary": "Sketch to Render", "tags": [ "edit-workflow" ], @@ -12527,7 +12772,7 @@ }, "/v2/tool/sole-swap": { "post": { - "description": "Uses the sole-donor shoe as the output canvas, preserving its sole, camera,\nbackground, and lighting while transferring the upper from ordered references.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned\n`generation_id` until the generation is completed or failed.\n", + "description": "Uses the sole-donor shoe as the output canvas, preserving its sole, camera,\nbackground, and lighting while transferring the upper from ordered references.\n\nThe request is processed asynchronously. Poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id` until the generation is completed or failed.\n", "operationId": "post_sole_swap", "requestBody": { "content": { @@ -12587,7 +12832,7 @@ "description": "Too many requests." } }, - "summary": "Transfer a shoe upper onto a preserved sole", + "summary": "Sole Swap", "tags": [ "edit-workflow" ], @@ -12596,7 +12841,7 @@ }, "/v2/tool/swan-s-logo-design": { "post": { - "description": "Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed.", + "description": "Creates one isolated logo candidate using either a shoe swatch or a supplied style reference. For 3D reference designs, choose split or full coverage with design_variant. Send a separate request for each candidate; each request completes and is billed independently. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed.", "operationId": "post_swan_s_logo_design", "requestBody": { "content": { @@ -12633,9 +12878,23 @@ "description": "An input asset was not found or is not readable." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." } }, @@ -12648,7 +12907,7 @@ }, "/v2/tool/swan-s-logo-install": { "post": { - "description": "Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v1/generations/{generation_id} until completed or failed.", + "description": "Installs the selected logo onto the ordered shoe views, preserving the shoe and chosen camera framing. Processing is asynchronous. Poll GET /v2/generations/{generation_id} until completed or failed.", "operationId": "post_swan_s_logo_install", "requestBody": { "content": { @@ -12685,9 +12944,23 @@ "description": "An input asset was not found or is not readable." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." } }, @@ -12700,7 +12973,7 @@ }, "/v2/tool/swap-product": { "post": { - "description": "Edits the footwear in a source advertisement using ordered product references.\nPoll `GET /v1/generations/{generation_id}` for status and image results.\n", + "description": "Edits the footwear in a source advertisement using ordered product references.\nPoll `GET /v2/generations/{generation_id}` for status and image results.\n", "operationId": "post_swap_product", "requestBody": { "content": { @@ -12740,13 +13013,27 @@ "description": "The instruction did not pass safety checks." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." } }, - "summary": "Replace or recolor footwear in an advertisement", + "summary": "Swap Product", "tags": [ "edit-workflow" ], @@ -12755,7 +13042,7 @@ }, "/v2/video/edit/seedance-2": { "post": { - "description": "Edit a video you already have stored with Ideogram by replacing part of\nit. Reference the source video with `video_asset_identifier` and mark the\nspan to replace with `start_frame_time` and `end_frame_time`, in seconds.\nSeedance 2.0 generates a new clip for that span from your prompt, and the\nresult is the source video with the generated clip spliced in over the\nspan: everything before `start_frame_time`, then the generated clip, then\neverything from `end_frame_time` on. That edited video is the asset the\nrequest produces.\n\n`is_start_frame_included` and `is_end_frame_included` anchor the generated\nclip on the span's own end frames, so it joins the surrounding footage\ninstead of cutting to something unrelated. Anchoring the start opens the\nclip on the frame already at `start_frame_time`; anchoring the end lands\nit on the frame at `end_frame_time`; anchoring both joins at each seam. At\nleast one must be anchored.\n\nThe generated clip is used at its own length, which the model rarely makes\nexactly the span's, so the edited video is usually a different length from\nthe source. Request a `duration` close to the span to keep them near each\nother. The clip is scaled and cropped to fill the source's frame and\nconformed to its frame rate, so resolution and aspect ratio follow the\nsource rather than being requested.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Edit a video you already have stored with Ideogram by replacing part of\nit. Reference the source video with `video_asset_identifier` and mark the\nspan to replace with `start_frame_time` and `end_frame_time`, in seconds.\nSeedance 2.0 generates a new clip for that span from your prompt, and the\nresult is the source video with the generated clip spliced in over the\nspan: everything before `start_frame_time`, then the generated clip, then\neverything from `end_frame_time` on. That edited video is the asset the\nrequest produces.\n\n`is_start_frame_included` and `is_end_frame_included` anchor the generated\nclip on the span's own end frames, so it joins the surrounding footage\ninstead of cutting to something unrelated. Anchoring the start opens the\nclip on the frame already at `start_frame_time`; anchoring the end lands\nit on the frame at `end_frame_time`; anchoring both joins at each seam. At\nleast one must be anchored.\n\nThe generated clip is used at its own length, which the model rarely makes\nexactly the span's, so the edited video is usually a different length from\nthe source. Request a `duration` close to the span to keep them near each\nother. The clip is scaled and cropped to fill the source's frame and\nconformed to its frame rate, so resolution and aspect ratio follow the\nsource rather than being requested.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v2/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", "operationId": "post_edit_video_seed_dance2", "parameters": [ { @@ -12790,7 +13077,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -12799,6 +13086,13 @@ "description": "Unauthorized." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "403": { @@ -12811,6 +13105,13 @@ "description": "The prompt did not pass safety checks." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." }, "500": { @@ -12820,7 +13121,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Edit a video with Seedance 2.0 by regenerating from frames of it", + "summary": "Edit video with Seedance 2.0", "tags": [ "video-edit" ], @@ -12829,7 +13130,7 @@ }, "/v2/video/generate/kling-3-standard-image-to-video": { "post": { - "description": "Generate a video from a first-frame image and a text prompt with Kling\nv3 Standard. Supply the first frame either as an\n`image_asset_identifier` reference (an image already stored with\nIdeogram) or as raw `image` bytes (multipart requests only) — callers\nare never required to upload the asset first. Exactly one source is\nrequired; supplying neither or both is rejected. Only image assets are\naccepted as a first frame. Uploaded bytes are used for this request\nonly and are not stored as an asset.\n\nTo generate a transition between two stills, supply a final frame as\nwell, in either of the same two forms: `end_image_asset_identifier` or\n`end_image`. The final frame is optional and follows the same\none-form-only rule.\n\nThe generated video takes its aspect ratio from the first frame, so\nthere is no aspect ratio to set.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Generate a video from a first-frame image and a text prompt with Kling\nv3 Standard. Upload the first frame as `image`, and optionally a final\nframe as `end_image`, using `multipart/form-data`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_generate_video_kling_v3_standard_image_to_video", "parameters": [ { @@ -12864,7 +13165,7 @@ } } }, - "description": "A request to generate a video from a first-frame image with Kling v3 Standard. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to generate a video from a first-frame image with Kling v3 Standard. Upload the first frame as `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -12877,7 +13178,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -12899,7 +13200,7 @@ "description": "This account does not have access to this model." }, "404": { - "description": "The referenced first-frame asset was not found." + "description": "The first-frame image was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -12921,7 +13222,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate a video from a first frame with Kling v3 Standard, by asset id or by uploaded bytes", + "summary": "Image to video with Kling v3 Standard", "tags": [ "video-generate" ], @@ -12930,7 +13231,7 @@ }, "/v2/video/generate/kling-3-standard-text-to-video": { "post": { - "description": "Generate a video from a text prompt with Kling v3 Standard.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Generate a video from a text prompt with Kling v3 Standard.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_generate_video_kling_v3_standard_text_to_video", "parameters": [ { @@ -12965,7 +13266,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -13006,7 +13307,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate a video from a text prompt with Kling v3 Standard", + "summary": "Text to video with Kling v3 Standard", "tags": [ "video-generate" ], @@ -13015,7 +13316,7 @@ }, "/v2/video/generate/minimax-h3-image-to-video": { "post": { - "description": "Generate a video from a first-frame image and a text prompt with\nMiniMax H3. Supply the first frame either as an\n`image_asset_identifier` reference (an image already stored with\nIdeogram) or as raw `image` bytes (multipart requests only) — callers\nare never required to upload the asset first. Exactly one source is\nrequired; supplying neither or both is rejected. Only image assets are\naccepted as a first frame. Uploaded bytes are used for this request\nonly and are not stored as an asset.\n\nTo generate a transition between two stills, supply a final frame as\nwell, in either of the same two forms: `end_image_asset_identifier` or\n`end_image`. The final frame is optional and follows the same\none-form-only rule.\n\nThe generated video takes its aspect ratio from the first frame, so\nthis endpoint accepts no `aspect_ratio`.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Generate a video from a first-frame image and a text prompt with\nMiniMax H3. Upload the first frame as `image`, and optionally a final\nframe as `end_image`, using `multipart/form-data`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_generate_video_minimax_h3_image_to_video", "parameters": [ { @@ -13050,7 +13351,7 @@ } } }, - "description": "A request to generate a video from a first-frame image with MiniMax H3. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to generate a video from a first-frame image with MiniMax H3. Upload the first frame as `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -13063,7 +13364,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -13085,7 +13386,7 @@ "description": "This account does not have access to this model." }, "404": { - "description": "The referenced first-frame asset was not found." + "description": "The first-frame image was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -13107,7 +13408,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate a video from a first frame with MiniMax H3, by asset id or by uploaded bytes", + "summary": "Image to video with MiniMax H3", "tags": [ "video-generate" ], @@ -13116,7 +13417,7 @@ }, "/v2/video/generate/minimax-h3-reference-to-video": { "post": { - "description": "Produce a video from a text prompt and reference media with MiniMax H3.\n\nThe prompt addresses the references by position: the first reference\nimage is `Image 1`, the second `Image 2`, the first reference video is\n`Video 1`, and the first reference audio is `Audio 1`. Supply reference\nimages either as\n`reference_image_asset_identifiers` (images already stored with\nIdeogram) or as raw `reference_images` bytes (multipart requests only);\nsupplying both is rejected, and uploaded bytes are used for this request\nonly and are not stored as an asset. Supply reference videos as\n`reference_video_asset_identifiers`, which must reference videos\ngenerated or uploaded with Ideogram. At most 9 reference images and 3 reference\nvideos are accepted, and reference videos are capped again on clip\nlength. Optional `reference_audios` accepts MP3/WAV uploads alongside\nan image or video. Audio and video references must total at most 15\nseconds; at most 12 references are accepted across all media.\n\nReferences are optional. With none, the video is produced from the\nprompt alone.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Produce a video from a text prompt and optional reference media with\nMiniMax H3. Upload `reference_images` and `reference_audios` using\n`multipart/form-data`, and address them in the prompt by position\n(`Image 1`, `Audio 1`, …). Returns a `generation_id`; poll\n`GET /v2/generations/{generation_id}` or supply a `webhook_url`.\n", "operationId": "post_edit_video_minimax_h3_reference_to_video", "parameters": [ { @@ -13151,7 +13452,7 @@ } } }, - "description": "A request to produce a video from reference media with MiniMax H3. Use `multipart/form-data` to upload `reference_images` bytes directly, or `application/json` (or multipart with the asset identifier fields) to reference existing assets instead.", + "description": "A request to produce a video from reference media with MiniMax H3. Use `multipart/form-data` to upload reference media.", "required": true, "x-body-name": "body" }, @@ -13164,7 +13465,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -13173,6 +13474,13 @@ "description": "Unauthorized." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "403": { @@ -13185,6 +13493,13 @@ "description": "The prompt did not pass safety checks." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." }, "500": { @@ -13194,7 +13509,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Produce a video from reference media with MiniMax H3", + "summary": "Reference to video with MiniMax H3", "tags": [ "video-edit" ], @@ -13203,7 +13518,7 @@ }, "/v2/video/generate/minimax-h3-text-to-video": { "post": { - "description": "Generate a video from a text prompt with MiniMax H3.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Generate a video from a text prompt with MiniMax H3.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_generate_video_minimax_h3_text_to_video", "parameters": [ { @@ -13238,7 +13553,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -13279,7 +13594,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate a video from a text prompt with MiniMax H3", + "summary": "Text to video with MiniMax H3", "tags": [ "video-generate" ], @@ -13288,7 +13603,7 @@ }, "/v2/video/generate/seedance-2-5-image-to-video": { "post": { - "description": "Generate a video from a first-frame image and a text prompt with\nSeedance 2.5. Supply the first frame either as an\n`image_asset_identifier` reference (an image already stored with\nIdeogram) or as raw `image` bytes (multipart requests only) — callers\nare never required to upload the asset first. Exactly one source is\nrequired; supplying neither or both is rejected. Only image assets are\naccepted as a first frame. Uploaded bytes are used for this request\nonly and are not stored as an asset.\n\nTo generate a transition between two stills, supply a final frame as\nwell, in either of the same two forms: `end_image_asset_identifier` or\n`end_image`. The final frame is optional and follows the same\none-form-only rule.\n\nSeedance 2.5 always derives an image-to-video result's aspect ratio\nfrom its first frame, so this endpoint takes no `aspect_ratio`.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Generate a video from a first-frame image and a text prompt with\nSeedance 2.5. Upload the first frame as `image`, and optionally a final\nframe as `end_image`, using `multipart/form-data`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_generate_video_seed_dance25_image_to_video", "parameters": [ { @@ -13323,7 +13638,7 @@ } } }, - "description": "A request to generate a video from a first-frame image with Seedance 2.5. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to generate a video from a first-frame image with Seedance 2.5. Upload the first frame as `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -13336,7 +13651,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -13358,7 +13673,7 @@ "description": "This account does not have access to this model." }, "404": { - "description": "The referenced first-frame asset was not found." + "description": "The first-frame image was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -13380,7 +13695,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate a video from a first frame with Seedance 2.5, by asset id or by uploaded bytes", + "summary": "Image to video with Seedance 2.5", "tags": [ "video-generate" ], @@ -13389,7 +13704,7 @@ }, "/v2/video/generate/seedance-2-5-reference-to-video": { "post": { - "description": "Produce a video from a text prompt and reference media with\nSeedance 2.5.\n\nThe prompt addresses the references by position: the first reference\nimage is `[Image1]`, the second\n`[Image2]`, the first reference video is\n`[Video1]`, and so on. Supply reference images\neither as `reference_image_asset_identifiers` (images already stored\nwith Ideogram) or as raw `reference_images` bytes (multipart requests\nonly); supplying both is rejected, and uploaded bytes are used for this\nrequest only and are not stored as an asset. Supply reference videos as\n`reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 10\nreference videos are accepted, and reference videos are capped again on\nclip length: each clip must be between 2 and 30 seconds long, and the clips must total no more than 30 seconds.\nSupply up to 10 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.\nEach audio clip must be 2–30 seconds, with at most 30 seconds total. Reference\nthem as `[Audio1]`, `[Audio2]`, and so on. Audio is used for this request only.\n\nAt least one reference image or video is required: the model\nconditions every generation on the media it is given, so a request\nwith no references is rejected.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Generate a video from a text prompt and reference media with\nSeedance 2.5. Upload at least one image in `reference_images`, plus optional\n`reference_audios`, using `multipart/form-data`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_generate_video_seed_dance25_reference_to_video", "parameters": [ { @@ -13424,7 +13739,7 @@ } } }, - "description": "A request to produce a video from reference media with Seedance 2.5. Use `multipart/form-data` to upload `reference_images` bytes directly, or `application/json` (or multipart with the asset identifier fields) to reference existing assets instead.", + "description": "A request to produce a video from reference media with Seedance 2.5. Upload the references using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -13437,7 +13752,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -13446,18 +13761,32 @@ "description": "Unauthorized." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "403": { "description": "This account does not have access to this model." }, "404": { - "description": "A referenced asset was not found." + "description": "A reference was not found." }, "422": { "description": "The prompt did not pass safety checks." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." }, "500": { @@ -13467,7 +13796,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Produce a video from reference images and videos with Seedance 2.5", + "summary": "Reference to video with Seedance 2.5", "tags": [ "video-generate" ], @@ -13476,7 +13805,7 @@ }, "/v2/video/generate/seedance-2-5-text-to-video": { "post": { - "description": "Generate a video from a text prompt with Seedance 2.5, which serves\nresolutions up to 1080p and durations up to 30 seconds.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Generate a video from a text prompt with Seedance 2.5, at up to 1080p and\n30 seconds. Returns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_generate_video_seed_dance25_text_to_video", "parameters": [ { @@ -13511,7 +13840,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -13552,7 +13881,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate a video from a text prompt with Seedance 2.5", + "summary": "Text to video with Seedance 2.5", "tags": [ "video-generate" ], @@ -13561,7 +13890,7 @@ }, "/v2/video/generate/seedance-2-image-to-video": { "post": { - "description": "Generate one or more videos from a first-frame image and a text prompt\nwith Seedance 2.0. Supply the first frame either as an\n`image_asset_identifier` reference (an image already stored with\nIdeogram) or as raw `image` bytes (multipart requests only) — callers\nare never required to upload the asset first. Exactly one source is\nrequired; supplying neither or both is rejected. Only image assets are\naccepted as a first frame. Uploaded bytes are used for this request\nonly and are not stored as an asset.\n\nTo generate a transition between two stills, supply a final frame as\nwell, in either of the same two forms: `end_image_asset_identifier` or\n`end_image`. The final frame is optional, follows the same one-form-only\nrule, and requires a first frame.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Generate one or more videos from a first-frame image and a text prompt\nwith Seedance 2.0. Upload the first frame as `image`, and optionally a final\nframe as `end_image`, using `multipart/form-data`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_generate_video_seed_dance2_image_to_video", "parameters": [ { @@ -13596,7 +13925,7 @@ } } }, - "description": "A request to generate videos from a first-frame image with Seedance 2.0. Use `multipart/form-data` to upload `image` bytes directly, or `application/json` (or multipart with `image_asset_identifier`) to reference an existing asset instead.", + "description": "A request to generate videos from a first-frame image with Seedance 2.0. Upload the first frame as `image` using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -13609,7 +13938,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -13631,7 +13960,7 @@ "description": "This account does not have access to this model." }, "404": { - "description": "The referenced first-frame asset was not found." + "description": "The first-frame image was not found." }, "422": { "description": "The prompt did not pass safety checks." @@ -13653,7 +13982,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate a video from a first frame with Seedance 2.0, by asset id or by uploaded bytes", + "summary": "Image to video with Seedance 2.0", "tags": [ "video-generate" ], @@ -13662,7 +13991,7 @@ }, "/v2/video/generate/seedance-2-reference-to-video": { "post": { - "description": "Produce a video from a text prompt and reference media with\nSeedance 2.0.\n\nThe prompt addresses the references by position: the first reference\nimage is `@Image1`, the second\n`@Image2`, the first reference video is\n`@Video1`, and so on. Supply reference images\neither as `reference_image_asset_identifiers` (images already stored\nwith Ideogram) or as raw `reference_images` bytes (multipart requests\nonly); supplying both is rejected, and uploaded bytes are used for this\nrequest only and are not stored as an asset. Supply reference videos as\n`reference_video_asset_identifiers`, which can reference uploaded or generated videos. At most 9 reference images and 3\nreference videos are accepted, and reference videos are capped again on\nclip length: each clip must be between 2 and 15 seconds long, and the clips must total no more than 15 seconds.\nSupply up to 3 MP3/WAV `reference_audios` as multipart files, at most 15 MB each.\nEach audio clip must be 2–15 seconds, with at most 15 seconds total. Reference\nthem as `@Audio1`, `@Audio2`, and so on. Audio is used for this request only.\nImages, videos, and audio combined must not exceed 12 references.\n\nAt least one reference image or video is required: the model\nconditions every generation on the media it is given, so a request\nwith no references is rejected.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Generate a video from a text prompt and reference media with\nSeedance 2.0. Upload at least one image in `reference_images`, plus optional\n`reference_audios`, using `multipart/form-data`.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_generate_video_seed_dance2_reference_to_video", "parameters": [ { @@ -13697,7 +14026,7 @@ } } }, - "description": "A request to produce a video from reference media with Seedance 2.0. Use `multipart/form-data` to upload `reference_images` bytes directly, or `application/json` (or multipart with the asset identifier fields) to reference existing assets instead.", + "description": "A request to produce a video from reference media with Seedance 2.0. Upload the references using `multipart/form-data`.", "required": true, "x-body-name": "body" }, @@ -13710,7 +14039,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -13719,18 +14048,32 @@ "description": "Unauthorized." }, "402": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Insufficient credits or quota." }, "403": { "description": "This account does not have access to this model." }, "404": { - "description": "A referenced asset was not found." + "description": "A reference was not found." }, "422": { "description": "The prompt did not pass safety checks." }, "429": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerationErrorResponse" + } + } + }, "description": "Too many requests." }, "500": { @@ -13740,7 +14083,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Produce a video from reference images and videos with Seedance 2.0", + "summary": "Reference to video with Seedance 2.0", "tags": [ "video-generate" ], @@ -13749,7 +14092,7 @@ }, "/v2/video/generate/seedance-2-text-to-video": { "post": { - "description": "Generate one or more videos from a text prompt with Seedance 2.0.\n\nVideo generation always runs asynchronously: the response returns as\nsoon as the request is accepted and carries only a `generation_id`.\nPoll for completion and results with\n`GET /v1/generations/{generation_id}` using that id, or supply a\n`webhook_url` to have the finished result POSTed to your server\ninstead.\n\nVideo links are available for a limited period of time; download the\nvideo if you want to keep it.\n", + "description": "Generate one or more videos from a text prompt with Seedance 2.0.\nReturns a `generation_id`; poll `GET /v2/generations/{generation_id}`\nor supply a `webhook_url`.\n", "operationId": "post_generate_video_seed_dance2_text_to_video", "parameters": [ { @@ -13784,7 +14127,7 @@ } } }, - "description": "An acknowledgement to poll with `GET /v1/generations/{generation_id}`." + "description": "An acknowledgement to poll with `GET /v2/generations/{generation_id}`." }, "400": { "description": "Invalid input provided." @@ -13825,7 +14168,7 @@ "description": "The endpoint is temporarily unavailable." } }, - "summary": "Generate a video from a text prompt with Seedance 2.0", + "summary": "Text to video with Seedance 2.0", "tags": [ "video-generate" ], @@ -13834,7 +14177,7 @@ }, "/v2/workflow/lookbook": { "post": { - "description": "Creates polished fashion product imagery from one or more product\nreferences and an aesthetic reference. Each generated shoot is returned\nas four individual lookbook images.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n", + "description": "Creates polished fashion product imagery from one or more product\nreferences and an aesthetic reference. Each generated shoot is returned\nas four individual lookbook images.\n\nThe request is processed asynchronously. Poll\n`GET /v2/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n", "operationId": "post_lookbook", "requestBody": { "content": { @@ -13898,7 +14241,7 @@ }, "/v2/workflow/precise-masked-edit": { "post": { - "description": "Applies an instruction to an image. When a mask is supplied, it identifies\nthe primary edit region. Without a mask, the model edits the full image.\nOptional reference images can guide the requested appearance. Set\n`preserve_unmasked_pixels` to keep decoded pixels outside a supplied mask\nunchanged in the final image.\n\nThe request runs asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n", + "description": "Applies an instruction to an image. When a mask is supplied, it identifies\nthe primary edit region. Without a mask, the model edits the full image.\nOptional reference images can guide the requested appearance. Set\n`preserve_unmasked_pixels` to keep decoded pixels outside a supplied mask\nunchanged in the final image.\n\nThe request runs asynchronously. Poll\n`GET /v2/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n", "operationId": "post_precise_masked_edit", "requestBody": { "content": { @@ -13984,7 +14327,7 @@ }, "/v2/workflow/virtual-try-on": { "post": { - "description": "Generates a photorealistic image of the person in the supplied photo\nwearing the supplied garments, preserving their face, body, and\nbackground.\n\nThe request is processed asynchronously. Poll\n`GET /v1/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n\nSupply the person as either an `AssetIdentifier` reference\n(`person_asset_identifier`) or the raw image bytes directly\n(`person_image`, multipart requests only), and likewise the garments as\neither `garment_asset_identifiers` or `garment_images`. For each of the\ntwo sources, provide exactly one of the two forms; supplying both, or\nneither, is rejected with a 400.\n", + "description": "Generates a photorealistic image of the person in the supplied photo\nwearing the supplied garments, preserving their face, body, and\nbackground.\n\nThe request is processed asynchronously. Poll\n`GET /v2/generations/{generation_id}` with the returned `generation_id`\nuntil the generation is completed or failed.\n\nSupply the person as either an `AssetIdentifier` reference\n(`person_asset_identifier`) or the raw image bytes directly\n(`person_image`, multipart requests only), and likewise the garments as\neither `garment_asset_identifiers` or `garment_images`. For each of the\ntwo sources, provide exactly one of the two forms; supplying both, or\nneither, is rejected with a 400.\n", "operationId": "post_virtual_try_on", "requestBody": { "content": { @@ -14145,15 +14488,7 @@ "properties": { "text_prompt": { "description": "A natural-language prompt for image generation. When supplied,\nmagic-prompt is enabled automatically. Mutually exclusive with\n`json_prompt`.\n", - "type": "string", - "x-playground-field": { - "label": "Text prompt", - "control": "textarea", - "order": 1, - "group": "prompt", - "default": "A cinematic product shot of a tabby cat sleeping on a modern couch, soft daylight, rich texture, highly detailed.", - "placeholder": "Describe the image you want to generate." - } + "type": "string" }, "json_prompt": { "allOf": [ @@ -14161,38 +14496,21 @@ "$ref": "#/components/schemas/V4JsonPrompt" } ], - "description": "A structured prompt that conforms to the Ideogram 4.0 JSON\ncontract. When supplied, magic-prompt is disabled and the\nstructured prompt is consumed by the diffusion model directly.\nMutually exclusive with `text_prompt`.\n", - "x-playground-field": { - "label": "JSON prompt", - "control": "json", - "order": 1, - "group": "prompt", - "default": "{\n \"high_level_description\": \"A playful product photo of a tabby cat napping on a bright modern couch.\",\n \"style_description\": {\n \"art_style\": \"photorealistic\",\n \"lighting\": \"soft afternoon sunlight from a large window\"\n },\n \"compositional_deconstruction\": {\n \"background\": \"A bright living room with neutral walls and leafy plants.\",\n \"elements\": [\n { \"type\": \"obj\", \"bbox\": [240, 260, 700, 760], \"desc\": \"A curled-up brown tabby cat sleeping on the center cushion.\" }\n ]\n }\n}\n", - "placeholder": "Paste a V4 JSON prompt." - } + "description": "A structured prompt that conforms to the Ideogram 4.0 JSON\ncontract. When supplied, magic-prompt is disabled and the\nstructured prompt is consumed by the diffusion model directly.\nMutually exclusive with `text_prompt`.\n" }, "seed": { "description": "Random seed for reproducibility.", "nullable": true, - "type": "integer", - "x-playground-field": { - "hidden": true - } + "type": "integer" }, "magic_prompt_system_prompt_config_id": { "description": "A base64url-encoded magic prompt system prompt config ID to use\nfor this request. Honored when `text_prompt` is supplied. Ignored\nwhen `json_prompt` is supplied.\n", - "type": "string", - "x-playground-field": { - "hidden": true - } + "type": "string" }, "custom_model_uri": { "description": "A custom model URI in the format model//version/.\nWhen provided, the model version and style will be resolved from this URI.\n", "example": "model/my-custom-model/version/0", - "type": "string", - "x-playground-field": { - "hidden": true - } + "type": "string" }, "resolution": { "$ref": "#/components/schemas/ResolutionV4" @@ -14203,32 +14521,12 @@ "$ref": "#/components/schemas/RenderingSpeed" } ], - "description": "The rendering speed to use. For Ideogram V4, `rendering_speed=FLASH`\nis coming soon; requests with `rendering_speed=FLASH` currently\nreturn a 400.\n", - "x-playground-field": { - "label": "Rendering speed", - "order": 3, - "default": "DEFAULT", - "enum_subset": [ - "DEFAULT", - "TURBO", - "QUALITY" - ], - "labels": { - "DEFAULT": "Default", - "TURBO": "Turbo", - "QUALITY": "Quality" - } - } + "description": "The rendering speed to use. For Ideogram V4, `rendering_speed=FLASH`\nis coming soon; requests with `rendering_speed=FLASH` currently\nreturn a 400.\n" }, "enable_copyright_detection": { "description": "Optional. Opt this request into post-generation copyright detection (Hive likeness + logo\nchecks). The effective gate is the OR of this field and the organization's\n`copyright_detection_enabled` setting on `/api`. See GenerateImageRequestV3 for details.\n", "nullable": true, - "type": "boolean", - "x-playground-field": { - "label": "Copyright detection", - "order": 4, - "default": false - } + "type": "boolean" } }, "type": "object" @@ -14302,15 +14600,7 @@ "properties": { "text_prompt": { "description": "A natural-language prompt for image generation. When supplied,\nmagic-prompt is enabled automatically. Mutually exclusive with\n`json_prompt`.\n", - "type": "string", - "x-playground-field": { - "label": "Text prompt", - "control": "textarea", - "order": 1, - "group": "prompt", - "default": "A cinematic product shot of a tabby cat sleeping on a modern couch, soft daylight, rich texture, highly detailed.", - "placeholder": "Describe the image you want to generate." - } + "type": "string" }, "json_prompt": { "allOf": [ @@ -14318,29 +14608,16 @@ "$ref": "#/components/schemas/V4JsonPrompt" } ], - "description": "A structured prompt that conforms to the Ideogram 4.0 JSON\ncontract. When supplied, magic-prompt is disabled and the\nstructured prompt is consumed by the diffusion model directly.\nMutually exclusive with `text_prompt`.\n", - "x-playground-field": { - "label": "JSON prompt", - "control": "json", - "order": 1, - "group": "prompt", - "placeholder": "Paste a V4 JSON prompt." - } + "description": "A structured prompt that conforms to the Ideogram 4.0 JSON\ncontract. When supplied, magic-prompt is disabled and the\nstructured prompt is consumed by the diffusion model directly.\nMutually exclusive with `text_prompt`.\n" }, "seed": { "description": "Random seed for reproducibility.", "nullable": true, - "type": "integer", - "x-playground-field": { - "hidden": true - } + "type": "integer" }, "magic_prompt_system_prompt_config_id": { "description": "A base64url-encoded magic prompt system prompt config ID to use\nfor this request. Honored when `text_prompt` is supplied. Ignored\nwhen `json_prompt` is supplied.\n", - "type": "string", - "x-playground-field": { - "hidden": true - } + "type": "string" }, "resolution": { "$ref": "#/components/schemas/ResolutionV4" @@ -14351,32 +14628,12 @@ "$ref": "#/components/schemas/RenderingSpeed" } ], - "description": "The rendering speed to use. For Ideogram V4, `rendering_speed=FLASH`\nis coming soon; requests with `rendering_speed=FLASH` currently\nreturn a 400.\n", - "x-playground-field": { - "label": "Rendering speed", - "order": 3, - "default": "DEFAULT", - "enum_subset": [ - "DEFAULT", - "TURBO", - "QUALITY" - ], - "labels": { - "DEFAULT": "Default", - "TURBO": "Turbo", - "QUALITY": "Quality" - } - } + "description": "The rendering speed to use. For Ideogram V4, `rendering_speed=FLASH`\nis coming soon; requests with `rendering_speed=FLASH` currently\nreturn a 400.\n" }, "enable_copyright_detection": { "description": "Optional. Opt this request into post-generation copyright detection (Hive likeness + logo\nchecks). The effective gate is the OR of this field and the organization's\n`copyright_detection_enabled` setting on `/api`. See GenerateImageRequestV3 for details.\n", "nullable": true, - "type": "boolean", - "x-playground-field": { - "label": "Copyright detection", - "order": 4, - "default": false - } + "type": "boolean" } }, "type": "object" @@ -14386,15 +14643,7 @@ "properties": { "text_prompt": { "description": "A natural-language prompt for image generation. When supplied,\nmagic-prompt is enabled automatically. Mutually exclusive with\n`json_prompt`.\n", - "type": "string", - "x-playground-field": { - "label": "Text prompt", - "control": "textarea", - "order": 1, - "group": "prompt", - "default": "A cinematic product shot of a tabby cat sleeping on a modern couch, soft daylight, rich texture, highly detailed.", - "placeholder": "Describe the image you want to generate." - } + "type": "string" }, "json_prompt": { "allOf": [ @@ -14402,29 +14651,16 @@ "$ref": "#/components/schemas/V4JsonPrompt" } ], - "description": "A structured prompt that conforms to the Ideogram 4.0 JSON\ncontract. When supplied, magic-prompt is disabled and the\nstructured prompt is consumed by the diffusion model directly.\nMutually exclusive with `text_prompt`.\n", - "x-playground-field": { - "label": "JSON prompt", - "control": "json", - "order": 1, - "group": "prompt", - "placeholder": "Paste a V4 JSON prompt." - } + "description": "A structured prompt that conforms to the Ideogram 4.0 JSON\ncontract. When supplied, magic-prompt is disabled and the\nstructured prompt is consumed by the diffusion model directly.\nMutually exclusive with `text_prompt`.\n" }, "seed": { "description": "Random seed for reproducibility.", "nullable": true, - "type": "integer", - "x-playground-field": { - "hidden": true - } + "type": "integer" }, "magic_prompt_system_prompt_config_id": { "description": "A base64url-encoded magic prompt system prompt config ID to use\nfor this request. Honored when `text_prompt` is supplied. Ignored\nwhen `json_prompt` is supplied.\n", - "type": "string", - "x-playground-field": { - "hidden": true - } + "type": "string" }, "resolution": { "$ref": "#/components/schemas/ResolutionV4" @@ -14435,32 +14671,12 @@ "$ref": "#/components/schemas/RenderingSpeed" } ], - "description": "The rendering speed to use. For Ideogram V4, `rendering_speed=FLASH`\nis coming soon; requests with `rendering_speed=FLASH` currently\nreturn a 400.\n", - "x-playground-field": { - "label": "Rendering speed", - "order": 3, - "default": "DEFAULT", - "enum_subset": [ - "DEFAULT", - "TURBO", - "QUALITY" - ], - "labels": { - "DEFAULT": "Default", - "TURBO": "Turbo", - "QUALITY": "Quality" - } - } + "description": "The rendering speed to use. For Ideogram V4, `rendering_speed=FLASH`\nis coming soon; requests with `rendering_speed=FLASH` currently\nreturn a 400.\n" }, "enable_copyright_detection": { "description": "Optional. Opt this request into post-generation copyright detection (Hive likeness + logo\nchecks). The effective gate is the OR of this field and the organization's\n`copyright_detection_enabled` setting on `/api`. See GenerateImageRequestV3 for details.\n", "nullable": true, - "type": "boolean", - "x-playground-field": { - "label": "Copyright detection", - "order": 4, - "default": false - } + "type": "boolean" } }, "type": "object" @@ -14470,15 +14686,7 @@ "properties": { "prompt": { "description": "The prompt for image generation. Accepts either natural language or\na structured prompt that conforms to the Ideogram 4.0 JSON contract;\nthe server detects which was supplied. See `prompt_upsampling` for\nhow magic-prompt is applied.\n", - "type": "string", - "x-playground-field": { - "label": "Prompt", - "control": "textarea", - "order": 1, - "group": "prompt", - "default": "A cinematic product shot of a tabby cat sleeping on a modern couch, soft daylight, rich texture, highly detailed.", - "placeholder": "Describe the image you want to generate, or paste a V4 JSON prompt." - } + "type": "string" }, "prompt_upsampling": { "allOf": [ @@ -14486,27 +14694,16 @@ "$ref": "#/components/schemas/MagicPromptOption" } ], - "description": "Controls magic-prompt (prompt upsampling). `AUTO` (default) applies\nmagic-prompt to a natural-language `prompt` or a non-Ideogram 4.0 JSON\n`prompt`, and skips it when `prompt` is already a structured Ideogram\n4.0 JSON prompt. `ON` always applies magic-prompt, even to an Ideogram\n4.0 JSON prompt; `OFF` never applies it. Defaults to `AUTO`.\n", - "x-playground-field": { - "label": "Prompt upsampling", - "order": 2, - "default": "AUTO" - } + "description": "Controls magic-prompt (prompt upsampling). `AUTO` (default) applies\nmagic-prompt to a natural-language `prompt` or a non-Ideogram 4.0 JSON\n`prompt`, and skips it when `prompt` is already a structured Ideogram\n4.0 JSON prompt. `ON` always applies magic-prompt, even to an Ideogram\n4.0 JSON prompt; `OFF` never applies it. Defaults to `AUTO`.\n" }, "seed": { "description": "Random seed for reproducibility.", "nullable": true, - "type": "integer", - "x-playground-field": { - "hidden": true - } + "type": "integer" }, "magic_prompt_system_prompt_config_id": { "description": "A base64url-encoded magic prompt system prompt config ID to use\nfor this request. Honored only when magic-prompt runs (a\nnatural-language `prompt` with `prompt_upsampling` AUTO or ON).\n", - "type": "string", - "x-playground-field": { - "hidden": true - } + "type": "string" }, "resolution": { "$ref": "#/components/schemas/ResolutionV4" @@ -14514,12 +14711,7 @@ "enable_copyright_detection": { "description": "Optional. Opt this request into post-generation copyright detection (Hive likeness + logo\nchecks). The effective gate is the OR of this field and the organization's\n`copyright_detection_enabled` setting on `/api`. See GenerateImageRequestV3 for details.\n", "nullable": true, - "type": "boolean", - "x-playground-field": { - "label": "Copyright detection", - "order": 4, - "default": false - } + "type": "boolean" } }, "required": [ @@ -14945,34 +15137,17 @@ "image": { "description": "The initial image binary (max 25MB); only JPEG, WebP and PNG formats are supported.", "format": "binary", - "type": "string", - "x-playground-field": { - "label": "Initial image", - "order": 1 - } + "type": "string" }, "text_prompt": { "description": "The text prompt that guides the remix.", - "type": "string", - "x-playground-field": { - "label": "Prompt", - "control": "textarea", - "order": 2, - "default": "Restyle this image as a vibrant watercolor painting.", - "placeholder": "Describe how to remix the image." - } + "type": "string" }, "image_weight": { "description": "Optional. How strongly the output should resemble the input image. Higher values keep\nthe input image's structure; lower values allow the prompt to drive the output more.\nWhen omitted, the weight is chosen automatically from the edit instruction; supplying\na value overrides that automatic choice. Only accepted when the output keeps the input\nimage's shape: combining image_weight with a resolution whose aspect ratio differs\nfrom the input image's is rejected with a 400.\n", "maximum": 100, "minimum": 1, - "type": "integer", - "x-playground-field": { - "label": "Image weight", - "control": "slider", - "order": 3, - "step": 1 - } + "type": "integer" }, "resolution": { "allOf": [ @@ -14980,18 +15155,7 @@ "$ref": "#/components/schemas/ResolutionV4" } ], - "description": "Optional. When supplied, the images are generated at this resolution. When omitted,\nthe input image's shape is kept. A resolution whose aspect ratio differs from the\ninput image's cannot be combined with image_weight.\n", - "x-playground-field": { - "label": "Resolution", - "order": 4, - "default": "2048x2048", - "enum_subset": [ - "2048x2048", - "1440x2880", - "2880x1440", - "1664x2496" - ] - } + "description": "Optional. When supplied, the images are generated at this resolution. When omitted,\nthe input image's shape is kept. A resolution whose aspect ratio differs from the\ninput image's cannot be combined with image_weight.\n" }, "rendering_speed": { "$ref": "#/components/schemas/RenderingSpeed" @@ -14999,12 +15163,7 @@ "enable_copyright_detection": { "description": "Optional. Opt this request into post-generation copyright detection (Hive likeness + logo\nchecks). See GenerateImageRequestV3 for details.\n", "nullable": true, - "type": "boolean", - "x-playground-field": { - "label": "Copyright detection", - "order": 6, - "default": false - } + "type": "boolean" } }, "required": [ @@ -16246,11 +16405,7 @@ "image": { "description": "The image whose background is being removed (max size 25MB); only JPEG, WebP and PNG formats are supported at this time.", "format": "binary", - "type": "string", - "x-playground-field": { - "label": "Image", - "order": 1 - } + "type": "string" } }, "required": [ @@ -19492,6 +19647,74 @@ "title": "InternalBatchResultsResponse", "type": "object" }, + "AssetReferenceUsageResponse": { + "example": { + "next_cursor": "next_cursor", + "assets": [ + { + "asset_identifier": { + "asset_type": "RESPONSE", + "asset_id": "7uS_VESkRI6O3-sVgHQp_A" + }, + "request_count": 1 + }, + { + "asset_identifier": { + "asset_type": "RESPONSE", + "asset_id": "7uS_VESkRI6O3-sVgHQp_A" + }, + "request_count": 1 + } + ] + }, + "properties": { + "assets": { + "items": { + "$ref": "#/components/schemas/AssetReferenceUsageItem" + }, + "title": "assets", + "type": "array" + }, + "next_cursor": { + "nullable": true, + "title": "next_cursor", + "type": "string" + } + }, + "required": [ + "assets", + "next_cursor" + ], + "title": "AssetReferenceUsageResponse", + "type": "object" + }, + "AssetReferenceUsageItem": { + "example": { + "asset_identifier": { + "asset_type": "RESPONSE", + "asset_id": "7uS_VESkRI6O3-sVgHQp_A" + }, + "request_count": 1 + }, + "properties": { + "asset_identifier": { + "$ref": "#/components/schemas/AssetIdentifier" + }, + "request_count": { + "description": "Completed organization requests using the asset as an edit input within the requested range.", + "format": "int64", + "minimum": 1, + "title": "request_count", + "type": "integer" + } + }, + "required": [ + "asset_identifier", + "request_count" + ], + "title": "AssetReferenceUsageItem", + "type": "object" + }, "WebhookUrl": { "description": "HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a\nJSON POST to this URL once all images for the request have finished\ngenerating. The body mirrors the synchronous generate response:\n`request_id`, `created`, and a `data` array\ncontaining every generated image (`url`, `prompt`, `resolution`, `seed`,\n`is_image_safe`). Each delivery is signed with Ed25519 and verifiable\nagainst the public keys at `https://api.ideogram.ai/v1/.well-known/jwks.json`. Must be HTTPS;\nprivate and loopback hosts and the cloud metadata service are rejected.\n", "example": "https://api.example.com/webhooks/ideogram", @@ -19501,14 +19724,14 @@ "type": "string" }, "GenerateVideoSeedDance2Response": { - "description": "Acknowledgement returned by the Seedance 2.0 video endpoints. Video\ngeneration always runs asynchronously, so the\ngenerated videos are never part of this response: poll for them with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`, or receive them at the `webhook_url` you supplied.\n", + "description": "Acknowledgement that the request was accepted. The generated video is not\npart of this response: poll `GET /v2/generations/{generation_id}` with\nthe returned `generation_id`, or receive it at your `webhook_url`.\nVideo links expire after a limited time, so download any video you\nwant to keep.\n", "example": { "generation_id": "generation_id", "created": "2000-01-23T04:56:07+00:00" }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -19648,7 +19871,7 @@ "type": "string" }, "GenerateVideoSeedDance2ImageToVideoRequest": { - "description": "Request body for Seedance 2.0 image-to-video generation. Supply the\nfirst frame either as an `image_asset_identifier` reference or\n(multipart requests only) as raw `image` bytes. Exactly one source is\nrequired. An optional final frame may be supplied the same way, with\n`end_image_asset_identifier` or `end_image`, to generate a transition\nbetween the two stills.\n", + "description": "Request body for Seedance 2.0 image-to-video generation.\nUpload the first frame as `image`, and optionally a final frame as\n`end_image`, using `multipart/form-data`.\n", "properties": { "image_asset_identifier": { "allOf": [ @@ -19659,7 +19882,7 @@ "description": "A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted." }, "image": { - "description": "The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset.", + "description": "The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -19672,7 +19895,7 @@ "description": "An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted." }, "end_image": { - "description": "An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset.", + "description": "An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one.", "format": "binary", "type": "string" }, @@ -19727,14 +19950,14 @@ "type": "object" }, "GenerateVideoSeedDance25Response": { - "description": "Acknowledgement returned by the Seedance 2.5 video generation\nendpoints. Video generation always runs asynchronously, so the\ngenerated video is never part of this response: poll for it with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`, or receive it at the `webhook_url` you supplied.\n", + "description": "Acknowledgement that the request was accepted. The generated video is not\npart of this response: poll `GET /v2/generations/{generation_id}` with\nthe returned `generation_id`, or receive it at your `webhook_url`.\nVideo links expire after a limited time, so download any video you\nwant to keep.\n", "example": { "generation_id": "generation_id", "created": "2000-01-23T04:56:07+00:00" }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -19839,7 +20062,7 @@ "type": "integer" }, "GenerateVideoSeedDance25ImageToVideoRequest": { - "description": "Request body for Seedance 2.5 image-to-video generation. Supply the\nfirst frame either as an `image_asset_identifier` reference or\n(multipart requests only) as raw `image` bytes. Exactly one source is\nrequired. An optional final frame may be supplied the same way, with\n`end_image_asset_identifier` or `end_image`, to generate a transition\nbetween the two stills.\n", + "description": "Request body for Seedance 2.5 image-to-video generation.\nUpload the first frame as `image`, and optionally a final frame as\n`end_image`, using `multipart/form-data`. The video takes its aspect\nratio from the first frame, so there is no `aspect_ratio` field.\n", "properties": { "image_asset_identifier": { "allOf": [ @@ -19850,7 +20073,7 @@ "description": "A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted." }, "image": { - "description": "The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset.", + "description": "The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -19863,7 +20086,7 @@ "description": "An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted." }, "end_image": { - "description": "An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset.", + "description": "An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one.", "format": "binary", "type": "string" }, @@ -19976,14 +20199,14 @@ "type": "object" }, "GenerateVideoMinimaxH3Response": { - "description": "Acknowledgement returned by the MiniMax H3 video generation endpoints.\nVideo generation always runs asynchronously, so the generated video is\nnever part of this response: poll for it with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`, or receive it at the `webhook_url` you supplied.\n", + "description": "Acknowledgement that the video request was accepted. The video is not\nincluded in this response: poll `GET /v2/generations/{generation_id}`\nwith the returned `generation_id`, or receive it at the `webhook_url`\nyou supplied. Video links expire after a limited time, so download any\nvideo you want to keep.\n", "example": { "generation_id": "generation_id", "created": "2000-01-23T04:56:07+00:00" }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n", "title": "generation_id", "type": "string" }, @@ -20002,7 +20225,7 @@ "type": "object" }, "GenerateVideoMinimaxH3ImageToVideoRequest": { - "description": "Request body for MiniMax H3 image-to-video generation. Supply the first\nframe either as an `image_asset_identifier` reference or (multipart\nrequests only) as raw `image` bytes. Exactly one source is required. An\noptional final frame may be supplied the same way, with\n`end_image_asset_identifier` or `end_image`, to generate a transition\nbetween the two stills.\n", + "description": "Request body for MiniMax H3 image-to-video generation.\nUpload the first frame as `image`, and optionally a final frame as\n`end_image`, using `multipart/form-data`. The video takes its aspect\nratio from the first frame, so there is no `aspect_ratio` field.\n", "properties": { "image_asset_identifier": { "allOf": [ @@ -20013,7 +20236,7 @@ "description": "A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted." }, "image": { - "description": "The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset.", + "description": "The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -20026,7 +20249,7 @@ "description": "An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted." }, "end_image": { - "description": "An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset.", + "description": "An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one.", "format": "binary", "type": "string" }, @@ -20073,14 +20296,14 @@ "type": "object" }, "GenerateVideoKlingV3Response": { - "description": "Acknowledgement returned by the Kling v3 video generation endpoints.\nVideo generation always runs asynchronously, so the generated video is\nnever part of this response: poll for it with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`, or receive it at the `webhook_url` you supplied.\n", + "description": "Acknowledgement that the request was accepted. The generated video is not\npart of this response: poll `GET /v2/generations/{generation_id}` with\nthe returned `generation_id`, or receive it at your `webhook_url`.\nVideo links expire after a limited time, so download any video you\nwant to keep.\n", "example": { "generation_id": "generation_id", "created": "2000-01-23T04:56:07+00:00" }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -20183,7 +20406,7 @@ "type": "object" }, "GenerateVideoKlingV3StandardImageToVideoRequest": { - "description": "Request body for Kling v3 Standard image-to-video generation. Supply the\nfirst frame either as an `image_asset_identifier` reference or\n(multipart requests only) as raw `image` bytes. Exactly one source is\nrequired. An optional final frame may be supplied the same way, with\n`end_image_asset_identifier` or `end_image`, to generate a transition\nbetween the two stills.\n", + "description": "Request body for Kling v3 Standard image-to-video generation.\nUpload the first frame as `image`, and optionally a final frame as\n`end_image`, using `multipart/form-data`. The video takes its aspect\nratio from the first frame, so there is no `aspect_ratio` field.\n", "properties": { "image_asset_identifier": { "allOf": [ @@ -20194,7 +20417,7 @@ "description": "A reference to an image already stored with Ideogram to use as the first frame, in place of uploading `image`. Only image assets are accepted." }, "image": { - "description": "The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset.", + "description": "The first-frame image to animate, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -20207,7 +20430,7 @@ "description": "An optional final frame, as a reference to an image already stored with Ideogram. When supplied, the generated video transitions from the first frame to this one. Only image assets are accepted." }, "end_image": { - "description": "An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset.", + "description": "An optional final frame, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. When supplied, the video transitions from the first frame to this one.", "format": "binary", "type": "string" }, @@ -20273,10 +20496,10 @@ "type": "object" }, "GenerateVideoSeedDance2ReferenceToVideoRequest": { - "description": "Request body for Seedance 2.0 reference-to-video. The prompt\naddresses references by position — `@Image1`,\n`@Video1`, and so on. Reference images arrive either\nas `reference_image_asset_identifiers` or (multipart requests only) as\nraw `reference_images` bytes, never both. Reference videos arrive only\nas `reference_video_asset_identifiers`, which may reference uploaded or\ngenerated videos. At least one reference image or video is\nrequired.\n", + "description": "Request body for Seedance 2.0 reference-to-video. Upload\n`reference_images` (at least one is required) and optional\n`reference_audios` using `multipart/form-data`. The prompt refers to\nthem by position: `@Image1`, `@Audio1`, and so on.\n", "properties": { "prompt": { - "description": "A natural-language prompt describing the video to produce. Reference media is addressed by position, as in \"@Image1 walks toward the camera with the motion of @Video1\".", + "description": "A natural-language prompt describing the video to produce. Refer to references by position, as in \"@Image1 walks toward the camera\".", "example": "@Image1 walks through the snowy forest at dawn.", "maxLength": 2000, "minLength": 1, @@ -20292,7 +20515,7 @@ "type": "array" }, "reference_images": { - "description": "Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset.", + "description": "Reference images, in prompt order. Common formats such as JPEG, PNG, and WEBP are supported, up to 50MB each. Multipart requests only. Uploaded images are used for this request only and are not stored.", "items": { "format": "binary", "type": "string" @@ -20311,7 +20534,7 @@ "type": "array" }, "reference_audios": { - "description": "MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 15 seconds; combined duration must not exceed 15 seconds. At least one reference image or video is required. Audio is used for this generation only and is not saved to your library.", + "description": "MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 15 seconds long, with a combined duration of at most 15 seconds. Requires at least one reference image. Audio is used for this request only and is not saved to your library.", "items": { "format": "binary", "type": "string" @@ -20364,10 +20587,10 @@ "type": "object" }, "GenerateVideoSeedDance25ReferenceToVideoRequest": { - "description": "Request body for Seedance 2.5 reference-to-video. The prompt\naddresses references by position — `[Image1]`,\n`[Video1]`, and so on. Reference images arrive either\nas `reference_image_asset_identifiers` or (multipart requests only) as\nraw `reference_images` bytes, never both. Reference videos arrive only\nas `reference_video_asset_identifiers`, which may reference uploaded or\ngenerated videos. At least one reference image or video is\nrequired.\n", + "description": "Request body for Seedance 2.5 reference-to-video. Upload\n`reference_images` (at least one is required) and optional\n`reference_audios` using `multipart/form-data`. The prompt refers to\nthem by position: `[Image1]`, `[Audio1]`, and so on.\n", "properties": { "prompt": { - "description": "A natural-language prompt describing the video to produce. Reference media is addressed by position, as in \"[Image1] walks toward the camera with the motion of [Video1]\".", + "description": "A natural-language prompt describing the video to produce. Refer to references by position, as in \"[Image1] walks toward the camera\".", "example": "[Image1] walks through the snowy forest at dawn.", "maxLength": 2000, "minLength": 1, @@ -20383,7 +20606,7 @@ "type": "array" }, "reference_images": { - "description": "Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset.", + "description": "Reference images, in prompt order. Common formats such as JPEG, PNG, and WEBP are supported, up to 50MB each. Multipart requests only. Uploaded images are used for this request only and are not stored.", "items": { "format": "binary", "type": "string" @@ -20402,7 +20625,7 @@ "type": "array" }, "reference_audios": { - "description": "MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 30 seconds; combined duration must not exceed 30 seconds. At least one reference image or video is required. Audio is used for this generation only and is not saved to your library.", + "description": "MP3 or WAV audio references, in prompt order. Multipart requests only. Each file must be at most 15 MB and between 2 and 30 seconds long, with a combined duration of at most 30 seconds. Requires at least one reference image. Audio is used for this request only and is not saved to your library.", "items": { "format": "binary", "type": "string" @@ -20455,7 +20678,7 @@ "type": "object" }, "EditVideoMinimaxH3ReferenceToVideoRequest": { - "description": "Request body for MiniMax H3 reference-to-video. The prompt addresses\nreferences by position — `Image 1`, `Video 1`, `Audio 1`, and so on. Reference\nimages arrive either as `reference_image_asset_identifiers` or\n(multipart requests only) as raw `reference_images` bytes, never both.\nReference videos arrive only as\n`reference_video_asset_identifiers`, which must reference videos\ngenerated or uploaded with Ideogram. References are optional; audio\nrequires an image or video alongside it.\n", + "description": "Request body for MiniMax H3 reference-to-video. The prompt addresses\nreferences by position: `Image 1`, `Audio 1`, and so on. References\nare optional; with none, the video is produced from the prompt alone.\nAudio requires an image alongside it, and audio references must total\nat most 15 seconds.\n", "properties": { "prompt": { "description": "A natural-language prompt describing the video to produce. Reference media is addressed by position, as in \"Image 1 walks toward the camera with the motion of Video 1\".", @@ -20474,7 +20697,7 @@ "type": "array" }, "reference_images": { - "description": "Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Cannot be combined with `reference_image_asset_identifiers`. The bytes are used for this request only and are not stored as an asset.", + "description": "Images to use as references (max size 50MB each), as raw bytes, in prompt order; only common image formats such as JPEG, PNG, and WEBP are supported. Uploaded images are used for this request only and are not stored.", "items": { "format": "binary", "type": "string" @@ -20660,13 +20883,13 @@ "type": "object" }, "RemoveObjectFromV2AssetsResponse": { - "description": "Acknowledgement returned by `POST /v2/image/remove-object/ideogram-1`. The request is\naccepted for asynchronous processing; poll for completion and results\nusing `GET /v1/generations/{generation_id}` with the returned\n`generation_id`.\n", + "description": "Acknowledgement that the request was accepted. Poll\n`GET /v2/generations/{generation_id}` with the returned `generation_id`\nfor the result.\n", "example": { "generation_id": "generation_id" }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n", "title": "generation_id", "type": "string" } @@ -20678,13 +20901,13 @@ "type": "object" }, "RemoveObjectFromV2AssetsRequest": { - "description": "Supply the source image and the mask each as either an `AssetIdentifier`\nreference or (multipart requests only) raw image bytes. At least one of\n`image_asset_identifier` / `image` is required, and likewise at least one of\n`mask_asset_identifier` / `mask`; if both a reference and bytes are given for\nthe same input, the reference is used and the bytes are ignored.\n", + "description": "Upload both the source `image` and the `mask` using `multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to remove an object from (max size 50MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied.", + "description": "The source image to remove an object from. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only.", "format": "binary", "type": "string" }, @@ -20692,7 +20915,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "mask": { - "description": "A binary mask the same size as the image (max size 50MB), as raw bytes; white (>= 128) marks the region to remove. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied.", + "description": "A black-and-white mask the same size as the image; white (>= 128) marks the region to remove. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only.", "format": "binary", "type": "string" }, @@ -20710,14 +20933,14 @@ }, "store_assets": { "default": false, - "description": "Whether to store resulting generation assets on Ideogram. Defaults to `false` for\nAPI developers; first-party mini-apps should pass `true`. Reserved in the schema for\nan upcoming storage-control rollout — currently accepted but not yet enforced.\n", + "description": "Whether to store the resulting images on Ideogram. Defaults to `false`.\nCurrently accepted but not yet enforced.\n", "type": "boolean" } }, "type": "object" }, "RemoveBackgroundV2Response": { - "description": "Synchronous requests include exactly one foreground image in `data`.\nAsync requests omit `data`; poll with `generation_id` for completion.\nA slow synchronous failure that occurs after heartbeat streaming starts\ncontains `error` and `status_code` instead of `generation_id`.\n", + "description": "Synchronous requests include exactly one foreground image in `data`.\nAsync requests omit `data`; poll with `generation_id` for the result.\nIf a synchronous request fails after the response has started\nstreaming, the body contains `error` and `status_code` instead of\n`generation_id`.\n", "example": { "generation_id": "zm6IqQd4RPGnwA8gQYEL5Q", "data": [ @@ -20729,7 +20952,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID accepted by the generation polling endpoint.", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.", "type": "string" }, "data": { @@ -20742,11 +20965,11 @@ "type": "array" }, "error": { - "description": "Error message for a failure after heartbeat streaming starts.", + "description": "Error message for a failure after the response started streaming.", "type": "string" }, "status_code": { - "description": "HTTP status that would have been returned before streaming began.", + "description": "The HTTP status the failure would have returned before streaming began.", "type": "integer" } }, @@ -20776,10 +20999,10 @@ "type": "object" }, "RemoveBackgroundV2Request": { - "description": "Supply exactly one image source. `image` is available only in multipart requests; `image_asset_identifier` accepts an existing upload or generated image that is readable in the active organization.", + "description": "Upload the source `image` using `multipart/form-data`.", "properties": { "image": { - "description": "Raw JPEG, PNG, or WebP image bytes (max 25MB). Multipart requests only.", + "description": "The source image. JPEG, PNG, or WebP, up to 25MB. Multipart requests only.", "format": "binary", "type": "string", "x-playground-field": { @@ -20796,7 +21019,7 @@ "type": "string" }, "private": { - "description": "Whether to keep the result out of the public gallery. When omitted,\nFirebase Bearer and Mini App callers inherit their plan entitlement.\nEnterprise generations are always private. API keys use their bound\norganization and otherwise default to public when no subscription\nentitlement is available.\n", + "description": "Whether to keep the result out of the public gallery. When omitted,\ndefaults to your plan's setting, or public if your plan has none.\nEnterprise generations are always private.\n", "type": "boolean", "x-playground-field": { "label": "Visibility", @@ -20817,7 +21040,7 @@ }, "async": { "default": false, - "description": "When false (the default), wait for and return the foreground image. When true, return after acceptance and poll `GET /v1/generations/{generation_id}`.", + "description": "When false (the default), wait for and return the foreground image. When true, return as soon as the request is accepted; poll `GET /v2/generations/{generation_id}` for the result.", "type": "boolean", "x-playground-field": { "label": "Async", @@ -20830,7 +21053,7 @@ }, "RemoveBackgroundV2AssetRequest": { "additionalProperties": false, - "description": "JSON request shape for processing an existing upload or generated image. Raw image bytes are accepted only through multipart form data.", + "description": "JSON request body. To upload an image, use `multipart/form-data`.", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" @@ -20845,7 +21068,7 @@ }, "async": { "default": false, - "description": "Return after acceptance and poll by generation ID when true.", + "description": "When true, return as soon as the request is accepted; poll `GET /v2/generations/{generation_id}` for the result.", "type": "boolean" } }, @@ -20855,13 +21078,13 @@ "type": "object" }, "ReplaceBackgroundResponse": { - "description": "Acknowledgement that the workflow was accepted.", + "description": "Acknowledgement that the request was accepted.", "example": { "generation_id": "generation_id" }, "properties": { "generation_id": { - "description": "URL-safe base64 ID accepted by the generation polling endpoint.", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.", "title": "generation_id", "type": "string" } @@ -20873,13 +21096,13 @@ "type": "object" }, "ReplaceBackgroundRequest": { - "description": "Supply exactly one of `image_asset_identifier` or multipart `image`\nbytes. The prompt describes only the desired new background; the\nforeground subject is detected and preserved automatically.\n", + "description": "Upload the source `image` using `multipart/form-data`. The prompt\ndescribes only the new background; the foreground subject is detected\nand kept automatically.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,\nTIFF, and MPO are supported, up to 50 MB. Multipart requests only.\n", + "description": "The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and\nMPO are supported, up to 50 MB. Multipart requests only.\n", "format": "binary", "type": "string" }, @@ -20908,7 +21131,7 @@ "type": "integer" }, "private": { - "description": "If true, the user is requesting private generation. If omitted,\nthis defaults to the user's plan entitlement. Enterprise\ngenerations are always private.\n", + "description": "Whether to keep the result private. When omitted, defaults to your\nplan's setting. Enterprise generations are always private.\n", "type": "boolean" }, "webhook_url": { @@ -20936,13 +21159,13 @@ "type": "string" }, "ReplaceBackgroundIdeogramV3Request": { - "description": "Supply exactly one of `image_asset_identifier` or multipart `image`\nbytes. The prompt describes only the desired new background; the\nforeground subject is detected and preserved automatically.\n", + "description": "Upload the source `image` using `multipart/form-data`. The prompt\ndescribes only the new background; the foreground subject is detected\nand kept automatically.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,\nTIFF, and MPO are supported, up to 50 MB. Multipart requests only.\n", + "description": "The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and\nMPO are supported, up to 50 MB. Multipart requests only.\nThe longer side must be at most 3 times the shorter side; wider\naspect ratios are rejected with a 400.\n", "format": "binary", "type": "string" }, @@ -20972,7 +21195,7 @@ "type": "integer" }, "private": { - "description": "If true, the user is requesting private generation. If omitted,\nthis defaults to the user's plan entitlement. Enterprise\ngenerations are always private.\n", + "description": "Whether to keep the result private. When omitted, defaults to your\nplan's setting. Enterprise generations are always private.\n", "type": "boolean" }, "webhook_url": { @@ -21719,7 +21942,7 @@ "type": "object" }, "UpscaleImageTopazTextRefineResponse": { - "description": "Response returned by `POST /v2/image/upscale/topaz-text-refine`.\nSynchronous requests (the default) include the upscaled image in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset; width and height\nreport the output dimensions.\n", + "description": "Synchronous requests (the default) include the upscaled image in `data`.\nAsync requests omit `data`; poll `GET /v2/generations/{generation_id}`\nwith the returned `generation_id`. `seed` is the seed actually used,\nand `width` and `height` are the output dimensions.\n", "example": { "data": [ { @@ -21742,7 +21965,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -21827,13 +22050,13 @@ "type": "object" }, "UpscaleImageTopazTextRefineRequest": { - "description": "Supply the source image either as an `image_asset_identifier`\nreference or (multipart requests only) as raw `image` bytes. Exactly\none source is required; if both forms are given, the reference is\nused and the bytes are ignored.\n", + "description": "Upload the source `image` using `multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset.", + "description": "The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -21848,28 +22071,28 @@ "type": "string" }, "strength": { - "description": "Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let Topaz choose per image.", + "description": "Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let the model choose per image.", "format": "float", "maximum": 1, "minimum": 0.01, "type": "number" }, "sharpen": { - "description": "Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image.", + "description": "Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image.", "format": "float", "maximum": 1, "minimum": 0, "type": "number" }, "denoise": { - "description": "Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image.", + "description": "Noise and grain reduction, from 0 to 1. Omit to let the model choose per image.", "format": "float", "maximum": 1, "minimum": 0, "type": "number" }, "fix_compression": { - "description": "Compression artifact removal, from 0 to 1. Omit to let Topaz choose per image.", + "description": "Compression artifact removal, from 0 to 1. Omit to let the model choose per image.", "format": "float", "maximum": 1, "minimum": 0, @@ -21894,7 +22117,7 @@ "type": "number" }, "subject_detection": { - "description": "Where enhancements apply. Omit to let Topaz choose per image.", + "description": "Where enhancements apply. Omit to let the model choose per image.", "enum": [ "all", "foreground", @@ -21912,7 +22135,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.", "type": "boolean" }, "webhook_url": { @@ -21936,7 +22159,7 @@ "type": "object" }, "UpscaleImageTopazWonder35Response": { - "description": "Response returned by `POST /v2/image/upscale/topaz-wonder-3-5`.\nSynchronous requests (the default) include the upscaled image in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset; width and height\nreport the output dimensions.\n", + "description": "Synchronous requests (the default) include the upscaled image in `data`.\nAsync requests omit `data`; poll `GET /v2/generations/{generation_id}`\nwith the returned `generation_id`. `seed` is the seed actually used,\nand `width` and `height` are the output dimensions.\n", "example": { "data": [ { @@ -21959,7 +22182,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -22000,13 +22223,13 @@ "type": "object" }, "UpscaleImageTopazWonder35Request": { - "description": "Supply the source image either as an `image_asset_identifier`\nreference or (multipart requests only) as raw `image` bytes. Exactly\none source is required; if both forms are given, the reference is\nused and the bytes are ignored.\n", + "description": "Upload the source `image` using `multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset.", + "description": "The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -22040,7 +22263,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.", "type": "boolean" }, "webhook_url": { @@ -22064,7 +22287,7 @@ "type": "object" }, "UpscaleImageTopazStandardV2Response": { - "description": "Response returned by `POST /v2/image/upscale/topaz-standard-2`.\nSynchronous requests (the default) include the upscaled image in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset; width and height\nreport the output dimensions.\n", + "description": "Synchronous requests (the default) include the upscaled image in `data`.\nAsync requests omit `data`; poll `GET /v2/generations/{generation_id}`\nwith the returned `generation_id`. `seed` is the seed actually used,\nand `width` and `height` are the output dimensions.\n", "example": { "data": [ { @@ -22087,7 +22310,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -22128,13 +22351,13 @@ "type": "object" }, "UpscaleImageTopazStandardV2Request": { - "description": "Supply the source image either as an `image_asset_identifier`\nreference or (multipart requests only) as raw `image` bytes. Exactly\none source is required; if both forms are given, the reference is\nused and the bytes are ignored.\n", + "description": "Upload the source `image` using `multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset.", + "description": "The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -22149,28 +22372,28 @@ "type": "string" }, "strength": { - "description": "Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let Topaz choose per image.", + "description": "Overall intensity of the enhancement model, from 0.01 to 1. Higher values look crisper but can turn unrealistic. Omit to let the model choose per image.", "format": "float", "maximum": 1, "minimum": 0.01, "type": "number" }, "sharpen": { - "description": "Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image.", + "description": "Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image.", "format": "float", "maximum": 1, "minimum": 0, "type": "number" }, "denoise": { - "description": "Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image.", + "description": "Noise and grain reduction, from 0 to 1. Omit to let the model choose per image.", "format": "float", "maximum": 1, "minimum": 0, "type": "number" }, "fix_compression": { - "description": "Compression artifact removal, from 0 to 1. Omit to let Topaz choose per image.", + "description": "Compression artifact removal, from 0 to 1. Omit to let the model choose per image.", "format": "float", "maximum": 1, "minimum": 0, @@ -22195,7 +22418,7 @@ "type": "number" }, "subject_detection": { - "description": "Where enhancements apply. Omit to let Topaz choose per image.", + "description": "Where enhancements apply. Omit to let the model choose per image.", "enum": [ "all", "foreground", @@ -22205,7 +22428,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.", "type": "boolean" }, "webhook_url": { @@ -22229,7 +22452,7 @@ "type": "object" }, "UpscaleImageTopazBloom2Response": { - "description": "Response returned by `POST /v2/image/upscale/topaz-bloom-2`.\nSynchronous requests (the default) include the upscaled image in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset; width and height\nreport the output dimensions.\n", + "description": "Synchronous requests (the default) include the upscaled image in `data`.\nAsync requests omit `data`; poll `GET /v2/generations/{generation_id}`\nwith the returned `generation_id`. `seed` is the seed actually used,\nand `width` and `height` are the output dimensions.\n", "example": { "data": [ { @@ -22252,7 +22475,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -22293,13 +22516,13 @@ "type": "object" }, "UpscaleImageTopazBloom2Request": { - "description": "Supply the source image either as an `image_asset_identifier`\nreference or (multipart requests only) as raw `image` bytes. Exactly\none source is required; if both forms are given, the reference is\nused and the bytes are ignored.\n", + "description": "Upload the source `image` using `multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset.", + "description": "The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -22341,7 +22564,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.", "type": "boolean" }, "webhook_url": { @@ -22365,7 +22588,7 @@ "type": "object" }, "UpscaleImageTopazRedefineResponse": { - "description": "Response returned by `POST /v2/image/upscale/topaz-redefine`.\nSynchronous requests (the default) include the upscaled image in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset; width and height\nreport the output dimensions.\n", + "description": "Synchronous requests (the default) include the upscaled image in `data`.\nAsync requests omit `data`; poll `GET /v2/generations/{generation_id}`\nwith the returned `generation_id`. `seed` is the seed actually used,\nand `width` and `height` are the output dimensions.\n", "example": { "data": [ { @@ -22388,7 +22611,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -22429,13 +22652,13 @@ "type": "object" }, "UpscaleImageTopazRedefineRequest": { - "description": "Supply the source image either as an `image_asset_identifier`\nreference or (multipart requests only) as raw `image` bytes. Exactly\none source is required; if both forms are given, the reference is\nused and the bytes are ignored.\n", + "description": "Upload the source `image` using `multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset.", + "description": "The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -22487,14 +22710,14 @@ "type": "number" }, "sharpen": { - "description": "Edge sharpening applied after enlarging, from 0 to 1. Omit to let Topaz choose per image.", + "description": "Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image.", "format": "float", "maximum": 1, "minimum": 0, "type": "number" }, "denoise": { - "description": "Noise and grain reduction, from 0 to 1. Omit to let Topaz choose per image.", + "description": "Noise and grain reduction, from 0 to 1. Omit to let the model choose per image.", "format": "float", "maximum": 1, "minimum": 0, @@ -22519,7 +22742,7 @@ "type": "number" }, "subject_detection": { - "description": "Where enhancements apply. Omit to let Topaz choose per image.", + "description": "Where enhancements apply. Omit to let the model choose per image.", "enum": [ "all", "foreground", @@ -22537,7 +22760,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.", "type": "boolean" }, "webhook_url": { @@ -22561,7 +22784,7 @@ "type": "object" }, "UpscaleImageNanoBananaProResponse": { - "description": "Response returned by `POST /v2/image/upscale/nano-banana-pro`.\nSynchronous requests (the default) include the upscaled image in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset; width and height\nreport the output dimensions.\n", + "description": "Synchronous requests (the default) include the upscaled image in `data`.\nAsync requests omit `data`; poll `GET /v2/generations/{generation_id}`\nwith the returned `generation_id`. `seed` is the seed actually used,\nand `width` and `height` are the output dimensions.\n", "example": { "data": [ { @@ -22584,7 +22807,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -22625,13 +22848,13 @@ "type": "object" }, "UpscaleImageNanoBananaProRequest": { - "description": "Supply the source image either as an `image_asset_identifier`\nreference or (multipart requests only) as raw `image` bytes. Exactly\none source is required; if both forms are given, the reference is\nused and the bytes are ignored.\n", + "description": "Upload the source `image` using `multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied. The bytes are used for this request only and are not stored as an asset.", + "description": "The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -22660,7 +22883,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.", "type": "boolean" }, "webhook_url": { @@ -22684,7 +22907,7 @@ "type": "object" }, "LookbookResponse": { - "description": "Acknowledgement that the Lookbook workflow was accepted. Poll\n`GET /v1/generations/{generation_id}` for status and results.\n", + "description": "Acknowledgement that the Lookbook workflow was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -22789,7 +23012,7 @@ "type": "object" }, "ModelPoseVariantsResponse": { - "description": "Acknowledgement that pose-variant generation was accepted. Poll\n`GET /v1/generations/{generation_id}` for status and results.\n", + "description": "Acknowledgement that pose-variant generation was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -22807,13 +23030,13 @@ "type": "object" }, "ModelPoseVariantsRequest": { - "description": "Provide exactly one of `source_asset_identifier` or `source_image`.\nA pose reference can supplement the required instruction but cannot\nreplace it. The edit is full-frame; scene preservation is best effort.\n", + "description": "The edit is full-frame; scene preservation is best effort.\n", "properties": { "source_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "source_image": { - "description": "Fashion image to edit (max size 50MB), as raw bytes. JPEG, PNG,\nWEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO formats are supported.\nMultipart requests only. Provide exactly one of\n`source_asset_identifier` or `source_image`.\n", + "description": "Fashion image to edit (max size 50MB). JPEG, PNG, WEBP, HEIF,\nAVIF, GIF, BMP, TIFF, and MPO formats are supported. Multipart\nrequests only.\n", "format": "binary", "type": "string" }, @@ -22821,7 +23044,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "instruction": { - "description": "Required plain-language pose or camera direction, such as a\nfront-facing catalog stance or right-facing walking profile.\n", + "description": "Plain-language pose or camera direction, such as a front-facing\ncatalog stance or right-facing walking profile.\n", "maxLength": 4000, "minLength": 1, "type": "string" @@ -22876,7 +23099,7 @@ "type": "string" }, "PackshotsResponse": { - "description": "Acknowledgement that the packshots workflow was accepted. Poll\n`GET /v1/generations/{generation_id}` for status and results.\n", + "description": "Acknowledgement that the packshots workflow was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -22974,7 +23197,7 @@ "type": "string" }, "GhostMannequinResponse": { - "description": "Acknowledgement that the ghost-mannequin workflow was accepted. Poll\n`GET /v1/generations/{generation_id}` for status and results.\n", + "description": "Acknowledgement that the ghost-mannequin request was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -22992,7 +23215,7 @@ "type": "object" }, "GhostMannequinRequest": { - "description": "Supply at least one garment reference. Directional references are\nnullable and accept at most one of their asset-identifier or multipart\nimage fields. Additional unlabeled references can use exactly one of\n`garment_asset_identifiers` or multipart `garment_images`. Every\ngarment image must depict the same primary garment. The total number\nof garment references must not exceed 15, and all raw image uploads\ncombined must not exceed 100 MB.\n", + "description": "Supply at least one garment image. Every image must show the same\nprimary garment. At most 15 garment images are accepted in total, and all\nuploads combined must not exceed 100 MB.\n", "properties": { "garment_asset_identifiers": { "description": "Ordered uploaded or generated images of the same garment. Use\nmultiple angles when available so obscured construction can be\nreconstructed conservatively. Mutually exclusive with\n`garment_images`.\n", @@ -23004,7 +23227,7 @@ "type": "array" }, "garment_images": { - "description": "Raw images of the same garment, up to 50 MB each. JPEG, PNG, WEBP,\nHEIF, AVIF, GIF, BMP, TIFF, and MPO are supported. Multipart\nrequests only. Mutually exclusive with\n`garment_asset_identifiers`.\n", + "description": "Additional photos of the same garment, up to 50 MB each. JPEG,\nPNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported.\nMultipart requests only.\n", "items": { "format": "binary", "type": "string" @@ -23017,7 +23240,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "front_image": { - "description": "Optional raw front-view garment reference, up to 50 MB. Multipart\nrequests only. Mutually exclusive with `front_asset_identifier`.\n", + "description": "Optional front-view garment photo, up to 50 MB. Multipart requests\nonly.\n", "format": "binary", "type": "string" }, @@ -23025,7 +23248,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "back_image": { - "description": "Optional raw back-view garment reference, up to 50 MB. Multipart\nrequests only. Mutually exclusive with `back_asset_identifier`.\n", + "description": "Optional back-view garment photo, up to 50 MB. Multipart requests\nonly.\n", "format": "binary", "type": "string" }, @@ -23033,7 +23256,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "left_image": { - "description": "Optional raw left-view garment reference, up to 50 MB. Multipart\nrequests only. Mutually exclusive with `left_asset_identifier`.\n", + "description": "Optional left-view garment photo, up to 50 MB. Multipart requests\nonly.\n", "format": "binary", "type": "string" }, @@ -23041,7 +23264,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "right_image": { - "description": "Optional raw right-view garment reference, up to 50 MB. Multipart\nrequests only. Mutually exclusive with `right_asset_identifier`.\n", + "description": "Optional right-view garment photo, up to 50 MB. Multipart requests\nonly.\n", "format": "binary", "type": "string" }, @@ -23049,7 +23272,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "top_image": { - "description": "Optional raw top-view garment reference, up to 50 MB. Multipart\nrequests only. Mutually exclusive with `top_asset_identifier`.\n", + "description": "Optional top-view garment photo, up to 50 MB. Multipart requests\nonly.\n", "format": "binary", "type": "string" }, @@ -23057,7 +23280,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "bottom_image": { - "description": "Optional raw bottom-view garment reference, up to 50 MB. Multipart\nrequests only. Mutually exclusive with\n`bottom_asset_identifier`.\n", + "description": "Optional bottom-view garment photo, up to 50 MB. Multipart\nrequests only.\n", "format": "binary", "type": "string" }, @@ -23071,12 +23294,12 @@ "type": "string" }, "instruction": { - "description": "Optional reconstruction guidance or identity-critical garment\ndetails for the analyzer to verify. The output always uses the\nworkflow's clean white studio presentation.\n", + "description": "Optional reconstruction guidance or identity-critical garment\ndetails to check against the photos. The output always uses a clean\nwhite studio background.\n", "maxLength": 2000, "type": "string" }, "metadata": { - "description": "Optional JSON object serialized as a string containing factual\nproduct context, such as title, brand, category, color, material,\nitem code, and exact printed text. Metadata helps disambiguate the\ngarment references but does not add unsupported visual features.\n", + "description": "Optional JSON object serialized as a string containing factual\nproduct context, such as title, brand, category, color, material,\nitem code, and exact printed text. Metadata helps disambiguate the\ngarment photos but does not add features they do not show.\n", "maxLength": 8000, "type": "string" }, @@ -23184,6 +23407,89 @@ "title": "Product360VideoDirection", "type": "string" }, + "LivingImageResponse": { + "description": "Acknowledgement that the living image was accepted. Video generation always runs asynchronously, so the video is never part of this response: poll for it with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "example": { + "generation_id": "generation_id", + "created": "2000-01-23T04:56:07+00:00" + }, + "properties": { + "generation_id": { + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "title": "generation_id", + "type": "string" + }, + "created": { + "description": "The time the request was accepted.", + "format": "date-time", + "title": "created", + "type": "string" + } + }, + "required": [ + "created", + "generation_id" + ], + "title": "LivingImageResponse", + "type": "object" + }, + "LivingImageRequest": { + "example": { + "duration": 8, + "target_collection_id": "target_collection_id", + "image_asset_identifier": { + "asset_type": "RESPONSE", + "asset_id": "7uS_VESkRI6O3-sVgHQp_A" + }, + "quality": null + }, + "properties": { + "image_asset_identifier": { + "$ref": "#/components/schemas/AssetIdentifier" + }, + "quality": { + "$ref": "#/components/schemas/LivingImageQuality" + }, + "duration": { + "default": 8, + "description": "The length of the generated video in seconds.", + "example": 8, + "maximum": 15, + "minimum": 5, + "title": "duration", + "type": "integer" + }, + "target_collection_id": { + "description": "A collection you can write to, by its URL-safe base64 collection id. The output video is added to it when the request completes.", + "title": "target_collection_id", + "type": "string" + } + }, + "required": [ + "image_asset_identifier" + ], + "title": "LivingImageRequest", + "type": "object" + }, + "LivingImageQuality": { + "default": "standard", + "description": "The output resolution tier. `standard` renders at 768P; `high` renders at 2K. Higher tiers cost more.", + "enum": [ + "standard", + "high" + ], + "title": "LivingImageQuality", + "type": "string" + }, + "LivingImageDurationSeconds": { + "default": 8, + "description": "The length of the generated video in seconds.", + "example": 8, + "maximum": 15, + "minimum": 5, + "title": "duration", + "type": "integer" + }, "PreciseMaskedEditResponse": { "description": "Acknowledgement that the workflow was accepted.", "example": { @@ -23308,7 +23614,7 @@ "type": "string" }, "VirtualTryOnResponse": { - "description": "Acknowledgement that the try-on was accepted. Poll\n`GET /v1/generations/{generation_id}` for status and results.\n", + "description": "Acknowledgement that the try-on was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -23380,7 +23686,7 @@ "type": "object" }, "ColorwaysResponse": { - "description": "Acknowledgement that the colorway was accepted. Poll\n`GET /v1/generations/{generation_id}` for status and results.\n", + "description": "Acknowledgement that the colorway was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -23398,7 +23704,7 @@ "type": "object" }, "ColorwaysRequest": { - "description": "Supply the product photo as raw `image` bytes, and up to 4 masks with\none color per mask; a single-region edit is a one-item `masks` list\nwith a one-item `colors` list.\n", + "description": "Upload the product photo as `image` and up to 4 `masks`, with one\nentry in `colors` per mask. For a single region, send one mask and one\ncolor.\n", "properties": { "image_asset_identifier": { "allOf": [ @@ -23409,7 +23715,7 @@ "description": "The product photo to recolor, by reference. Everything outside\nthe masked region is preserved. Provide exactly one of\n`image_asset_identifier` or `image`.\n" }, "image": { - "description": "The product photo to recolor (max size 25MB), as raw bytes; only\nJPEG, PNG, and WEBP formats are supported.\n", + "description": "The product photo to recolor (max size 25MB). JPEG, PNG, and WEBP\nformats are supported.\n", "format": "binary", "type": "string" }, @@ -23423,7 +23729,7 @@ "type": "array" }, "masks": { - "description": "The masks marking the regions of the product photo to recolor\n(max 4, max size 25MB each), as raw bytes, paired by position with\n`colors`; only JPEG, PNG, and WEBP formats are supported. Every\nmask must have the same pixel dimensions as the product photo.\nWhite pixels mark the region to recolor; black pixels are\npreserved. Alpha-only masks are also supported: opaque pixels\nmark the region to recolor and transparent pixels are preserved.\n", + "description": "Masks marking the regions to recolor (max 4, max size 25MB each),\npaired by position with `colors`. JPEG, PNG, and WEBP formats are\nsupported. Every mask must have the same pixel dimensions as the\nproduct photo. White pixels mark the region to recolor and black\npixels are preserved; alpha-only masks also work (opaque =\nrecolor, transparent = preserve).\n", "items": { "format": "binary", "type": "string" @@ -23443,7 +23749,7 @@ "type": "array" }, "aspect_ratio": { - "description": "The aspect ratio of the generated image. Defaults to the aspect\nratio of the product photo when omitted, which preserves the\noriginal framing exactly. When a different ratio is requested, the\nscene is extended to fill the new shape rather than cropped, so\npart of the frame is newly generated. Supported values are `1:1`,\n`3:4`, `4:3`, `16:9`, and `9:16`.\n", + "description": "Output aspect ratio. Defaults to the product photo's aspect ratio,\nwhich keeps the original framing. A different ratio extends the\nscene to fill the new shape rather than cropping, so part of the\nframe is newly generated. Supported values are `1:1`, `3:4`,\n`4:3`, `16:9`, and `9:16`.\n", "pattern": "^(1:1|3:4|4:3|16:9|9:16)$", "type": "string" }, @@ -23483,7 +23789,7 @@ "type": "string" }, "AdLocalizerResponse": { - "description": "Acknowledgement that the workflow was accepted.", + "description": "Acknowledgement that the ad localization was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -23501,18 +23807,18 @@ "type": "object" }, "AdLocalizerRequest": { - "description": "Supply the source advertisement as either an `AssetIdentifier` reference\nor (multipart requests only) raw image bytes; provide exactly one of the\ntwo forms. Supplying both, or neither, is rejected with a 400.\n", + "description": "Upload the source ad as `image` and choose a target `language`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source advertisement to localize (max size 25MB), as raw bytes;\nonly JPEG, PNG, and WEBP formats are supported. Multipart requests\nonly. Provide exactly one of `image_asset_identifier` or `image`.\n", + "description": "The source ad to localize (max size 25MB). Its layout, logos, brand\ntype, and product are preserved, and the output keeps its shape, so\nno size or aspect ratio is needed. JPEG, PNG, and WEBP formats are\nsupported. Multipart requests only.\n", "format": "binary", "type": "string" }, "language": { - "description": "The target language the copy is rebuilt in. Arabic is rendered right-to-left.", + "description": "The target language for the copy. Arabic is rendered right-to-left. Each request covers one language; send one request per language.", "enum": [ "ar", "cs", @@ -23540,7 +23846,7 @@ "type": "string" }, "prompt": { - "description": "Optional additional direction for the localization, for example \"keep the badge in English\". It takes priority over the preservation rules for anything it explicitly asks to change.", + "description": "Optional additional direction for the localization, for example \"keep the badge in English\". Anything it explicitly asks to change takes priority over the preservation rules.", "maxLength": 2000, "type": "string" }, @@ -23595,7 +23901,7 @@ "type": "string" }, "AdResizerResponse": { - "description": "Acknowledgement that the ad resize was accepted. Poll\n`GET /v1/generations/{generation_id}` for status and results.\n", + "description": "Acknowledgement that the ad resize was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -23613,18 +23919,18 @@ "type": "object" }, "AdResizerRequest": { - "description": "Supply the source creative as either an `AssetIdentifier` reference or\n(multipart requests only) raw image bytes; provide exactly one of the\ntwo forms. Supplying both, or neither, is rejected with a 400.\n", + "description": "Upload the source creative as `image` and choose a target `resolution`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source creative to reframe (max size 25MB), as raw bytes; only\nJPEG, PNG, and WEBP formats are supported. Multipart requests only.\nProvide exactly one of `image_asset_identifier` or `image`.\n", + "description": "The source creative to reframe (max size 25MB). JPEG, PNG, and\nWEBP formats are supported. Multipart requests only.\n", "format": "binary", "type": "string" }, "resolution": { - "description": "Target ad resolution, formatted as `WIDTHxHEIGHT`. Must be one of\nthe supported ad resolutions listed above; any other value is\nrejected with a 400. Each returned image has exactly these pixel\ndimensions, whether or not a `platform` was supplied.\n", + "description": "Target ad resolution, formatted as `WIDTHxHEIGHT`. Any value not in\nthe list is rejected with a 400. Each output image has exactly these\npixel dimensions, with or without a `platform`.\n", "enum": [ "300x250", "336x280", @@ -23661,7 +23967,7 @@ "type": "string" }, "platform": { - "description": "The ad platform whose published safe zone the advertisement must\nstay inside. `google` covers YouTube and Google Ads placements;\nuse `meta_stories` or `meta_reels` for the placement-specific Meta\ngeneration bounds. Reels uses the largest rectangle contained by\nits notched safe-zone polygon. The legacy `meta` value remains\nsupported for existing callers with its conservative safe zone.\nWhen supplied, the advertisement is generated inside that\nplatform's safe zone for the requested aspect ratio and the\nremaining space is filled in around it. When omitted, the\nadvertisement fills the whole frame. Any other value is rejected\nwith a 400.\n", + "description": "The ad platform whose published safe zone the ad must stay inside.\nThe ad is generated inside the largest rectangle that fits the\nplatform's safe zone for the requested aspect ratio, and the space\naround it is filled in so the output is still exactly the requested\n`resolution`. `google` covers YouTube and Google Ads placements.\nUse `meta_stories` or `meta_reels` for Meta placements; Reels uses\nthe largest rectangle inside its notched safe zone. The legacy\n`meta` value is still supported and uses a more conservative safe\nzone. When omitted, the ad fills the whole frame and every\nsupported `resolution` is accepted. Any other value is rejected\nwith a 400.\n\nEach platform accepts only the resolutions for which it publishes a\nsafe zone; any other `resolution` is rejected with a 400:\n\n| Platform | Accepted resolutions |\n| --- | --- |\n| `google` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |\n| `tiktok` | `1920x1080`, `3840x2160`, `1080x1080`, `2400x2400`, `2880x2880`, `1080x1920`, `2160x3840` |\n| `meta_stories` | `1080x1920`, `2160x3840` |\n| `meta_reels` | `1080x1920`, `2160x3840` |\n| `meta` (legacy) | `1080x1920`, `2160x3840` |\n| `snapchat` | `1080x1920`, `2160x3840` |\n", "enum": [ "google", "meta", @@ -23719,7 +24025,7 @@ "type": "string" }, "AdVariationsResponse": { - "description": "Acknowledgement that the ad variation was accepted. Poll\n`GET /v1/generations/{generation_id}` for status and results.\n", + "description": "Acknowledgement that the ad variation was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -23737,18 +24043,18 @@ "type": "object" }, "AdVariationsRequest": { - "description": "Supply the source creative as either an `AssetIdentifier` reference or\n(multipart requests only) raw image bytes; provide exactly one of the\ntwo forms. Supplying both, or neither, is rejected with a 400.\n", + "description": "Upload the source creative as `image` and choose a `variation_type`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source creative to vary (max size 25MB), as raw bytes; only\nJPEG, PNG, and WEBP formats are supported. Multipart requests only.\nProvide exactly one of `image_asset_identifier` or `image`.\n", + "description": "The source creative to vary (max size 25MB). JPEG, PNG, and WEBP\nformats are supported. Multipart requests only. Each output keeps\nthe source's aspect ratio, capped at 3:1 between the long and short\nsides.\n", "format": "binary", "type": "string" }, "variation_type": { - "description": "The axis to vary while everything else stays on-brand. `people`\nreplaces the people in the ad with different talent. `setting`\nmoves the same subject and product to a different environment.\n`group_size` changes how many people appear. `scene` shifts the\nmoment or occasion (time of day, season, or activity).\n", + "description": "The axis to vary. `people`\nreplaces the people in the ad with different talent. `setting`\nmoves the same subject and product to a different environment.\n`group_size` changes how many people appear. `scene` shifts the\nmoment or occasion (time of day, season, or activity).\n", "enum": [ "people", "setting", @@ -23758,7 +24064,7 @@ "type": "string" }, "prompt": { - "description": "Optional direction to steer the variation, for example \"set it on a beach\" or \"make the models older\". Takes priority over the default preservation rules for anything it explicitly asks to change.", + "description": "Optional direction to steer the variation, for example \"set it on a beach\" or \"make the models older\". Anything it explicitly asks to change takes priority over the default preservation rules.", "type": "string" }, "quality": { @@ -23800,7 +24106,7 @@ "type": "string" }, "SketchToRenderResponse": { - "description": "Acknowledgement that the workflow was accepted.", + "description": "Acknowledgement that the sketch rendering was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -23818,18 +24124,18 @@ "type": "object" }, "SketchToRenderRequest": { - "description": "Supply exactly one of `sketch_asset_identifier` or multipart\n`sketch_image` bytes. The entire source is transformed from an\nillustration into a photograph; masks are not accepted.\n", + "description": "The whole sketch is transformed from an illustration into a\nphotograph; masks are not accepted.\n", "properties": { "sketch_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "sketch_image": { - "description": "Raw fashion-sketch bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP,\nTIFF, and MPO are supported, up to 50 MB. Multipart requests only.\nMutually exclusive with `sketch_asset_identifier`.\n", + "description": "The fashion sketch to render, up to 50 MB. JPEG, PNG, WEBP, HEIF,\nAVIF, GIF, BMP, TIFF, and MPO are supported. Multipart requests\nonly.\n", "format": "binary", "type": "string" }, "instruction": { - "description": "Required material and rendering direction, plus any construction\nor design details that are not legible in the sketch.\n", + "description": "Material and rendering direction, plus any construction or design\ndetails that are not legible in the sketch.\n", "maxLength": 4000, "minLength": 1, "type": "string" @@ -24343,7 +24649,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID accepted by GET /v1/generations/{generation_id}.", + "description": "URL-safe base64 ID accepted by GET /v2/generations/{generation_id}.", "title": "generation_id", "type": "string" } @@ -24459,7 +24765,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID accepted by GET /v1/generations/{generation_id}.", + "description": "URL-safe base64 ID accepted by GET /v2/generations/{generation_id}.", "title": "generation_id", "type": "string" } @@ -24577,7 +24883,7 @@ "type": "object" }, "ModelSwapResponse": { - "description": "Acknowledgement that the workflow was accepted.", + "description": "Acknowledgement that the model swap was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -24595,13 +24901,13 @@ "type": "object" }, "ModelSwapRequest": { - "description": "Provide exactly one of `source_asset_identifier` or multipart `source_image`, plus one to four ordered target-model references.", + "description": "The working image (`source_image`) plus one to four ordered target-model references. Results are full-frame edits, so exact pixel preservation is not guaranteed.", "properties": { "source_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "source_image": { - "description": "Raw working-image bytes. Supported formats and the 50 MB limit match the image upload API. Available only with `multipart/form-data`.", + "description": "The working image whose product, pose, scene, lighting, framing, and camera are preserved. Supported formats and the 50 MB limit match the image upload API. Multipart requests only.", "format": "binary", "type": "string" }, @@ -24669,7 +24975,7 @@ "type": "string" }, "MaterialSwapResponse": { - "description": "Acknowledgement that the material swap was accepted. Poll\n`GET /v1/generations/{generation_id}` for status and results.\n", + "description": "Acknowledgement that the material swap was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n", "example": { "generation_id": "generation_id" }, @@ -24687,7 +24993,7 @@ "type": "object" }, "MaterialSwapRequest": { - "description": "Supply the product photo (`image`), the masks (`masks`), and the\nmaterial references (`materials`) as raw image bytes.\n\nSupply up to 4 masks, with either one material for all of them or one\nmaterial per mask paired by position. A single-region edit is a\none-item `masks` list with a one-item material list.\n", + "description": "Upload the product photo as `image`, up to 4 `masks`, and either one\nentry in `materials` for all masks or one per mask, paired by\nposition. For a single region, send one mask and one material.\n", "properties": { "image_asset_identifier": { "allOf": [ @@ -24698,7 +25004,7 @@ "description": "The product photo to edit, by reference. Everything outside the\nmasked region is preserved. Provide exactly one of\n`image_asset_identifier` or `image`.\n" }, "image": { - "description": "The product photo to edit (max size 25MB), as raw bytes; only\nJPEG, PNG, and WEBP formats are supported.\n", + "description": "The product photo to edit (max size 25MB). JPEG, PNG, and WEBP\nformats are supported.\n", "format": "binary", "type": "string" }, @@ -24712,7 +25018,7 @@ "type": "array" }, "masks": { - "description": "The masks marking the regions of the product photo to change (max\n4, max size 25MB each), as raw bytes; only JPEG, PNG, and WEBP\nformats are supported. Every mask must have the same pixel\ndimensions as the product photo. White pixels mark the region to\nchange; black pixels are preserved. Alpha-only masks are also\nsupported: opaque pixels mark the region to change and transparent\npixels are preserved.\n", + "description": "Masks marking the regions to change (max 4, max size 25MB each).\nJPEG, PNG, and WEBP formats are supported. Every mask must have the\nsame pixel dimensions as the product photo. White pixels mark the\nregion to change and black pixels are preserved; alpha-only masks\nalso work (opaque = change, transparent = preserve).\n", "items": { "format": "binary", "type": "string" @@ -24731,7 +25037,7 @@ "type": "array" }, "materials": { - "description": "The material reference images (max size 25MB each), as raw bytes;\nonly JPEG, PNG, and WEBP formats are supported. Only their material\n— color, texture, pattern scale, and orientation — is applied to\nthe masked regions. Send one material, which every mask takes, or\nexactly one per mask paired by position.\n", + "description": "Material reference images (max size 25MB each). JPEG, PNG, and WEBP\nformats are supported. Only their material (color, texture, pattern\nscale, and orientation) is applied to the masked regions. Send one\nmaterial for every mask, or exactly one per mask, paired by\nposition.\n", "items": { "format": "binary", "type": "string" @@ -24741,7 +25047,7 @@ "type": "array" }, "aspect_ratio": { - "description": "The aspect ratio of the generated image. Defaults to the aspect\nratio of the product photo when omitted, which preserves the\noriginal framing exactly. When a different ratio is requested, the\nscene is extended to fill the new shape rather than cropped, so\npart of the frame is newly generated. Supported values are `1:1`,\n`3:4`, `4:3`, `16:9`, and `9:16`.\n", + "description": "Output aspect ratio. Defaults to the product photo's aspect ratio,\nwhich keeps the original framing. A different ratio extends the\nscene to fill the new shape rather than cropping, so part of the\nframe is newly generated. Supported values are `1:1`, `3:4`,\n`4:3`, `16:9`, and `9:16`.\n", "pattern": "^(1:1|3:4|4:3|16:9|9:16)$", "type": "string" }, @@ -24778,7 +25084,7 @@ "type": "string" }, "UpscaleToolResponse": { - "description": "Response returned by `POST /v2/image/upscale/auto`. Synchronous requests\n(the default) include the upscaled image in `data`. Requests with\n`async` set to true omit `data`; poll for completion and results with\n`GET /v1/generations/{generation_id}` using the returned\n`generation_id`. The seed reports the value the request resolved to\nwhen the caller left it unset; width and height report the output\ndimensions.\n", + "description": "Synchronous requests (the default) include the upscaled image in `data`.\nAsync requests omit `data`; poll `GET /v2/generations/{generation_id}`\nwith the returned `generation_id`. `seed` is the seed actually used,\nand `width` and `height` are the output dimensions.\n", "example": { "data": [ { @@ -24801,7 +25107,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "The generation ID to poll with `GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -24842,13 +25148,13 @@ "type": "object" }, "UpscaleToolRequest": { - "description": "Supply the source image either as an `image_asset_identifier`\nreference or (multipart requests only) as raw `image` bytes. Provide\nexactly one of the two forms; supplying both, or neither, is rejected\nwith a 400.\n", + "description": "Upload the source `image` using `multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to upscale (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`. The bytes are used for this request only and are not stored as an asset.", + "description": "The source image to upscale, in a common format such as JPEG, PNG, or WEBP, up to 50MB. Multipart requests only. The uploaded image is used for this request only and is not stored.", "format": "binary", "type": "string" }, @@ -24877,7 +25183,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request blocks until the upscaled image is ready and returns it in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` for the result.", "type": "boolean" }, "webhook_url": { @@ -24901,7 +25207,7 @@ "type": "object" }, "LayerizeDesignIdeogramV3Response": { - "description": "Response returned by `POST /v2/design/layerize/ideogram-3`.\nSynchronous requests (the default) include the layerized design in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/design/layerize/ideogram-3`.\nSynchronous requests (the default) include the layerized design in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -25018,7 +25324,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -25164,13 +25470,13 @@ "type": "object" }, "LayerizeDesignIdeogramV3Request": { - "description": "Supply the source image either as an `image_asset_identifier`\nreference or (multipart requests only) as raw `image` bytes. Provide\nexactly one of the two forms; supplying both, or neither, is rejected\nwith a 400.\n", + "description": "A request to layerize the text in one image. Upload the source image\nas `image` using `multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to layerize (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`.", + "description": "The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only.", "format": "binary", "type": "string" }, @@ -25198,7 +25504,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until layerization is complete and returns the result in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until layerization is complete and returns the result in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -25282,13 +25588,13 @@ "type": "object" }, "DescribeImageIdeogramV3Request": { - "description": "Supply the source image either as an `image_asset_identifier`\nreference or (multipart requests only) as raw `image` bytes. Provide\nexactly one of the two forms; supplying both, or neither, is rejected\nwith a 400.\n", + "description": "A request to describe one image. Upload the image as `image` using\n`multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`.", + "description": "The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only.", "format": "binary", "type": "string" } @@ -25394,36 +25700,36 @@ "type": "object" }, "DescribeImageIdeogramV4Request": { - "description": "Supply the source image either as an `image_asset_identifier`\nreference or (multipart requests only) as raw `image` bytes. Provide\nexactly one of the two forms; supplying both, or neither, is rejected\nwith a 400.\n", + "description": "A request to describe one image. Upload the image as `image` using\n`multipart/form-data`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`.", + "description": "The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only.", "format": "binary", "type": "string" }, "include_bbox": { "default": true, - "description": "Whether to include bounding boxes on the subjects and texts of the returned `json_prompt`. Defaults to true so the prompt preserves the spatial layout of the described image.", + "description": "Whether to include bounding boxes for the subjects and text in the returned `json_prompt`. Defaults to true, so the prompt preserves the layout of the described image.", "type": "boolean" }, "include_style_descriptions": { "default": false, - "description": "Whether to include a free-form style description on the returned `json_prompt`. Defaults to false.", + "description": "Whether to include a free-form style description in the returned `json_prompt`. Defaults to false.", "type": "boolean" }, "include_tags": { "default": false, - "description": "Whether to include the captioner's free-form tags on the returned `json_prompt`. Defaults to false.", + "description": "Whether to include free-form tags in the returned `json_prompt`. Defaults to false.", "type": "boolean" } }, "type": "object" }, "GenerateImageIdeogramV3Response": { - "description": "Response returned by `POST /v2/image/generate/ideogram-3`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/ideogram-3`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -25446,7 +25752,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -25534,7 +25840,7 @@ "type": "string" }, "negative_prompt": { - "description": "Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt.", + "description": "Description of what to exclude from the images. The prompt takes precedence over the negative prompt.", "maxLength": 10000, "type": "string" }, @@ -25605,11 +25911,11 @@ "description": "A predefined style preset to apply to the generated images. Cannot be combined with style codes or style references." }, "style_reference_collection_id": { - "description": "A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_asset_identifiers` or `style_reference_images`.", + "description": "A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_images`.", "type": "string" }, "style_reference_collection_version_id": { - "description": "Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it.", + "description": "Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it.", "type": "string" }, "style_reference_asset_identifiers": { @@ -25622,7 +25928,7 @@ "type": "array" }, "style_reference_images": { - "description": "Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `style_reference_collection_id` or `style_reference_asset_identifiers`.", + "description": "Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP).", "items": { "format": "binary", "type": "string" @@ -25631,13 +25937,13 @@ "type": "array" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -25664,7 +25970,7 @@ "type": "object" }, "GenerateImageIdeogramV3CustomModelResponse": { - "description": "Response returned by `POST /v2/image/generate/ideogram-3-custom-model`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/ideogram-3-custom-model`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -25687,7 +25993,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -25724,7 +26030,7 @@ "type": "string" }, "custom_model_uri": { - "description": "The custom model URI returned by the custom-model API, in the form `model//version/`. The authenticated user or organization must have access to the model.", + "description": "The custom model URI, in the form `model//version/`. You or your organization must have access to the model. The model determines which rendering speeds are supported and whether backgrounds are removed automatically.", "example": "model/my-custom-model/version/1", "maxLength": 512, "minLength": 1, @@ -25732,7 +26038,7 @@ "type": "string" }, "negative_prompt": { - "description": "Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt.", + "description": "Description of what to exclude from the images. The prompt takes precedence over the negative prompt.", "maxLength": 10000, "type": "string" }, @@ -25751,7 +26057,7 @@ "$ref": "#/components/schemas/IdeogramV3AspectRatio" }, "rendering_speed": { - "description": "The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model.", + "description": "The rendering speed to use. When omitted, a speed supported by the custom model is used.", "enum": [ "turbo", "default", @@ -25808,7 +26114,7 @@ "type": "array" }, "style_reference_images": { - "description": "Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only. Cannot be combined with `style_reference_asset_identifiers`.", + "description": "Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only.", "items": { "format": "binary", "type": "string" @@ -25817,13 +26123,13 @@ "type": "array" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -25851,7 +26157,7 @@ "type": "object" }, "GenerateImageIdeogramV4Response": { - "description": "Response returned by `POST /v2/image/generate/ideogram-4`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/ideogram-4`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -25874,7 +26180,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -25918,11 +26224,18 @@ }, "properties": { "prompt": { - "description": "The prompt to generate images from. Accepts either natural\nlanguage or a structured Ideogram 4.0 JSON prompt; the server\ndetects which was supplied. A structured JSON prompt is consumed\nby the model directly and skips magic prompt.\n", + "description": "The prompt to generate images from, in natural language or as a\nstructured Ideogram 4.0 JSON prompt. A structured JSON prompt is\nused as is and skips magic prompt.\n", "maxLength": 10000, "minLength": 1, "title": "prompt", - "type": "string" + "type": "string", + "x-playground-field": { + "label": "Prompt", + "control": "textarea", + "order": 1, + "default": "A cinematic product shot of a tabby cat sleeping on a modern couch, soft daylight, rich texture, highly detailed.", + "placeholder": "Describe the image you want to generate." + } }, "magic_prompt": { "allOf": [ @@ -25931,7 +26244,7 @@ } ], "default": "auto", - "description": "Controls how a natural-language prompt is prepared. `auto` (the\ndefault) and `on` rewrite and expand the prompt before\ngeneration. `off` keeps your wording and only converts the prompt\ninto the structured format the model consumes. A prompt that is\nalready a valid structured JSON prompt skips magic prompt\nentirely unless `magic_prompt` is `on`.\n", + "description": "Controls how a natural-language prompt is prepared. `auto` (the\ndefault) and `on` rewrite and expand the prompt before generation.\n`off` keeps your wording and only converts it into a structured\nprompt. A valid structured JSON prompt skips magic prompt unless\n`magic_prompt` is `on`.\n", "title": "magic_prompt" }, "seed": { @@ -25956,8 +26269,19 @@ "$ref": "#/components/schemas/ResolutionV4" } ], - "description": "Optional. When supplied, the images are generated at this\nresolution. When omitted, the server picks an aspect ratio\nautomatically based on the prompt.\n", - "title": "resolution" + "description": "Optional. When supplied, the images are generated at this\nresolution. When omitted, an aspect ratio is picked automatically\nbased on the prompt.\n", + "title": "resolution", + "x-playground-field": { + "label": "Resolution", + "order": 2, + "default": "2048x2048", + "enum_subset": [ + "2048x2048", + "1440x2880", + "2880x1440", + "1664x2496" + ] + } }, "rendering_speed": { "default": "default", @@ -25968,17 +26292,37 @@ "quality" ], "title": "rendering_speed", - "type": "string" + "type": "string", + "x-playground-field": { + "label": "Rendering speed", + "order": 3, + "default": "default", + "enum_subset": [ + "default", + "turbo", + "quality" + ], + "labels": { + "default": "Default", + "turbo": "Turbo", + "quality": "Quality" + } + } }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "title": "enable_copyright_detection", - "type": "boolean" + "type": "boolean", + "x-playground-field": { + "label": "Copyright detection", + "order": 4, + "default": false + } }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "title": "async", "type": "boolean" }, @@ -26009,7 +26353,7 @@ "type": "object" }, "GenerateImageIdeogramV4CustomModelResponse": { - "description": "Response returned by `POST /v2/image/generate/ideogram-4-custom-model`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/ideogram-4-custom-model`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -26032,7 +26376,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -26083,14 +26427,14 @@ }, "properties": { "prompt": { - "description": "The prompt to generate images from. Accepts either natural\nlanguage or a structured Ideogram 4.0 JSON prompt; the server\ndetects which was supplied. A structured JSON prompt is consumed\nby the model directly and skips magic prompt.\n", + "description": "The prompt to generate images from, in natural language or as a\nstructured Ideogram 4.0 JSON prompt. A structured JSON prompt is\nused as is and skips magic prompt.\n", "maxLength": 10000, "minLength": 1, "title": "prompt", "type": "string" }, "custom_model_uri": { - "description": "The custom model URI returned by the custom-model API, in the form `model//version/`. The authenticated user or organization must have access to the model.", + "description": "The custom model URI, in the form `model//version/`. You or your organization must have access to the model. The model determines which rendering speeds are supported.", "example": "model/my-custom-v4-model/version/1", "maxLength": 512, "minLength": 1, @@ -26121,7 +26465,7 @@ } ], "default": "auto", - "description": "Controls how a natural-language prompt is prepared. `auto` (the\ndefault) and `on` rewrite and expand the prompt before generation.\n`off` keeps your wording and only converts the prompt into the\nstructured format the model consumes. A prompt that is already a\nvalid structured JSON prompt skips magic prompt entirely unless\n`magic_prompt` is `on`.\n", + "description": "Controls how a natural-language prompt is prepared. `auto` (the\ndefault) and `on` rewrite and expand the prompt before generation.\n`off` keeps your wording and only converts it into a structured\nprompt. A valid structured JSON prompt skips magic prompt unless\n`magic_prompt` is `on`.\n", "title": "magic_prompt" }, "seed": { @@ -26146,11 +26490,11 @@ "$ref": "#/components/schemas/ResolutionV4" } ], - "description": "Optional. When supplied, the images are generated at this\nresolution. When omitted, the server picks an aspect ratio\nautomatically based on the prompt.\n", + "description": "Optional. When supplied, the images are generated at this\nresolution. When omitted, an aspect ratio is picked automatically\nbased on the prompt.\n", "title": "resolution" }, "rendering_speed": { - "description": "The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model.", + "description": "The rendering speed to use. When omitted, a speed supported by the custom model is used.", "enum": [ "turbo", "default", @@ -26160,14 +26504,14 @@ "type": "string" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "title": "enable_copyright_detection", "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "title": "async", "type": "boolean" }, @@ -26227,7 +26571,7 @@ "type": "object" }, "RemixImageIdeogramV3Response": { - "description": "Response returned by `POST /v2/image/remix/ideogram-3`.\nSynchronous requests (the default) include the remixed images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/remix/ideogram-3`.\nSynchronous requests (the default) include the remixed images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v2/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", "example": { "data": [ { @@ -26250,7 +26594,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n", "title": "generation_id", "type": "string" }, @@ -26346,7 +26690,7 @@ "description": "The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first." }, "image": { - "description": "The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image.", + "description": "The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first.", "format": "binary", "type": "string" }, @@ -26428,7 +26772,7 @@ "description": "A predefined style preset to apply to the remixed images. Cannot be combined with style codes or style references." }, "style_reference_collection_id": { - "description": "A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_asset_identifiers` or `style_reference_images`.", + "description": "A saved style to apply, by its URL-safe base64 collection id. Cannot be combined with `style_reference_images`.", "type": "string" }, "style_reference_collection_version_id": { @@ -26445,7 +26789,7 @@ "type": "array" }, "style_reference_images": { - "description": "Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `style_reference_collection_id` or `style_reference_asset_identifiers`.", + "description": "Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported.", "items": { "format": "binary", "type": "string" @@ -26460,7 +26804,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.", "type": "boolean" }, "webhook_url": { @@ -26487,7 +26831,7 @@ "type": "object" }, "RemixImageIdeogramV3CustomModelResponse": { - "description": "Response returned by `POST /v2/image/remix/ideogram-3-custom-model`.\nSynchronous requests (the default) include the remixed images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/remix/ideogram-3-custom-model`.\nSynchronous requests (the default) include the remixed images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v2/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", "example": { "data": [ { @@ -26510,7 +26854,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n", "title": "generation_id", "type": "string" }, @@ -26563,7 +26907,7 @@ "description": "The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first." }, "image": { - "description": "The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image.", + "description": "The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first.", "format": "binary", "type": "string" }, @@ -26650,7 +26994,7 @@ "type": "array" }, "style_reference_images": { - "description": "Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `style_reference_asset_identifiers` is also supplied.", + "description": "Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Multipart requests only.", "items": { "format": "binary", "type": "string" @@ -26665,7 +27009,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.", "type": "boolean" }, "webhook_url": { @@ -26693,7 +27037,7 @@ "type": "object" }, "RemixImageIdeogramV4Response": { - "description": "Response returned by `POST /v2/image/remix/ideogram-4`.\nSynchronous requests (the default) include the remixed images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to.\n", + "description": "Response returned by `POST /v2/image/remix/ideogram-4`.\nSynchronous requests (the default) include the remixed images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v2/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to.\n", "example": { "data": [ { @@ -26716,7 +27060,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n", "title": "generation_id", "type": "string" }, @@ -26745,12 +27089,20 @@ "type": "object" }, "RemixImageIdeogramV4Request": { + "description": "Remixes are not reproducible, so no `seed` is accepted; the response\nreports the seed that was used.\n", "properties": { "prompt": { - "description": "The prompt that guides the remix.", + "description": "The prompt that guides the remix. It is always read as an editing instruction, so there is no `magic_prompt` option.", "maxLength": 10000, "minLength": 1, - "type": "string" + "type": "string", + "x-playground-field": { + "label": "Prompt", + "control": "textarea", + "order": 3, + "default": "Restyle this image as a vibrant watercolor painting.", + "placeholder": "Describe how to remix the image." + } }, "image_asset_identifier": { "allOf": [ @@ -26758,18 +27110,36 @@ "$ref": "#/components/schemas/AssetIdentifier" } ], - "description": "The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` to keep its shape." + "description": "The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` to keep its shape.", + "x-playground-field": { + "label": "Image asset identifier", + "control": "json", + "order": 2, + "group": "source", + "placeholder": "{\"asset_type\":\"UPLOAD\",\"asset_id\":\"...\"}" + } }, "image": { - "description": "The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image.", + "description": "The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` to keep its shape.", "format": "binary", - "type": "string" + "type": "string", + "x-playground-field": { + "label": "Image upload", + "order": 1, + "group": "source" + } }, "image_weight": { - "description": "Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining image_weight with a resolution whose aspect ratio differs from the source's is rejected with a 400.", + "description": "Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image's shape: combining `image_weight` with a `resolution` whose aspect ratio differs from the source's is rejected with a 400.", "maximum": 100, "minimum": 1, - "type": "integer" + "type": "integer", + "x-playground-field": { + "label": "Image weight", + "control": "slider", + "order": 4, + "step": 1 + } }, "num_images": { "default": 1, @@ -26784,7 +27154,7 @@ "$ref": "#/components/schemas/ResolutionV4" } ], - "description": "Optional. When supplied, the images are generated at this\nresolution. When omitted, the source image's shape is kept. A\nresolution whose aspect ratio differs from the source's cannot\nbe combined with image_weight.\n" + "description": "Optional. When supplied, the images are generated at this\nresolution. When omitted, the source image's shape is kept. A\nresolution whose aspect ratio differs from the source's cannot\nbe combined with `image_weight`.\n" }, "rendering_speed": { "default": "default", @@ -26794,16 +27164,36 @@ "default", "quality" ], - "type": "string" + "type": "string", + "x-playground-field": { + "label": "Rendering speed", + "order": 5, + "default": "default", + "enum_subset": [ + "default", + "turbo", + "quality" + ], + "labels": { + "default": "Default", + "turbo": "Turbo", + "quality": "Quality" + } + } }, "enable_copyright_detection": { "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", "nullable": true, - "type": "boolean" + "type": "boolean", + "x-playground-field": { + "label": "Copyright detection", + "order": 6, + "default": false + } }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.", "type": "boolean" }, "webhook_url": { @@ -26830,7 +27220,7 @@ "type": "object" }, "RemixImageIdeogramV3CharacterResponse": { - "description": "Response returned by `POST /v2/image/remix/ideogram-3-character`.\nSynchronous requests (the default) include the remixed images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/remix/ideogram-3-character`.\nSynchronous requests (the default) include the remixed images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v2/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", "example": { "data": [ { @@ -26853,7 +27243,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n", "title": "generation_id", "type": "string" }, @@ -26882,7 +27272,7 @@ "type": "object" }, "RemixImageIdeogramV3CharacterRequest": { - "description": "Supply the character as a saved character collection, as asset\nidentifiers, or (multipart requests only) as raw image bytes. Exactly\none character is supported per request; if more than one form is\ngiven, the collection is used over the identifiers, and the\nidentifiers over the bytes.\n", + "description": "Upload one character reference as `character_reference_images` using\n`multipart/form-data`.\n", "properties": { "prompt": { "description": "The prompt that guides the remix.", @@ -26899,7 +27289,7 @@ "description": "The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first." }, "image": { - "description": "The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are stored as a new image asset in your account, since the remix keeps a durable link to its source image.", + "description": "The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit `resolution` and `aspect_ratio` to keep its shape; a different requested shape center-crops the source to fit first.", "format": "binary", "type": "string" }, @@ -26915,7 +27305,7 @@ "type": "string" }, "character_reference_collection_id": { - "description": "A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied.", + "description": "A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied.", "type": "string" }, "character_reference_collection_version_id": { @@ -26932,7 +27322,7 @@ "type": "array" }, "character_reference_images": { - "description": "An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied.", + "description": "An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported.", "items": { "format": "binary", "type": "string" @@ -26996,7 +27386,7 @@ "type": "string" }, "style_reference_collection_id": { - "description": "A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied.", + "description": "A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied.", "type": "string" }, "style_reference_collection_version_id": { @@ -27013,7 +27403,7 @@ "type": "array" }, "style_reference_images": { - "description": "Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied.", + "description": "Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported.", "items": { "format": "binary", "type": "string" @@ -27028,7 +27418,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.", "type": "boolean" }, "webhook_url": { @@ -27055,7 +27445,7 @@ "type": "object" }, "GenerateImageIdeogramV3TransparentResponse": { - "description": "Response returned by\n`POST /v2/image/generate/ideogram-3-transparent`. Synchronous\nrequests (the default) include the generated images in `data`.\nRequests with `async` set to true omit `data`; poll for completion\nand results with `GET /v1/generations/{generation_id}` using the\nreturned `generation_id`. The seed reports the value the request\nresolved to when the caller left it unset.\n", + "description": "Response returned by\n`POST /v2/image/generate/ideogram-3-transparent`. Synchronous\nrequests (the default) include the generated images in `data`.\nAsynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -27078,7 +27468,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -27131,7 +27521,7 @@ "type": "string" }, "negative_prompt": { - "description": "Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt.", + "description": "Description of what to exclude from the images. The prompt takes precedence over the negative prompt.", "maxLength": 10000, "title": "negative_prompt", "type": "string" @@ -27188,14 +27578,14 @@ "type": "integer" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "title": "enable_copyright_detection", "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "title": "async", "type": "boolean" }, @@ -27226,7 +27616,7 @@ "type": "object" }, "GenerateImageIdeogramV4TransparentResponse": { - "description": "Response returned by\n`POST /v2/image/generate/ideogram-4-transparent`. Synchronous\nrequests (the default) include the generated images in `data`.\nRequests with `async` set to true omit `data`; poll for completion\nand results with `GET /v1/generations/{generation_id}` using the\nreturned `generation_id`. The seed reports the value the request\nresolved to when the caller left it unset.\n", + "description": "Response returned by\n`POST /v2/image/generate/ideogram-4-transparent`. Synchronous\nrequests (the default) include the generated images in `data`.\nAsynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -27249,7 +27639,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -27294,7 +27684,7 @@ }, "properties": { "prompt": { - "description": "The prompt to generate images from. Accepts either natural\nlanguage or a structured Ideogram 4.0 JSON prompt; the server\ndetects which was supplied. A structured JSON prompt is consumed\nby the model directly and skips magic prompt, except that its\nbackground description is replaced with a transparent-background\ndirective.\n", + "description": "The prompt to generate images from, in natural language or as a\nstructured Ideogram 4.0 JSON prompt. A structured JSON prompt is\nused as is and skips magic prompt, except that its background\ndescription is replaced with a transparent background.\n", "maxLength": 10000, "minLength": 1, "title": "prompt", @@ -27307,7 +27697,7 @@ } ], "default": "auto", - "description": "Controls how a natural-language prompt is prepared. `auto` (the\ndefault) and `on` rewrite and expand the prompt before\ngeneration. `off` keeps your wording and only converts the prompt\ninto the structured format the model consumes. A prompt that is\nalready a valid structured JSON prompt skips magic prompt\nentirely unless `magic_prompt` is `on`.\n", + "description": "Controls how a natural-language prompt is prepared. `auto` (the\ndefault) and `on` rewrite and expand the prompt before generation.\n`off` keeps your wording and only converts it into a structured\nprompt. A valid structured JSON prompt skips magic prompt unless\n`magic_prompt` is `on`.\n", "title": "magic_prompt" }, "seed": { @@ -27331,7 +27721,7 @@ }, "output_resolution": { "default": "1k", - "description": "The output resolution tier for the generated images. Tiers are\ntotal-pixel budgets matching a square of the named size (for\nexample, `8k` delivers at most 8192x8192 total pixels); wide and\ntall aspect ratios keep the same pixel budget, so a single\ndimension may exceed the named size. Defaults to 1k.\n", + "description": "The output resolution tier. Each tier is a total pixel budget equal\nto a square of the named size (for example, `8k` delivers at most\n8192x8192 pixels in total). Wide and tall aspect ratios keep the\nsame budget, so one side may exceed the named size. Tiers above\n2k are produced by upscaling after generation. Defaults to 1k.\n", "enum": [ "1k", "2k", @@ -27353,14 +27743,14 @@ "type": "string" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "title": "enable_copyright_detection", "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "title": "async", "type": "boolean" }, @@ -27391,7 +27781,7 @@ "type": "object" }, "GenerateImagePImageIdeogramResponse": { - "description": "Response returned by `POST /v2/image/generate/p-image-ideogram`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/p-image-ideogram`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -27414,7 +27804,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -27461,7 +27851,7 @@ }, "properties": { "prompt": { - "description": "The prompt to generate images from. Accepts either natural\nlanguage or a structured Ideogram 4.0 JSON prompt; the server\ndetects which was supplied.\n", + "description": "The prompt to generate images from, in natural language or as a\nstructured Ideogram 4.0 JSON prompt.\n", "maxLength": 10000, "minLength": 1, "title": "prompt", @@ -27504,7 +27894,7 @@ "title": "quality" }, "resolution": { - "description": "The output-size tier; the server defaults to `1k` when omitted. Cannot be combined with `custom_width`/`custom_height`.", + "description": "The output size tier. Defaults to `1k`. Cannot be combined with `custom_width`/`custom_height`.", "enum": [ "1k", "2k" @@ -27536,14 +27926,14 @@ "type": "integer" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "title": "enable_copyright_detection", "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "title": "async", "type": "boolean" }, @@ -27574,7 +27964,7 @@ "type": "object" }, "GenerateImageZImageResponse": { - "description": "Response returned by `POST /v2/image/generate/z-image`. Synchronous\nrequests (the default) include the generated images in `data`.\nRequests with `async` set to true omit `data`; poll for completion\nand results with `GET /v1/generations/{generation_id}` using the\nreturned `generation_id`. The seed reports the value the request\nresolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/z-image`. Synchronous\nrequests (the default) include the generated images in `data`.\nAsynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -27597,7 +27987,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -27654,7 +28044,7 @@ "type": "string" }, "num_inference_steps": { - "description": "Optional diffusion step count. When omitted, the server uses the\nmodel's default. Higher values trade latency for quality.\n", + "description": "Optional number of diffusion steps. When omitted, the model's\ndefault is used. Higher values improve quality but take longer.\n", "example": 8, "maximum": 128, "minimum": 1, @@ -27680,7 +28070,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "title": "async", "type": "boolean" }, @@ -27711,7 +28101,7 @@ "type": "object" }, "GenerateImageIdeogram45Response": { - "description": "Response returned by `POST /v2/image/generate/ideogram-4-5`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/ideogram-4-5`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -27734,7 +28124,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -27763,13 +28153,20 @@ "type": "object" }, "GenerateImageIdeogram45Request": { - "description": "Source images are optional. When supplied, the request becomes an\nimage-to-image transform and `size` defaults to \"auto\" (derived from\nthe first source). A prompt is required either way.\n", + "description": "Source `images` are optional. When supplied, the request edits them\nand `size` defaults to \"auto\". A prompt is required either way.\n", "properties": { "prompt": { - "description": "The prompt to generate images from, or the edit instruction to\napply when source images are supplied. Accepts either natural\nlanguage or a structured Ideogram 4.0 JSON prompt; the server\ndetects which was supplied.\n", + "description": "The prompt to generate images from, or the edit instruction when\nsource images are supplied. Natural language or a structured\nIdeogram 4.0 JSON prompt.\n", "maxLength": 10000, "minLength": 1, - "type": "string" + "type": "string", + "x-playground-field": { + "label": "Prompt", + "control": "textarea", + "order": 1, + "default": "A cinematic product shot of a tabby cat sleeping on a modern couch, soft daylight, rich texture, highly detailed.", + "placeholder": "Describe the image you want to generate." + } }, "magic_prompt": { "allOf": [ @@ -27778,7 +28175,7 @@ } ], "default": "auto", - "description": "Controls how a natural-language prompt is prepared. `auto` (the\ndefault) and `on` rewrite and expand the prompt before\ngeneration. `off` keeps your wording and only converts the prompt\ninto the structured format the model consumes. A prompt that is\nalready a valid structured JSON prompt skips magic prompt\nentirely unless `magic_prompt` is `on`. With source images the\nprompt is an edit instruction, and every mode converts it into\nthe structured edit contract the model consumes.\n" + "description": "Controls how a natural-language prompt is prepared. `auto` (the\ndefault) and `on` rewrite and expand the prompt before generation.\n`off` keeps your wording and only converts it into a structured\nprompt. A valid structured JSON prompt skips magic prompt unless\n`magic_prompt` is `on`. With source images, every mode converts\nthe edit instruction into a structured edit prompt.\n" }, "image_asset_identifiers": { "description": "Existing upload or generated image assets to transform, by reference. Takes priority over `images` if both are supplied. The first source is the primary image; any further sources are additional references. Supplying sources turns the request into an image-to-image transform.", @@ -27790,7 +28187,7 @@ "type": "array" }, "images": { - "description": "The source images to transform (max 5, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied.", + "description": "Optional source images to edit (max 5, max 25MB each; JPEG, PNG, or WEBP). The first image is the one being edited; any others are extra references. Multipart requests only.", "items": { "format": "binary", "type": "string" @@ -27799,26 +28196,59 @@ "type": "array" }, "mask": { - "description": "An optional mask confining the edit to part of the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as the first source image, and must contain both black and white areas. Requires source images uploaded as raw `images` bytes; masks cannot be combined with `image_asset_identifiers`. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three other source images. Supplying a mask fixes the output to the first source's own size, so `size` is rejected alongside it.", + "description": "An optional mask that limits the edit to part of the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the first source image and contain both black and white areas. A masked request can include at most three other source images. With a mask, the output is always the first source image's own size, so `size` cannot be set.", "format": "binary", "type": "string" }, "size": { "default": "auto", - "description": "The output size: \"auto\", \"source\" or an exact \"WIDTHxHEIGHT\".\n\nWithout source images, an exact size must be one of the supported\n1K/2K presets (for example 1024x1024, 2048x2048 or 1440x2880);\n\"auto\" or omitted lets the server pick a supported size based on\nthe prompt. \"source\" is rejected because there is no source image\nto size from.\n\nWith source images, \"auto\" (the default) lets the server pick a\nsupported 2K size from the source images and the prompt, and\n\"source\" returns the output at the first source image's own width\nand height. With \"source\", a source too large for the model is\nscaled down to fit while keeping its exact proportion. Whatever the\nsize, every source image's aspect ratio must be between 1:6 and\n6:1; the model does not accept a reference outside that range.\n\nAn exact size must have both dimensions multiples of 32 and at least\n256px, the total size at most 2048x2048 pixels, and the aspect ratio\nat most 6:1. Naming one reshapes the source to it.\n\nPricing is tiered by the resolved output pixels: up to 1024x1024\nbills as 1K, above that as 2K. An \"auto\" size bills as 2K.\n", + "description": "The output size: \"auto\", \"source\" or an exact \"WIDTHxHEIGHT\".\n\nWithout source images, an exact size must be one of the supported\n1K/2K presets (for example 1024x1024, 2048x2048 or 1440x2880);\n\"auto\" or omitted picks a supported size based on the prompt.\n\"source\" is rejected.\n\nWith source images, \"auto\" (the default) picks a supported 2K size\nbased on the source images and the prompt, and \"source\" returns the\noutput at the first source image's own width and height (scaled\ndown, keeping its proportions, if it is too large for the model).\nEvery source image's aspect ratio must be between 1:6 and 6:1.\n\nAn exact size must have both sides a multiple of 32 and at least\n256px, a total of at most 2048x2048 pixels, and an aspect ratio of\nat most 6:1. With source images, an exact size reshapes the source\nto it.\n\nPricing is tiered by the resolved output pixels: up to 1024x1024\nbills as 1K, above that as 2K. An \"auto\" size bills as 2K.\n", "example": "2048x2048", "nullable": true, - "type": "string" + "type": "string", + "x-playground-field": { + "label": "Size", + "control": "select", + "order": 2, + "default": "auto", + "enum_subset": [ + "auto", + "1024x1024", + "2048x2048", + "2560x1440", + "1440x2560", + "2496x1664", + "1664x2496" + ], + "labels": { + "auto": "Auto (from the prompt)" + } + } }, "quality": { - "description": "The rendering quality to use. Higher quality renders take longer. With source images it defaults to `medium`, and `high` takes longer and is priced higher; `very_low` requires source images and is the fastest and cheapest. Without source images it defaults to `high`.", + "description": "The rendering quality to use. Higher quality takes longer and costs more. Defaults to `medium` with source images and `high` without. `very_low`, the fastest and cheapest, requires source images.", "enum": [ "very_low", "low", "medium", "high" ], - "type": "string" + "type": "string", + "x-playground-field": { + "label": "Quality", + "order": 3, + "default": "high", + "enum_subset": [ + "high", + "medium", + "low" + ], + "labels": { + "high": "High", + "medium": "Medium", + "low": "Low" + } + } }, "seed": { "description": "Random seed. Set for reproducible generation.", @@ -27836,13 +28266,18 @@ "type": "integer" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, - "type": "boolean" + "type": "boolean", + "x-playground-field": { + "label": "Copyright detection", + "order": 4, + "default": false + } }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -27869,7 +28304,7 @@ "type": "object" }, "PreciseEditImageIdeogram45Response": { - "description": "Response returned by `POST /v2/image/precise-edit/ideogram-4-5`.\nSynchronous requests (the default) include the edited images in `data`.\nRequests with `async` set to true omit `data`; poll for completion and\nresults with `GET /v1/generations/{generation_id}` using the returned\n`generation_id`. The seed reports the value the request resolved to\nwhen the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/precise-edit/ideogram-4-5`.\nSynchronous requests (the default) include the edited images in `data`.\nAsynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`.\n", "example": { "data": [ { @@ -27892,7 +28327,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -27905,7 +28340,7 @@ "type": "array" }, "seed": { - "description": "The seed the request was served with.", + "description": "The seed that was used, including when you did not set one.", "title": "seed", "type": "integer" } @@ -27914,10 +28349,10 @@ "type": "object" }, "PreciseEditImageIdeogram45Request": { - "description": "The image being edited is required, as an `image_asset_identifier`\nreference or as raw `image` bytes. The output is always returned at\nthat image's exact width and height, so this request takes no output\nsize.\n", + "description": "A request to edit one image. The `image` to edit is required. The\noutput is always returned at that image's exact width and height, so\nthis request takes no output size.\n", "properties": { "prompt": { - "description": "The edit instruction to apply to the sources. Accepts either\nnatural language or a structured JSON prompt; the server detects\nwhich was supplied. Natural language is automatically rewritten\ninto the model's structured edit contract, while structured JSON\nis consumed directly.\n", + "description": "The edit instruction, in natural language or as a structured JSON\nprompt. Natural language is automatically converted into a\nstructured prompt; valid structured JSON is used as is.\n", "maxLength": 10000, "minLength": 1, "type": "string" @@ -27931,7 +28366,7 @@ "description": "The image to edit, as an existing upload or generated image asset. Supply this or `image`, never both. Takes priority over `image` if both are supplied. Cannot be combined with `mask`." }, "image": { - "description": "The image to edit, as raw bytes (max size 25MB; JPEG, PNG, or WEBP only). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask`.", + "description": "The image to edit (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it. Images too large for the model are scaled down, keeping their proportions, and returned as rendered. Images with an aspect ratio outside 1:6 to 6:1 are rejected.", "format": "binary", "type": "string" }, @@ -27945,7 +28380,7 @@ "type": "array" }, "reference_images": { - "description": "Optional additional images to guide the edit (max 4, max size 25MB each), as raw bytes; only JPEG, PNG, and WEBP formats are supported. These are never edited themselves; only `image` is. Multipart requests only; ignored if `reference_image_asset_identifiers` is also supplied. A masked request may carry at most three, because the mask occupies one of the model's reference slots.", + "description": "Optional images to guide the edit (max 4, max 25MB each; JPEG, PNG, or WEBP). They are never edited themselves; only `image` is. Multipart requests only. A request with a `mask` can include at most three, because the mask takes up one reference slot.", "items": { "format": "binary", "type": "string" @@ -27954,7 +28389,7 @@ "type": "array" }, "mask": { - "description": "An optional mask confining the edit to part of `image`, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Black marks the area to edit and white the area to preserve; values in between are rounded to whichever is nearer. The mask must have the same width and height as `image`, and must contain both black and white areas. Requires the image being edited to be uploaded as raw `image` bytes in the same request; masks cannot be combined with asset references. The mask is supplied to the model as an additional reference image, so a masked request may carry at most three `reference_images`.", + "description": "An optional mask that limits the edit to part of `image` (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. A masked request can include at most three `reference_images`.", "format": "binary", "type": "string" }, @@ -27985,13 +28420,13 @@ "type": "integer" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -28018,7 +28453,7 @@ "type": "object" }, "GenerateImageNanoBanana2Response": { - "description": "Response returned by `POST /v2/image/generate/nano-banana-2`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/nano-banana-2`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -28041,7 +28476,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -28070,10 +28505,10 @@ "type": "object" }, "GenerateImageNanoBanana2Request": { - "description": "Source images are optional. When supplied (as `image_asset_identifiers`\nreferences, or as raw `images` bytes in multipart requests), the prompt\nis applied to the sources as an edit; if both forms are given, the\nreferences are used and the bytes are ignored. Without source images\nthe prompt alone drives the generation.\n", + "description": "Source `images` are optional. When supplied, the prompt is applied to\nthem as an edit. Without source images, the output is generated from\nthe prompt alone.\n", "properties": { "prompt": { - "description": "The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting.", + "description": "The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written.", "maxLength": 10000, "minLength": 1, "type": "string" @@ -28088,7 +28523,7 @@ "type": "array" }, "images": { - "description": "The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied.", + "description": "Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only.", "items": { "format": "binary", "type": "string" @@ -28127,7 +28562,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -28154,7 +28589,7 @@ "type": "object" }, "GenerateImageNanoBananaProResponse": { - "description": "Response returned by `POST /v2/image/generate/nano-banana-pro`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/nano-banana-pro`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -28177,7 +28612,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -28206,10 +28641,10 @@ "type": "object" }, "GenerateImageNanoBananaProRequest": { - "description": "Source images are optional. When supplied (as `image_asset_identifiers`\nreferences, or as raw `images` bytes in multipart requests), the prompt\nis applied to the sources as an edit; if both forms are given, the\nreferences are used and the bytes are ignored. Without source images\nthe prompt alone drives the generation.\n", + "description": "Source `images` are optional. When supplied, the prompt is applied to\nthem as an edit. Without source images, the output is generated from\nthe prompt alone.\n", "properties": { "prompt": { - "description": "The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting.", + "description": "The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written.", "maxLength": 10000, "minLength": 1, "type": "string" @@ -28224,7 +28659,7 @@ "type": "array" }, "images": { - "description": "The source images to edit (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied.", + "description": "Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only.", "items": { "format": "binary", "type": "string" @@ -28263,7 +28698,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -28290,7 +28725,7 @@ "type": "object" }, "GenerateImageGptImage2Response": { - "description": "Response returned by `POST /v2/image/generate/gpt-image-2`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/gpt-image-2`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -28313,7 +28748,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -28342,10 +28777,10 @@ "type": "object" }, "GenerateImageGptImage2Request": { - "description": "Source images are optional. When supplied (as `image_asset_identifiers`\nreferences, or as raw `images` bytes in multipart requests), the prompt\nis applied to the sources as an edit; if both forms are given, the\nreferences are used and the bytes are ignored. Without source images\nthe prompt alone drives the generation.\n", + "description": "Source `images` are optional. When supplied, the prompt is applied to\nthem as an edit. Without source images, the output is generated from\nthe prompt alone.\n", "properties": { "prompt": { - "description": "The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting.", + "description": "The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written.", "maxLength": 10000, "minLength": 1, "type": "string" @@ -28360,7 +28795,7 @@ "type": "array" }, "images": { - "description": "The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied.", + "description": "Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only.", "items": { "format": "binary", "type": "string" @@ -28393,7 +28828,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -28420,7 +28855,7 @@ "type": "object" }, "GenerateImageGptImage25FlareResponse": { - "description": "Response returned by `POST /v2/image/generate/gpt-image-2-5-flare`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/gpt-image-2-5-flare`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -28443,7 +28878,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -28472,10 +28907,10 @@ "type": "object" }, "GenerateImageGptImage25FlareRequest": { - "description": "Source images are optional. When supplied (as `image_asset_identifiers`\nreferences, or as raw `images` bytes in multipart requests), the prompt\nis applied to the sources as an edit; if both forms are given, the\nreferences are used and the bytes are ignored. Without source images\nthe prompt alone drives the generation.\n", + "description": "Source `images` are optional. When supplied, the prompt is applied to\nthem as an edit. Without source images, the output is generated from\nthe prompt alone.\n", "properties": { "prompt": { - "description": "The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting.", + "description": "The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written.", "maxLength": 10000, "minLength": 1, "type": "string" @@ -28490,7 +28925,7 @@ "type": "array" }, "images": { - "description": "The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied.", + "description": "Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only.", "items": { "format": "binary", "type": "string" @@ -28499,7 +28934,7 @@ "type": "array" }, "mask": { - "description": "An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`.", + "description": "An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request.", "format": "binary", "type": "string" }, @@ -28549,7 +28984,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -28576,7 +29011,7 @@ "type": "object" }, "GenerateImageGptImage25SunburstResponse": { - "description": "Response returned by `POST /v2/image/generate/gpt-image-2-5-sunburst`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/gpt-image-2-5-sunburst`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -28599,7 +29034,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -28628,10 +29063,10 @@ "type": "object" }, "GenerateImageGptImage25SunburstRequest": { - "description": "Source images are optional. When supplied (as `image_asset_identifiers`\nreferences, or as raw `images` bytes in multipart requests), the prompt\nis applied to the sources as an edit; if both forms are given, the\nreferences are used and the bytes are ignored. Without source images\nthe prompt alone drives the generation.\n", + "description": "Source `images` are optional. When supplied, the prompt is applied to\nthem as an edit. Without source images, the output is generated from\nthe prompt alone.\n", "properties": { "prompt": { - "description": "The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting.", + "description": "The prompt to generate images from, or the edit instruction to apply when source images are supplied. It is passed to the model as written.", "maxLength": 10000, "minLength": 1, "type": "string" @@ -28646,7 +29081,7 @@ "type": "array" }, "images": { - "description": "The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied.", + "description": "Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only.", "items": { "format": "binary", "type": "string" @@ -28655,7 +29090,7 @@ "type": "array" }, "mask": { - "description": "An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw `images` bytes in the same request; masks cannot be combined with `image_asset_identifiers`.", + "description": "An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request.", "format": "binary", "type": "string" }, @@ -28705,7 +29140,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -28732,7 +29167,7 @@ "type": "object" }, "GenerateImageIdeogramV2Response": { - "description": "Response returned by `POST /v2/image/generate/ideogram-2`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/ideogram-2`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -28755,7 +29190,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -28808,7 +29243,7 @@ "type": "string" }, "negative_prompt": { - "description": "Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt.", + "description": "Description of what to exclude from the images. The prompt takes precedence over the negative prompt.", "maxLength": 10000, "title": "negative_prompt", "type": "string" @@ -28857,14 +29292,14 @@ "$ref": "#/components/schemas/IdeogramV2StyleType" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "title": "enable_copyright_detection", "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "title": "async", "type": "boolean" }, @@ -28895,7 +29330,7 @@ "type": "object" }, "GenerateImageIdeogramV2AResponse": { - "description": "Response returned by `POST /v2/image/generate/ideogram-2a`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/ideogram-2a`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -28918,7 +29353,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -29013,14 +29448,14 @@ "$ref": "#/components/schemas/IdeogramV2StyleType" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "title": "enable_copyright_detection", "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "title": "async", "type": "boolean" }, @@ -29051,7 +29486,7 @@ "type": "object" }, "InpaintImageIdeogramV3Response": { - "description": "Response returned by `POST /v2/image/inpaint/ideogram-3`.\nSynchronous requests (the default) include the repainted images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed, width, and height report\nthe values the request resolved to when the caller left them unset.\n", + "description": "Response returned by `POST /v2/image/inpaint/ideogram-3`.\nSynchronous requests (the default) include the repainted images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v2/generations/{generation_id}`\nusing the returned `generation_id`. The seed, width, and height report\nthe values the request resolved to when the caller left them unset.\n", "example": { "data": [ { @@ -29076,7 +29511,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n", "title": "generation_id", "type": "string" }, @@ -29168,7 +29603,7 @@ "type": "object" }, "InpaintImageIdeogramV3Request": { - "description": "Supply the source image and the mask each as either an\n`AssetIdentifier` reference or (multipart requests only) raw image\nbytes. At least one of `image_asset_identifier` / `image` is required,\nand likewise at least one of `mask_asset_identifier` / `mask`; if both\na reference and bytes are given for the same input, the reference is\nused and the bytes are ignored.\n", + "description": "The source `image` and its `mask` are both required and must be\nuploaded in a multipart request.\n", "properties": { "prompt": { "description": "The prompt describing the repainted result.", @@ -29180,7 +29615,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied.", + "description": "The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution.", "format": "binary", "type": "string" }, @@ -29188,7 +29623,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "mask": { - "description": "A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied.", + "description": "A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only.", "format": "binary", "type": "string" }, @@ -29250,7 +29685,7 @@ "type": "array" }, "style_reference_collection_id": { - "description": "A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied.", + "description": "A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied.", "type": "string" }, "style_reference_collection_version_id": { @@ -29267,7 +29702,7 @@ "type": "array" }, "style_reference_images": { - "description": "Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied.", + "description": "Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported.", "items": { "format": "binary", "type": "string" @@ -29282,7 +29717,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.", "type": "boolean" }, "webhook_url": { @@ -29309,7 +29744,7 @@ "type": "object" }, "InpaintImageIdeogramV3CustomModelResponse": { - "description": "Response returned by\n`POST /v2/image/inpaint/ideogram-3-custom-model`. Synchronous\nrequests include the repainted images in `data`; asynchronous requests\nomit `data` and can be polled with\n`GET /v1/generations/{generation_id}`.\n", + "description": "Response returned by\n`POST /v2/image/inpaint/ideogram-3-custom-model`. Synchronous\nrequests include the repainted images in `data`; asynchronous requests\nomit `data` and can be polled with\n`GET /v2/generations/{generation_id}`.\n", "example": { "data": [ { @@ -29375,7 +29810,7 @@ "type": "object" }, "InpaintImageIdeogramV3CustomModelRequest": { - "description": "Supply the source image and mask as either `AssetIdentifier` references\nor raw bytes. At least one form of each input is required; references\ntake priority over bytes when both are supplied.\n", + "description": "The source `image` and its `mask` are both required and must be\nuploaded in a multipart request.\n", "properties": { "prompt": { "description": "The prompt describing the repainted result.", @@ -29400,7 +29835,7 @@ "description": "The source image asset to repaint. Takes priority over `image`." }, "image": { - "description": "The source image to repaint (max size 25MB), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored when `image_asset_identifier` is supplied.", + "description": "The source image to repaint (max 25MB), as JPEG, PNG, or WEBP. Multipart requests only.", "format": "binary", "type": "string" }, @@ -29413,7 +29848,7 @@ "description": "A black-and-white mask asset the same size as the source image. Black marks the region to repaint. Takes priority over `mask`." }, "mask": { - "description": "A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP bytes. Black marks the region to repaint. Multipart requests only; ignored when `mask_asset_identifier` is supplied.", + "description": "A black-and-white mask the same size as the source image, as JPEG, PNG, or WEBP. Black marks the region to repaint. Multipart requests only.", "format": "binary", "type": "string" }, @@ -29471,7 +29906,7 @@ "type": "array" }, "style_reference_collection_id": { - "description": "A saved style, by its URL-safe base64 collection id. Takes priority over asset identifiers and raw style reference images.", + "description": "A saved style, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied.", "type": "string" }, "style_reference_collection_version_id": { @@ -29488,7 +29923,7 @@ "type": "array" }, "style_reference_images": { - "description": "Images to use as style references (max 10, max size 25MB each), as JPEG, PNG, or WEBP bytes. Multipart requests only; ignored if a collection or asset identifiers are supplied.", + "description": "Images to use as style references (max 10, max 25MB each), as JPEG, PNG, or WEBP.", "items": { "format": "binary", "type": "string" @@ -29503,7 +29938,7 @@ }, "async": { "default": false, - "description": "When false, block until the images are ready. When true, return after dispatch and poll `GET /v1/generations/{generation_id}`.", + "description": "When false, wait until the images are ready. When true, return as soon as the request is accepted and poll `GET /v2/generations/{generation_id}`.", "type": "boolean" }, "private": { @@ -29523,7 +29958,7 @@ "type": "object" }, "ReframeImageIdeogramV3Response": { - "description": "Synchronous requests (the default) include the reframed images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`.\nThe seed reports the value the request resolved to when the caller\nleft it unset.\n", + "description": "Synchronous requests (the default) include the reframed images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v2/generations/{generation_id}`.\nThe seed reports the value the request resolved to when the caller\nleft it unset.\n", "example": { "data": [ { @@ -29546,7 +29981,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n", "title": "generation_id", "type": "string" }, @@ -29576,13 +30011,13 @@ }, "ReframeImageIdeogramV3Request": { "additionalProperties": false, - "description": "Provide exactly one of `image_asset_identifier` or `image` for the\nsource. Style controls are optional; when used, provide only one of\n`style_preset`, `style_codes`, `style_reference_asset_identifiers`, or\n`style_reference_images`.\n", + "description": "Upload the source `image`. Style controls are optional; when used,\nsupply only one of `style_preset`, `style_codes`, or\n`style_reference_images`.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The JPEG, PNG, or WEBP image to reframe (max 25MB), as raw bytes. Multipart requests only. Provide exactly one of `image_asset_identifier` or `image`.", + "description": "The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only.", "format": "binary", "type": "string" }, @@ -29642,7 +30077,7 @@ "type": "array" }, "style_reference_images": { - "description": "JPEG, PNG, or WEBP style reference images (max 10, max 25MB each), as raw bytes. Multipart requests only. Cannot be combined with a style preset, style codes, or referenced style assets.", + "description": "JPEG, PNG, or WEBP style reference images (max 10, max 25MB each). Multipart requests only. Cannot be combined with `style_preset` or `style_codes`.", "items": { "format": "binary", "type": "string" @@ -29663,7 +30098,7 @@ "type": "object" }, "ReframeImageNanoBanana2Response": { - "description": "Acknowledges an accepted asynchronous Reframe request. Poll\n`GET /v1/generations/{generation_id}` for completion and output\nimages. The seed, width, and height report the values the request\nresolved to when the caller left them unset.\n", + "description": "Acknowledges an accepted asynchronous Reframe request. Poll\n`GET /v2/generations/{generation_id}` for completion and output\nimages. The seed, width, and height report the values the request\nresolved to when the caller left them unset.\n", "example": { "seed": 12345, "generation_id": "generation_id", @@ -29672,7 +30107,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n", "title": "generation_id", "type": "string" }, @@ -29706,7 +30141,7 @@ }, "ReframeImageNanoBanana2Request": { "additionalProperties": false, - "description": "Supply exactly one source: `image_asset_identifier` for an existing\nIdeogram asset, or `image` for a raw upload. Supplying both or neither\nis rejected with a 400.\n", + "description": "Upload the source `image`. Requests without a source image are\nrejected with a 400.\n", "properties": { "image_asset_identifier": { "$ref": "#/components/schemas/AssetIdentifier" @@ -29750,7 +30185,7 @@ "type": "object" }, "GenerateImageIdeogramV3CharacterResponse": { - "description": "Response returned by `POST /v2/image/generate/ideogram-3-character`.\nSynchronous requests (the default) include the generated images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed reports the value the\nrequest resolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/ideogram-3-character`.\nSynchronous requests (the default) include the generated images in\n`data`. Asynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -29773,7 +30208,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -29802,7 +30237,7 @@ "type": "object" }, "GenerateImageIdeogramV3CharacterRequest": { - "description": "Supply the character as a saved character collection, as asset\nidentifiers, or (multipart requests only) as raw image bytes. Exactly\none character is supported per request; if more than one form is\ngiven, the collection is used over the identifiers, and the\nidentifiers over the bytes.\n", + "description": "Upload one character reference per request as\n`character_reference_images`. Style references can be\nadded only on accounts with access; otherwise combining them with a\ncharacter returns a 400.\n", "properties": { "prompt": { "description": "The prompt to generate images from.", @@ -29811,16 +30246,16 @@ "type": "string" }, "negative_prompt": { - "description": "Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt.", + "description": "Description of what to exclude from the images. The prompt takes precedence over the negative prompt.", "maxLength": 10000, "type": "string" }, "character_reference_collection_id": { - "description": "A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied.", + "description": "A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied.", "type": "string" }, "character_reference_collection_version_id": { - "description": "Optional URL-safe base64 version id pinning a specific version of the `character_reference_collection_id` collection. Ignored without it.", + "description": "Optional URL-safe base64 version id of the saved character in `character_reference_collection_id`. Ignored without it.", "type": "string" }, "character_reference_asset_identifiers": { @@ -29833,7 +30268,7 @@ "type": "array" }, "character_reference_images": { - "description": "An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied.", + "description": "An image of the character to feature (max 25MB; JPEG, PNG, or WEBP).", "items": { "format": "binary", "type": "string" @@ -29842,7 +30277,7 @@ "type": "array" }, "character_reference_mask": { - "description": "Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`.", + "description": "Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only.", "format": "binary", "type": "string" }, @@ -29897,11 +30332,11 @@ "type": "string" }, "style_reference_collection_id": { - "description": "A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied.", + "description": "A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied.", "type": "string" }, "style_reference_collection_version_id": { - "description": "Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it.", + "description": "Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it.", "type": "string" }, "style_reference_asset_identifiers": { @@ -29914,7 +30349,7 @@ "type": "array" }, "style_reference_images": { - "description": "Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied.", + "description": "Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP).", "items": { "format": "binary", "type": "string" @@ -29923,13 +30358,13 @@ "type": "array" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -29956,7 +30391,7 @@ "type": "object" }, "InpaintImageIdeogramV3CharacterResponse": { - "description": "Response returned by `POST /v2/image/inpaint/ideogram-3-character`.\nSynchronous requests (the default) include the repainted images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v1/generations/{generation_id}`\nusing the returned `generation_id`. The seed, width, and height report\nthe values the request resolved to when the caller left them unset.\n", + "description": "Response returned by `POST /v2/image/inpaint/ideogram-3-character`.\nSynchronous requests (the default) include the repainted images in\n`data`. Requests with `async` set to true omit `data`; poll for\ncompletion and results with `GET /v2/generations/{generation_id}`\nusing the returned `generation_id`. The seed, width, and height report\nthe values the request resolved to when the caller left them unset.\n", "example": { "data": [ { @@ -29981,7 +30416,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n", "title": "generation_id", "type": "string" }, @@ -30022,7 +30457,7 @@ "type": "object" }, "InpaintImageIdeogramV3CharacterRequest": { - "description": "Supply the source image and the mask each as either an\n`AssetIdentifier` reference or (multipart requests only) raw image\nbytes; at least one form of each is required. Supply the character as\na saved character collection, as asset identifiers, or (multipart\nrequests only) as raw image bytes. Exactly one character is supported\nper request; when more than one form of an input is given, the\nstronger form is used as documented on each field.\n", + "description": "The source `image` and its `mask` are both required and must be\nuploaded in a multipart request. Upload one character reference as\n`character_reference_images`.\n", "properties": { "prompt": { "description": "The prompt describing the repainted result.", @@ -30034,7 +30469,7 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "image": { - "description": "The source image to repaint (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifier` is also supplied.", + "description": "The source image to repaint (max 25MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The output matches its size, snapped to the nearest supported resolution.", "format": "binary", "type": "string" }, @@ -30042,12 +30477,12 @@ "$ref": "#/components/schemas/AssetIdentifier" }, "mask": { - "description": "A black-and-white mask the same size as the source image, as raw bytes. Black marks the region to repaint; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `mask_asset_identifier` is also supplied.", + "description": "A black-and-white mask the same size as the source image. Black marks the region to repaint. JPEG, PNG, and WEBP are supported. Multipart requests only.", "format": "binary", "type": "string" }, "character_reference_collection_id": { - "description": "A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_asset_identifiers` and `character_reference_images` if more than one is supplied.", + "description": "A saved character to feature, by its URL-safe base64 collection id. Takes priority over `character_reference_images` if both are supplied.", "type": "string" }, "character_reference_collection_version_id": { @@ -30064,7 +30499,7 @@ "type": "array" }, "character_reference_images": { - "description": "An image to use as the character reference (max size 25MB), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a character collection or asset identifier is also supplied.", + "description": "An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported.", "items": { "format": "binary", "type": "string" @@ -30113,7 +30548,7 @@ }, "style_type": { "default": "auto", - "description": "The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references require `auto`.", + "description": "The style type to repaint the character with. Defaults to `auto`. `realistic` and `fiction` are supported for character-only requests; style codes or style references (not both) require `auto`. For API-key callers, combining a style with a character requires that feature to be enabled for their account.", "enum": [ "auto", "realistic", @@ -30134,7 +30569,7 @@ "type": "array" }, "style_reference_collection_id": { - "description": "A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers` and `style_reference_images` if more than one is supplied. Cannot be combined with `style_codes`.", + "description": "A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_images` if both are supplied. Cannot be combined with `style_codes`.", "type": "string" }, "style_reference_collection_version_id": { @@ -30151,7 +30586,7 @@ "type": "array" }, "style_reference_images": { - "description": "Images to use as style references (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if a style reference collection or asset identifiers are also supplied. Cannot be combined with `style_codes`.", + "description": "Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Cannot be combined with `style_codes`.", "items": { "format": "binary", "type": "string" @@ -30166,7 +30601,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the repainted images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v2/generations/{generation_id}` using the returned `generation_id`.", "type": "boolean" }, "webhook_url": { @@ -30193,7 +30628,7 @@ "type": "object" }, "GenerateImageV2AutoResponse": { - "description": "Response returned by `POST /v2/image/generate/auto`. Synchronous\nrequests (the default) include the generated images in `data`.\nRequests with `async` set to true omit `data`; poll for completion\nand results with `GET /v1/generations/{generation_id}` using the\nreturned `generation_id`. The seed reports the value the request\nresolved to when the caller left it unset.\n", + "description": "Response returned by `POST /v2/image/generate/auto`. Synchronous\nrequests (the default) include the generated images in `data`.\nAsynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`. `seed` is the seed that was used, including when you\ndid not set one.\n", "example": { "data": [ { @@ -30216,7 +30651,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -30245,10 +30680,10 @@ "type": "object" }, "GenerateImageV2AutoRequest": { - "description": "Source images are optional. When supplied (as `image_asset_identifiers`\nreferences, or as raw `images` bytes in multipart requests), the server\npicks a model that can transform them and the prompt describes the\nchange; if both forms are given, the references are used and the bytes\nare ignored. `negative_prompt` and `style_reference_asset_identifiers`\ncannot be combined with source images.\n", + "description": "Source `images` are optional. When supplied, Ideogram picks a model\nthat can edit them and the prompt describes the change.\n`negative_prompt` cannot be combined with source images.\n", "properties": { "prompt": { - "description": "The prompt to generate images from, or the instruction describing how to transform the source images when sources are supplied.", + "description": "The prompt to generate images from or, when source images are supplied, the change to make to them.", "maxLength": 10000, "minLength": 1, "type": "string" @@ -30263,7 +30698,7 @@ "type": "array" }, "images": { - "description": "The source images to transform (max 10, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if `image_asset_identifiers` is also supplied.", + "description": "Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only.", "items": { "format": "binary", "type": "string" @@ -30272,7 +30707,7 @@ "type": "array" }, "negative_prompt": { - "description": "Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. Not every model consults it. Cannot be combined with source images.", + "description": "Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it. Cannot be combined with source images.", "maxLength": 10000, "type": "string" }, @@ -30287,7 +30722,7 @@ }, "aspect_ratio": { "default": "auto", - "description": "The output aspect ratio. `auto` (the default) picks the most suitable ratio from the request. Without source images the value must be one of the supported ratio buckets (for example \"16x9\" or \"1x1\"); with source images any \"WIDTHxHEIGHT\" shape hint is accepted and the selected model serves the closest shape it supports. Omit `resolution` when supplying a non-`auto` value.", + "description": "The output aspect ratio. `auto` (the default) picks the most suitable ratio for the request. Without source images the value must be a supported ratio (for example \"16x9\" or \"1x1\"); with source images any \"WIDTHxHEIGHT\" value is accepted and the output uses the closest supported shape. Omit `resolution` when supplying a non-`auto` value.", "pattern": "^(auto|[1-9][0-9]{0,4}x[1-9][0-9]{0,4})$", "type": "string" }, @@ -30297,7 +30732,7 @@ "type": "string" }, "resolution_tier": { - "description": "The output resolution tier. Influences which model serves the request; not every model offers every tier. When omitted the server uses the selected model's default tier.", + "description": "The output resolution tier. Affects which model serves the request, since not every model offers every tier. When omitted, the selected model's default tier is used.", "enum": [ "1k", "2k", @@ -30346,7 +30781,7 @@ }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" } }, @@ -30356,7 +30791,7 @@ "type": "object" }, "ToolRemixResponse": { - "description": "Response returned by `POST /v2/image/remix/auto`. Synchronous\nrequests (the default) include the remixed images in `data`.\nRequests with `async` set to true omit `data`; poll for completion\nand results with `GET /v1/generations/{generation_id}` using the\nreturned `generation_id`. The seed reports the server-assigned value\nattached to the request; AUTO remixes are not reproducible because the\nselected model may synthesize an unseeded instruction prompt.\n", + "description": "Response returned by `POST /v2/image/remix/auto`. Synchronous\nrequests (the default) include the remixed images in `data`.\nAsynchronous requests omit `data`; poll\n`GET /v2/generations/{generation_id}` with the returned\n`generation_id`.\n", "example": { "data": [ { @@ -30379,7 +30814,7 @@ }, "properties": { "generation_id": { - "description": "URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v1/generations/{generation_id}` polling endpoint.\n", + "description": "URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n", "title": "generation_id", "type": "string" }, @@ -30397,7 +30832,7 @@ "$ref": "#/components/schemas/Seed" } ], - "description": "Server-assigned value attached to the request for tracing. This value does not make AUTO remixes reproducible because the selected model may synthesize an unseeded instruction prompt.", + "description": "The seed attached to the request. Reusing it does not guarantee a reproducible result, because the selected model may not honor seeds.", "title": "seed" } }, @@ -30425,23 +30860,23 @@ "description": "The existing upload or generated image to transform. Supply this or `image`, never both. Omit `resolution` and `aspect_ratio` to keep its shape." }, "image": { - "description": "The image to transform (max size 50MB), as raw bytes; only JPEG, PNG and WEBP are supported. Multipart requests only. Supply this or `image_asset_identifier`, never both. The bytes are staged for this generation request and are not added to your account's image assets.", + "description": "The image to remix (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. The image is used only for this request and is not saved to your account.", "format": "binary", "type": "string" }, "image_weight": { - "description": "Optional. How closely the result should follow the source image, from 1 to 100. When omitted the selected model chooses its usual strength. Combining a weight with a `resolution` or `aspect_ratio` that changes the source's aspect ratio requires the 1K tier.", + "description": "Optional. How closely the result should follow the source image, from 1 to 100. When omitted the selected model chooses its usual strength. Combining a weight with a `resolution` or `aspect_ratio` that changes the source's aspect ratio crops the source to the new shape; this is only available at the 1K tier and is rejected at 2K.", "maximum": 100, "minimum": 1, "type": "integer" }, "negative_prompt": { - "description": "Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt. Not every model consults it.", + "description": "Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it.", "maxLength": 10000, "type": "string" }, "resolution": { - "description": "The requested output resolution, formatted as \"WIDTHxHEIGHT\" (for example \"1280x800\"). The output is served at the closest resolution the selected model supports in the corresponding 1K or 2K tier. Omit `aspect_ratio` when supplying a resolution. If `resolution_tier` is also supplied, it must match the tier implied by these dimensions. Combining a shape-changing value with `image_weight` requires the 1K tier.", + "description": "The requested output resolution, formatted as \"WIDTHxHEIGHT\" (for example \"1280x800\"). The output uses the closest supported resolution in the matching 1K or 2K tier. Omit `aspect_ratio` when supplying a resolution. If `resolution_tier` is also supplied, it must match the tier these dimensions fall in. Combining a shape-changing value with `image_weight` requires the 1K tier.", "pattern": "^[1-9][0-9]{1,4}x[1-9][0-9]{1,4}$", "type": "string" }, @@ -30454,7 +30889,7 @@ "description": "The requested output aspect ratio. Omit it to keep the source image's shape. `auto` also keeps the source shape. Omit `resolution` when supplying a concrete value. Combining a shape-changing value with `image_weight` requires the 1K tier." }, "resolution_tier": { - "description": "The output resolution tier. Influences which model serves the request. When omitted, the tier is inferred from `resolution`, or defaults to 1k when no exact resolution is supplied. Inputs that restrict the server's model choice (style references, saved styles, a color palette, style codes, a style preset, or a non-`auto` style type) currently support only 1K AUTO remixes.", + "description": "The output resolution tier. When omitted, the tier is inferred from `resolution`, or defaults to 1k. A color palette, style codes, style preset, or non-`auto` style type are only supported at 1k.", "enum": [ "1k", "2k" @@ -30471,7 +30906,7 @@ "description": "Controls magic prompt (automatic prompt rewriting). Defaults to `auto`. The selected model decides how to interpret it." }, "seed": { - "description": "Optional. Honored when the server selects the model that supports deterministic remixes; the default model synthesizes its own prompt, so results are not reproducible there. The response reports the seed used.", + "description": "Optional. Only honored when the request uses a model that supports reproducible remixes; results from the default model are not reproducible. The response reports the seed used.", "example": 12345, "maximum": 2147483647, "minimum": 0, @@ -30487,11 +30922,11 @@ "type": "array" }, "style_reference_collection_id": { - "description": "A saved style to apply, by its URL-safe base64 collection id. Takes priority over `style_reference_asset_identifiers`. Restricts the server to a model that supports style references and requires the 1K resolution tier.", + "description": "A saved style to apply, by its URL-safe base64 collection id. Limits the request to a model that supports style references and requires the 1K resolution tier.", "type": "string" }, "style_reference_collection_version_id": { - "description": "Optional URL-safe base64 version id pinning a specific version of the `style_reference_collection_id` collection. Ignored without it.", + "description": "Optional URL-safe base64 version id of the saved style in `style_reference_collection_id`. Ignored without it.", "type": "string" }, "style_preset": { @@ -30500,7 +30935,7 @@ "$ref": "#/components/schemas/IdeogramV3StylePreset" } ], - "description": "A predefined style preset to apply. Restricts the server to a model that supports it and requires the 1K resolution tier. Cannot be combined with style codes or style references." + "description": "A predefined style preset to apply. Limits the request to a model that supports it and requires the 1K resolution tier. Cannot be combined with style codes." }, "color_palette": { "allOf": [ @@ -30508,7 +30943,7 @@ "$ref": "#/components/schemas/IdeogramColorPalette" } ], - "description": "A color palette to apply. Restricts the server to a model that supports palettes and requires the 1K resolution tier." + "description": "A color palette to apply. Limits the request to a model that supports palettes and requires the 1K resolution tier." }, "style_codes": { "description": "A list of 8-character hexadecimal codes representing the style of the image. Refer to each endpoint for supported combinations with style types, presets, and reference images.", @@ -30528,7 +30963,7 @@ "$ref": "#/components/schemas/IdeogramV3StyleType" } ], - "description": "The style type to generate with. A value other than `auto` restricts the server to a model that supports it and requires the 1K resolution tier." + "description": "The style type to generate with. A value other than `auto` limits the request to a model that supports it and requires the 1K resolution tier." }, "num_images": { "default": 1, @@ -30538,13 +30973,13 @@ "type": "integer" }, "enable_copyright_detection": { - "description": "Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`.", + "description": "Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`.", "nullable": true, "type": "boolean" }, "async": { "default": false, - "description": "When false (the default), the request blocks until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`.", + "description": "When false (the default), the request waits until the images are ready and returns them in `data`. When true, the request returns as soon as it is accepted; poll `GET /v2/generations/{generation_id}` with the returned `generation_id` for the result.", "type": "boolean" }, "webhook_url": { @@ -35998,6 +36433,38 @@ "title": "DetectedTextBlock", "type": "object" }, + "AssetIdentifier": { + "description": "An identifier for an ideogram asset.", + "example": { + "asset_type": "RESPONSE", + "asset_id": "7uS_VESkRI6O3-sVgHQp_A" + }, + "properties": { + "asset_type": { + "$ref": "#/components/schemas/AssetType" + }, + "asset_id": { + "type": "string" + } + }, + "required": [ + "asset_id", + "asset_type" + ], + "title": "AssetIdentifier", + "type": "object" + }, + "AssetType": { + "enum": [ + "ASSET", + "CANVAS_ASSET", + "LAYERED_ASSET", + "RESPONSE", + "UPLOAD" + ], + "title": "AssetType", + "type": "string" + }, "SeedDance2AspectRatio": { "default": "auto", "description": "The aspect ratio of the generated video. `AUTO` lets the model choose the\nmost suitable ratio from the prompt; any other value pins the ratio.\n", @@ -36037,38 +36504,6 @@ "title": "generate_audio", "type": "boolean" }, - "AssetIdentifier": { - "description": "An identifier for an ideogram asset.", - "example": { - "asset_type": "RESPONSE", - "asset_id": "7uS_VESkRI6O3-sVgHQp_A" - }, - "properties": { - "asset_type": { - "$ref": "#/components/schemas/AssetType" - }, - "asset_id": { - "type": "string" - } - }, - "required": [ - "asset_id", - "asset_type" - ], - "title": "AssetIdentifier", - "type": "object" - }, - "AssetType": { - "enum": [ - "ASSET", - "CANVAS_ASSET", - "LAYERED_ASSET", - "RESPONSE", - "UPLOAD" - ], - "title": "AssetType", - "type": "string" - }, "MinimaxH3AspectRatio": { "default": "16x9", "description": "The aspect ratio of the generated video.",