diff --git a/ATTRIBUTION.md b/ATTRIBUTION.md new file mode 100644 index 0000000000000000000000000000000000000000..2c182a272e5c809b4d78ab93af5517f7aef8d263 --- /dev/null +++ b/ATTRIBUTION.md @@ -0,0 +1,217 @@ +# Photo credits + +The 199 source photos of the Multi-step Image Edit benchmark. Edited images are adaptations of these photos: edited images of CC BY-SA photos are released under the same CC BY-SA licence, edited images of CC BY photos credit the original author, CC0 photos need no credit. + +## CC BY-SA 4.0 (106 photos, https://creativecommons.org/licenses/by-sa/4.0) + +- `wc61267439`: "BandoneonistaMDP-jul2017.jpg" by Ezarate, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:BandoneonistaMDP-jul2017.jpg) +- `wc177092456`: "Max Giesinger - 2021-09-12 - Mannheim - Sven Mandel - 1D X MK II - 0229 - B70I3683 (re-developed).jpg" by Sven Mandel (original), Radomianin (derivative work), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Max_Giesinger_-_2021-09-12_-_Mannheim_-_Sven_Mandel_-_1D_X_MK_II_-_0229_-_B70I3683_(re-developed).jpg) +- `wc61616231`: "Villagers from Madhya Pradesh Couple 1.jpg" by Suyash Dwivedi, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Villagers_from_Madhya_Pradesh_Couple_1.jpg) +- `wc98796115`: "Francesco Maselli.jpg" by Giacomo Alessandroni, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Francesco_Maselli.jpg) +- `wc155185732`: "Mississippi Supreme Court Justice Jim Kitchens.jpg" by Timothy Holdiness, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Mississippi_Supreme_Court_Justice_Jim_Kitchens.jpg) +- `wc170348170`: "Dirk Zedler, Cycling World Europe 2025, Meerbusch (File1033-2-RR).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Dirk_Zedler,_Cycling_World_Europe_2025,_Meerbusch_(File1033-2-RR).jpg) +- `wc49640230`: "Alon Ben David.jpg" by Channel10israel, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Alon_Ben_David.jpg) +- `wc127813216`: "Bakhtiyor Rakhman.jpg" by Umarxon III, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Bakhtiyor_Rakhman.jpg) +- `wc113391732`: "2021-12-12 Eberspächer Luge World Cup Altenberg 1DX 4660 by Stepro.jpg" by Steffen Prößdorf, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2021-12-12_Ebersp%C3%A4cher_Luge_World_Cup_Altenberg_1DX_4660_by_Stepro.jpg) +- `wc128978025`: "2023 National Day of Brunei 52.jpg" by Pangalau, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2023_National_Day_of_Brunei_52.jpg) +- `wc164397906`: "Captain Joe, Friedrichshafen (P1046580).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Captain_Joe,_Friedrichshafen_(P1046580).jpg) +- `wc51544098`: "WDR-Dreharbeiten zu Tatort Köln „Wacht am Rhein“-8801.jpg" by © Raimond Spekking / CC BY-SA 4.0 (via Wikimedia Commons), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:WDR-Dreharbeiten_zu_Tatort_K%C3%B6ln_%E2%80%9EWacht_am_Rhein%E2%80%9C-8801.jpg) +- `wc186877996`: "Bhil community women in traditional attire, Jhabua, Madhya Pradesh, India (7).jpg" by Suyash Dwivedi, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Bhil_community_women_in_traditional_attire,_Jhabua,_Madhya_Pradesh,_India_(7).jpg) +- `wc68327807`: "Darshan Singh, Village Akbarpur Afghana.jpg" by Satdeep Gill, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Darshan_Singh,_Village_Akbarpur_Afghana.jpg) +- `wc45337546`: "Ak55-Busy afternoon.jpg" by Zuraj studio, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Ak55-Busy_afternoon.jpg) +- `wc54050746`: "ART DANS LA RUE ALGER 2.jpg" by BRAHIM DJELLOUL Mustapha, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:ART_DANS_LA_RUE_ALGER_2.jpg) +- `wc36840374`: "Marble statue makers, near Jaipur, Rajasthan, India.jpg" by © Yann Forget / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Marble_statue_makers,_near_Jaipur,_Rajasthan,_India.jpg) +- `wc78443524`: "Rich Kameda BBG New York April 2019.jpg" by King of Hearts, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Rich_Kameda_BBG_New_York_April_2019.jpg) +- `wc35989646`: "20140808 - Ligue 2 - Créteil-Châteauroux 100.jpg" by Pierre-Yves Beaudouin / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:20140808_-_Ligue_2_-_Cr%C3%A9teil-Ch%C3%A2teauroux_100.jpg) +- `wc110020707`: "Michelin at IAA 2021 1X7A0159.jpg" by Alexander Migl, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Michelin_at_IAA_2021_1X7A0159.jpg) +- `wc51316724`: "Costurera, Mahdia, Túnez, 2016-09-03, DD 04.jpg" by Diego Delso, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Costurera,_Mahdia,_T%C3%BAnez,_2016-09-03,_DD_04.jpg) +- `wc163677793`: "2025-04-08 Fussball, UEFA Women's Nations League, Deutschland - Schottland STP 2074.jpg" by Steffen Prößdorf, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2025-04-08_Fussball,_UEFA_Women%27s_Nations_League,_Deutschland_-_Schottland_STP_2074.jpg) +- `wc132567368`: "Vendor at Mahankaal Temple, Kathmandu-6316.jpg" by Bijay Chaurasia, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Vendor_at_Mahankaal_Temple,_Kathmandu-6316.jpg) +- `wc36823435`: "Old man smoking hookah, near Jaipur, Rajasthan, India.jpg" by © Yann Forget / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Old_man_smoking_hookah,_near_Jaipur,_Rajasthan,_India.jpg) +- `wc48134404`: "Cobbler in Udaipur.jpg" by Clément Bardot, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Cobbler_in_Udaipur.jpg) +- `wc187580499`: "Chechia Maker in his shop.jpg" by IssamBarhoumi, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Chechia_Maker_in_his_shop.jpg) +- `wc9590173`: "Potter and his wife.jpg" by © Yann Forget / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Potter_and_his_wife.jpg) +- `wc68508073`: "Woman with hand-rolled cigarette cutting rice.jpg" by Basile Morin, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Woman_with_hand-rolled_cigarette_cutting_rice.jpg) +- `wc64396409`: "Beignet maker.jpg" by IssamBarhoumi, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Beignet_maker.jpg) +- `wc181130944`: "Knitted Dress as additional warm layer over street clothing - ginger woman sitting on a park bench outside of Praha hlavní nádraží.jpg" by Tobias ToMar Maier, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Knitted_Dress_as_additional_warm_layer_over_street_clothing_-_ginger_woman_sitting_on_a_park_bench_outside_of_Praha_hlavn%C3%AD_n%C3%A1dra%C5%BE%C3%AD.jpg) +- `wc74708391`: "Copihue de Oro 2018 - Fernanda Figueroa - 02.jpg" by Carlos Figueroa Rojas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Copihue_de_Oro_2018_-_Fernanda_Figueroa_-_02.jpg) +- `wc164348921`: "Ташкент, вики-краевед на скамейке у Шевченко 1 (2).jpg" by Nikolai Bulykin, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:%D0%A2%D0%B0%D1%88%D0%BA%D0%B5%D0%BD%D1%82,_%D0%B2%D0%B8%D0%BA%D0%B8-%D0%BA%D1%80%D0%B0%D0%B5%D0%B2%D0%B5%D0%B4_%D0%BD%D0%B0_%D1%81%D0%BA%D0%B0%D0%BC%D0%B5%D0%B9%D0%BA%D0%B5_%D1%83_%D0%A8%D0%B5%D0%B2%D1%87%D0%B5%D0%BD%D0%BA%D0%BE_1_(2).jpg) +- `wc132970669`: "2022-08-18 European Championships 2022 – Men's 200 Metres by Sandro Halank–060.jpg" by Sandro Halank, Wikimedia Commons, CC BY-SA 4.0, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2022-08-18_European_Championships_2022_%E2%80%93_Men%27s_200_Metres_by_Sandro_Halank%E2%80%93060.jpg) +- `wc74785277`: "2018-11-24 Women's World Cup at 2018-19 Luge World Cup in Igls by Sandro Halank–372.jpg" by Sandro Halank, Wikimedia Commons, CC BY-SA 4.0, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2018-11-24_Women%27s_World_Cup_at_2018-19_Luge_World_Cup_in_Igls_by_Sandro_Halank%E2%80%93372.jpg) +- `wc37036117`: "Cheek - Rakuuna Rock 2014 1.jpg" by Tuomas Vitikainen, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Cheek_-_Rakuuna_Rock_2014_1.jpg) +- `wc6900196`: "Sari 2.jpg" by © Yann Forget / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sari_2.jpg) +- `wc54338875`: "The BossHoss - Oberhausen - Leonhard Kreissig - 06.jpg" by Leonhard Kreissig, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:The_BossHoss_-_Oberhausen_-_Leonhard_Kreissig_-_06.jpg) +- `wc81720138`: "Tambourin.jpg" by Bertrand Fanonnel | Eight Studio, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Tambourin.jpg) +- `wc79628058`: "P2N2019ClaraLuciani 03.jpg" by Selbymay, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:P2N2019ClaraLuciani_03.jpg) +- `wc62403000`: "Kia, IAA 2017 (1Y7A2595).jpg" by MB-one, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Kia,_IAA_2017_(1Y7A2595).jpg) +- `wc197388139`: "2026 Domingo 26 de xullo. Desfile de traxes tradicionais. Santiago de Compostela 05.jpg" by Luis Miguel Bugallo Sánchez, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2026_Domingo_26_de_xullo._Desfile_de_traxes_tradicionais._Santiago_de_Compostela_05.jpg) +- `wc71781613`: "David Stellner (Kunst am Kanal - 12 Jahre Werk in Wien) 11.jpg" by Manfred Werner (Tsui), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:David_Stellner_(Kunst_am_Kanal_-_12_Jahre_Werk_in_Wien)_11.jpg) +- `wc130741178`: "2023-04-11 Fussball, Frauen, Länderspiel, Deutschland - Brasilien 1DX 0181 by Stepro.jpg" by Steffen Prößdorf, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2023-04-11_Fussball,_Frauen,_L%C3%A4nderspiel,_Deutschland_-_Brasilien_1DX_0181_by_Stepro.jpg) +- `wc181185691`: "Catsuit made of velvet in cappuccino color - German Ervy brand number 12282 - with back zipper and standing collar extended to 6cm - Pose 2.jpg" by Tobias ToMar Maier, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Catsuit_made_of_velvet_in_cappuccino_color_-_German_Ervy_brand_number_12282_-_with_back_zipper_and_standing_collar_extended_to_6cm_-_Pose_2.jpg) +- `wc61382438`: "DCVDNS 1 – splash! Festival 20 (2017).jpg" by Nicolas Völcker, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:DCVDNS_1_%E2%80%93_splash!_Festival_20_(2017).jpg) +- `wc77297064`: "Sanni - Ilosaarirock 2018 - 02.jpg" by Tuomas Vitikainen, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sanni_-_Ilosaarirock_2018_-_02.jpg) +- `wc71365077`: "IAA 2017, Frankfurt (1Y7A1813).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:IAA_2017,_Frankfurt_(1Y7A1813).jpg) +- `wc144533378`: "Sundance Film Festival 2024 - Cynthia Okorafor-104A3488.jpg" by Frank Schulenburg, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Cynthia_Okorafor-104A3488.jpg) +- `wc198272116`: "2026 Músico do grupo de Felisa Segade no TradFest 2026. A Quintana. Santiago de Compostela. Galiza.jpg" by Luis Miguel Bugallo Sánchez, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2026_M%C3%BAsico_do_grupo_de_Felisa_Segade_no_TradFest_2026._A_Quintana._Santiago_de_Compostela._Galiza.jpg) +- `wc165131491`: "Ташкент, кыргызский викимедиец на Буюк Турон (2).jpg" by Nikolai Bulykin, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:%D0%A2%D0%B0%D1%88%D0%BA%D0%B5%D0%BD%D1%82,_%D0%BA%D1%8B%D1%80%D0%B3%D1%8B%D0%B7%D1%81%D0%BA%D0%B8%D0%B9_%D0%B2%D0%B8%D0%BA%D0%B8%D0%BC%D0%B5%D0%B4%D0%B8%D0%B5%D1%86_%D0%BD%D0%B0_%D0%91%D1%83%D1%8E%D0%BA_%D0%A2%D1%83%D1%80%D0%BE%D0%BD_(2).jpg) +- `wc70180444`: "Mermaid Parade (60015).jpg" by Rhododendrites, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Mermaid_Parade_(60015).jpg) +- `wc75115465`: "Geneva International Motor Show 2018, Le Grand-Saconnex (1X7A0394).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Geneva_International_Motor_Show_2018,_Le_Grand-Saconnex_(1X7A0394).jpg) +- `wc144784911`: "Sundance Film Festival 2024 - Jamal Trulove-104A3197.jpg" by Frank Schulenburg, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Jamal_Trulove-104A3197.jpg) +- `wc145940545`: "Søren W. Rasmussen, COTY, GIMS 2024, Le Grand-Saconnex (GIMS0032).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:S%C3%B8ren_W._Rasmussen,_COTY,_GIMS_2024,_Le_Grand-Saconnex_(GIMS0032).jpg) +- `wc144339350`: "Sundance Film Festival 2024 - Seeking Mavis Beacon - Guetty Felin-104A2142.jpg" by Frank Schulenburg, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Seeking_Mavis_Beacon_-_Guetty_Felin-104A2142.jpg) +- `wc186877998`: "Bhil community women in traditional attire, Jhabua, Madhya Pradesh, India (8).jpg" by Suyash Dwivedi, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Bhil_community_women_in_traditional_attire,_Jhabua,_Madhya_Pradesh,_India_(8).jpg) +- `wc43469543`: "Groupe Tribal Percussions - 248.jpg" by © William Crochot / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Groupe_Tribal_Percussions_-_248.jpg) +- `wc132970461`: "2022-08-18 European Championships 2022 – Men's 200 Metres by Sandro Halank–045.jpg" by Sandro Halank, Wikimedia Commons, CC BY-SA 4.0, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2022-08-18_European_Championships_2022_%E2%80%93_Men%27s_200_Metres_by_Sandro_Halank%E2%80%93045.jpg) +- `wc164861272`: "Khasi Woman Dress Mawphanlur Oct24 A7CR 04247.jpg" by Timothy A. Gonsalves, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Khasi_Woman_Dress_Mawphanlur_Oct24_A7CR_04247.jpg) +- `wc198351927`: "2026 Saxofonista do grupo de Felisa Segade. TradFest. Galiza.jpg" by Luis Miguel Bugallo Sánchez, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2026_Saxofonista_do_grupo_de_Felisa_Segade._TradFest._Galiza.jpg) +- `wc163677788`: "2025-04-08 Fussball, UEFA Women's Nations League, Deutschland - Schottland STP 2073.jpg" by Steffen Prößdorf, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2025-04-08_Fussball,_UEFA_Women%27s_Nations_League,_Deutschland_-_Schottland_STP_2073.jpg) +- `wc50966261`: "20160807 spice merchant Nyaung Shwe Myanmar 8917.jpg" by Jakub Hałun, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:20160807_spice_merchant_Nyaung_Shwe_Myanmar_8917.jpg) +- `wc55676665`: "Tunisian Musicians 04.jpg" by Hamed Gamaoun, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Tunisian_Musicians_04.jpg) +- `wc45035857`: "GedFunerailles0.JPG" by Mbiele Happi, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:GedFunerailles0.JPG) +- `wc145784234`: "Sundance Film Festival 2024 - Kevin Carmant-104A3458.jpg" by Frank Schulenburg, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Kevin_Carmant-104A3458.jpg) +- `wc154107516`: "Buchmesse 2024, Frankfurt am Main (P1200850-2).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Buchmesse_2024,_Frankfurt_am_Main_(P1200850-2).jpg) +- `wc107302058`: "Young men smiling with teeth, studio portrait.jpg" by Dmitry Makeev, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Young_men_smiling_with_teeth,_studio_portrait.jpg) +- `wc9590080`: "Potter and his work, Jaura, India.jpg" by © Yann Forget / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Potter_and_his_work,_Jaura,_India.jpg) +- `wc146462387`: "At Princeton University 2024 058 - Bruce T. Draine.jpg" by Mike Peel (www.mikepeel.net), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:At_Princeton_University_2024_058_-_Bruce_T._Draine.jpg) +- `wc52136996`: "Panadería en Yazd, Irán, 2016-09-21, DD 44.jpg" by Diego Delso, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Panader%C3%ADa_en_Yazd,_Ir%C3%A1n,_2016-09-21,_DD_44.jpg) +- `wc133986723`: "Japanese garden at Schönbrunn Palace in Vienna, Austria - teahouse Heterotopia tea ceremony-water PNr°1026.jpg" by D-Kuru, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Japanese_garden_at_Sch%C3%B6nbrunn_Palace_in_Vienna,_Austria_-_teahouse_Heterotopia_tea_ceremony-water_PNr%C2%B01026.jpg) +- `wc186192168`: "AC SO Karlspreisübergabe 14.03.2026 Gesprächsrunde VI.jpg" by Grunpfnul, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:AC_SO_Karlspreis%C3%BCbergabe_14.03.2026_Gespr%C3%A4chsrunde_VI.jpg) +- `wc63914699`: "Adrian Horridge FRS on his 90th birthday.jpg" by Thennicke, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Adrian_Horridge_FRS_on_his_90th_birthday.jpg) +- `wc49858555`: "Tachileik Myanmar Kayan-People-Woman-03.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Tachileik_Myanmar_Kayan-People-Woman-03.jpg) +- `wc165584587`: "Бишкек, вики-фототренинг 2025 (31).jpg" by Nikolai Bulykin, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:%D0%91%D0%B8%D1%88%D0%BA%D0%B5%D0%BA,_%D0%B2%D0%B8%D0%BA%D0%B8-%D1%84%D0%BE%D1%82%D0%BE%D1%82%D1%80%D0%B5%D0%BD%D0%B8%D0%BD%D0%B3_2025_(31).jpg) +- `wc36828929`: "Carpet makers, near Jaipur, Rajasthan, India.jpg" by © Yann Forget / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Carpet_makers,_near_Jaipur,_Rajasthan,_India.jpg) +- `wc86477420`: "Miriam Beizana Vigo.002 - Escritora.jpg" by Fernando Losada Rodríguez, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Miriam_Beizana_Vigo.002_-_Escritora.jpg) +- `wc133986767`: "Japanese garden at Schönbrunn Palace in Vienna, Austria - teahouse Heterotopia tea ceremony-whisk PNr°1027.jpg" by D-Kuru, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Japanese_garden_at_Sch%C3%B6nbrunn_Palace_in_Vienna,_Austria_-_teahouse_Heterotopia_tea_ceremony-whisk_PNr%C2%B01027.jpg) +- `wc113139332`: "2021-12-07 Unterzeichnung des Koalitionsvertrages der 20. Wahlperiode des Bundestages by Sandro Halank–016.jpg" by Sandro Halank, Wikimedia Commons, CC BY-SA 4.0, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2021-12-07_Unterzeichnung_des_Koalitionsvertrages_der_20._Wahlperiode_des_Bundestages_by_Sandro_Halank%E2%80%93016.jpg) +- `wc110020721`: "Michelin at IAA 2021 1X7A0161.jpg" by Alexander Migl, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Michelin_at_IAA_2021_1X7A0161.jpg) +- `wc34473676`: "Mnich buddyjski w klasztorze Erdene Dzuu.jpg" by Photo: Marcin Konsek / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Mnich_buddyjski_w_klasztorze_Erdene_Dzuu.jpg) +- `wc53784969`: "Nordest music in Avenida Paulista, São Paulo, Brazil.jpg" by Wilfredor, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Nordest_music_in_Avenida_Paulista,_S%C3%A3o_Paulo,_Brazil.jpg) +- `wc69984498`: "OutDoor 2018, Friedrichshafen (1X7A9907).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:OutDoor_2018,_Friedrichshafen_(1X7A9907).jpg) +- `wc85705501`: "20191206 Uliczny grajek w Udajpurze 1215 6822 DxO.jpg" by Jakub Hałun, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:20191206_Uliczny_grajek_w_Udajpurze_1215_6822_DxO.jpg) +- `wc91421474`: "Jon Batiste in Brooklyn Juneteenth 2020 (94060).jpg" by Rhododendrites, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Jon_Batiste_in_Brooklyn_Juneteenth_2020_(94060).jpg) +- `wc164201681`: "Farmer at harvest.jpg" by Photobyamin, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Farmer_at_harvest.jpg) +- `wc77740619`: "Woman harvesting tea, West Bengal.jpg" by Bernard Gagnon, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Woman_harvesting_tea,_West_Bengal.jpg) +- `wc87211151`: "The water transfer.jpg" by Mikhail Kapychka, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:The_water_transfer.jpg) +- `wc36791367`: "PersonaMardel.jpg" by Ezarate, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:PersonaMardel.jpg) +- `wc45077428`: "Dönüş Tuncel (Donus Tuncel) - In the Lab.JPG" by Yigit Altay, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:D%C3%B6n%C3%BC%C5%9F_Tuncel_(Donus_Tuncel)_-_In_the_Lab.JPG) +- `wc34178099`: "EmanuelHarrold.JPG" by Eric Magnan, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:EmanuelHarrold.JPG) +- `wc171925289`: "Paul Cook - Sex Pistols 2025-2.jpg" by Birgit Fostervold, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Paul_Cook_-_Sex_Pistols_2025-2.jpg) +- `wc87403339`: "Yuyuan Garden 3.jpg" by kallerna, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Yuyuan_Garden_3.jpg) +- `wc118282429`: "Ribfest in Toronto (Dundas Square, May 21, 2022) (2).jpg" by Maksim Sokolov (maxergon.com), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Ribfest_in_Toronto_(Dundas_Square,_May_21,_2022)_(2).jpg) +- `wc89022757`: "حافلة نقل حضري.jpg" by Sofiane mohammed amri, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:%D8%AD%D8%A7%D9%81%D9%84%D8%A9_%D9%86%D9%82%D9%84_%D8%AD%D8%B6%D8%B1%D9%8A.jpg) +- `wc135875647`: "Sumitra Devi, a Garhwali shepherd near Lansdowne, Uttarakhand 01.jpg" by Satdeep Gill, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sumitra_Devi,_a_Garhwali_shepherd_near_Lansdowne,_Uttarakhand_01.jpg) +- `wc62210997`: "20160807 spice merchant Nyaung Shwe Myanmar 8916 DxO.jpg" by Jakub Hałun, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:20160807_spice_merchant_Nyaung_Shwe_Myanmar_8916_DxO.jpg) +- `wc83827597`: "Graveur de la place du Peuple.jpg" by Touam (Hervé Agnoux), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Graveur_de_la_place_du_Peuple.jpg) +- `wc81006780`: "Glaces Jeff de Bruges à Saint-Étienne.jpg" by Touam (Herve Agnoux), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Glaces_Jeff_de_Bruges_%C3%A0_Saint-%C3%89tienne.jpg) +- `wc54735536`: "Nubian Flute player عازف الناي.jpg" by Ahmed Emad H, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Nubian_Flute_player_%D8%B9%D8%A7%D8%B2%D9%81_%D8%A7%D9%84%D9%86%D8%A7%D9%8A.jpg) +- `wc118282450`: "Ribfest in Toronto (Dundas Square, May 21, 2022).jpg" by Maksim Sokolov (maxergon.com), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Ribfest_in_Toronto_(Dundas_Square,_May_21,_2022).jpg) +- `wc42782992`: "Puesto de comida, calle Jirón Ancash, Lima, Perú, 2015-07-28, DD 80.JPG" by Diego Delso, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Puesto_de_comida,_calle_Jir%C3%B3n_Ancash,_Lima,_Per%C3%BA,_2015-07-28,_DD_80.JPG) +- `wc37667675`: "Yair Aharoni.jpg" by Arielinson, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Yair_Aharoni.jpg) +- `wc45734944`: "Entrega de Premios Wiki Loves, Sevilla, España, 2015-12-05, DD 03.JPG" by Diego Delso, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Entrega_de_Premios_Wiki_Loves,_Sevilla,_Espa%C3%B1a,_2015-12-05,_DD_03.JPG) +- `wc47572063`: "Suzhou woman burning waste 20090926 5964.jpg" by Jakub Hałun, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Suzhou_woman_burning_waste_20090926_5964.jpg) +- `wc69428885`: "ILA 2018, Schönefeld (1X7A5927).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:ILA_2018,_Sch%C3%B6nefeld_(1X7A5927).jpg) + +## CC BY-SA 3.0 (57 photos, https://creativecommons.org/licenses/by-sa/3.0) + +- `wc15467676`: "FarmWorker.JPG" by Arne Hückelheim, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:FarmWorker.JPG) +- `wc31140258`: "Antti Kiiski - Rakuunarock 2013.jpg" by Tuomas Vitikainen, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Antti_Kiiski_-_Rakuunarock_2013.jpg) +- `wc22487838`: "Geneetik Riin Tamm.jpg" by Lauri Kulpsoo, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Geneetik_Riin_Tamm.jpg) +- `wc84023793`: "March of Ukraine's Defenders on Independence Day in Kyiv, 2019 373.jpg" by Ввласенко, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:March_of_Ukraine%27s_Defenders_on_Independence_Day_in_Kyiv,_2019_373.jpg) +- `wc42363791`: "Semporna Sabah Regatta-Lepa-2015-08.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Regatta-Lepa-2015-08.jpg) +- `wc36757782`: "Batangon-Darat Sabah Rungus-Woman-01.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Batangon-Darat_Sabah_Rungus-Woman-01.jpg) +- `wc7231228`: "Woman doing laundry.jpg" by Bernard Gagnon, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Woman_doing_laundry.jpg) +- `wc22907497`: "Vendedor de agua de coco II.JPG" by Rjcastillo, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Vendedor_de_agua_de_coco_II.JPG) +- `wc12185576`: "Quito Accordion player.jpg" by Cayambe, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Quito_Accordion_player.jpg) +- `wc46729005`: "Taipei Taiwan Jiaozi-Restaurant-14th-avenue-01.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-01.jpg) +- `wc39796818`: "Semporna Sabah Official-Opening-of-Tun-Sakaran-Museum-10.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Official-Opening-of-Tun-Sakaran-Museum-10.jpg) +- `wc16841673`: "11-10-02-barnim-by-RalfR-02.jpg" by Ralf Roletschek, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:11-10-02-barnim-by-RalfR-02.jpg) +- `wc30113648`: "Vendedor callejero de gallinas, Ciudad Ho Chi Minh, Vietnam, 2013-08-14, DD 01.JPG" by Diego Delso, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Vendedor_callejero_de_gallinas,_Ciudad_Ho_Chi_Minh,_Vietnam,_2013-08-14,_DD_01.JPG) +- `wc87185001`: "Contouring the cheekbone with makeup in proper and wrong pose.jpg" by Tobias ToMar Maier, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Contouring_the_cheekbone_with_makeup_in_proper_and_wrong_pose.jpg) +- `wc1651809`: "4.FMC - Dullahan - Marek Przewłocki - 01a.jpg" by Lestat (Jan Mehlich), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:4.FMC_-_Dullahan_-_Marek_Przew%C5%82ocki_-_01a.jpg) +- `wc30778085`: "Dover - Dover came to me 2014 - 01.jpg" by Carlos Delgado, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Dover_-_Dover_came_to_me_2014_-_01.jpg) +- `wc57090152`: "2017-02-24 Emily Sweeney by Sandro Halank–1.jpg" by Sandro Halank, Wikimedia Commons, CC-BY-SA 3.0, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:2017-02-24_Emily_Sweeney_by_Sandro_Halank%E2%80%931.jpg) +- `wc44437091`: "Lady on Neva river Saint Petersburg.jpg" by Wolfgang Moroder, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Lady_on_Neva_river_Saint_Petersburg.jpg) +- `wc87185004`: "Slightly business casual Informal wear - pose 1.jpg" by Tobias ToMar Maier, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Slightly_business_casual_Informal_wear_-_pose_1.jpg) +- `wc18749683`: "Cody ChesnuTT - Ilosaarirock 2011.jpg" by Tuomas Vitikainen, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Cody_ChesnuTT_-_Ilosaarirock_2011.jpg) +- `wc18529819`: "John Petrucci - 02.jpg" by Carlos Delgado, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:John_Petrucci_-_02.jpg) +- `wc87185002`: "Slightly business casual Informal wear - pose 2 with fishnet tights.jpg" by Tobias ToMar Maier, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Slightly_business_casual_Informal_wear_-_pose_2_with_fishnet_tights.jpg) +- `wc27115652`: "13-06-07 RiP The BossHoss Boss Burns 6.JPG" by Antje Naumann (AllSystemsRed), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:13-06-07_RiP_The_BossHoss_Boss_Burns_6.JPG) +- `wc15099922`: "Agnes Milowka by J Axford.jpg" by James Axford, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Agnes_Milowka_by_J_Axford.jpg) +- `wc12797457`: "7th Marquis of Colmondeley 2.jpg" by Allan Warren, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:7th_Marquis_of_Colmondeley_2.jpg) +- `wc87258958`: "Wolford fatal dress as a mini dress to cover the see trough part of a too thin jeggings.jpg" by Tobias ToMar Maier, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Wolford_fatal_dress_as_a_mini_dress_to_cover_the_see_trough_part_of_a_too_thin_jeggings.jpg) +- `wc86971536`: "Simple sweater dress with with turtleneck - pose 1.jpg" by Tobias ToMar Maier, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Simple_sweater_dress_with_with_turtleneck_-_pose_1.jpg) +- `wc11127070`: "Nottingham Pride MMB 67 Kenelis.jpg" by mattbuck, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Nottingham_Pride_MMB_67_Kenelis.jpg) +- `wc47590527`: "Cañari woman 02.jpg" by Bernard Gagnon, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Ca%C3%B1ari_woman_02.jpg) +- `wc26567769`: "University Park MMB «N6 Students' Union Elections 2013.jpg" by mattbuck, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:University_Park_MMB_%C2%ABN6_Students%27_Union_Elections_2013.jpg) +- `wc40941239`: "Guy Sebastian ESC2015 Eurovision Village Vienna 08crop.jpg" by Manfred Werner - Tsui, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Guy_Sebastian_ESC2015_Eurovision_Village_Vienna_08crop.jpg) +- `wc36507851`: "Austrian Sportspeople of the Year 2014 winners 09 Mirna Jukic.jpg" by Manfred Werner - Tsui, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Austrian_Sportspeople_of_the_Year_2014_winners_09_Mirna_Jukic.jpg) +- `wc29828836`: "Dalian Liaoning China Ruan-Player-in-Dalian-Labour-Park-01.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Dalian_Liaoning_China_Ruan-Player-in-Dalian-Labour-Park-01.jpg) +- `wc32720436`: "Xian China Yang-Jide-01.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Xian_China_Yang-Jide-01.jpg) +- `wc16957573`: "Tatort vier Ermittler 2.jpg" by Superbass, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Tatort_vier_Ermittler_2.jpg) +- `wc15739979`: "Giorgio Moroder.jpg" by Wolfgang Moroder, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Giorgio_Moroder.jpg) +- `wc49316526`: "Kadavar-Bandfoto.jpg" by Henry W. Laurisch, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Kadavar-Bandfoto.jpg) +- `wc10677986`: "Royal Wedding Stockholm 2010-Slottsbacken-05.jpg" by Holger Motzkau 2010, Wikipedia/Wikimedia Commons (cc-by-sa-3.0), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Royal_Wedding_Stockholm_2010-Slottsbacken-05.jpg) +- `wc46729139`: "Taipei Taiwan Jiaozi-Restaurant-14th-avenue-03.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-03.jpg) +- `wc34012281`: "Lijiang Yunnan China-Woman-with-weaving-loom-01.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Lijiang_Yunnan_China-Woman-with-weaving-loom-01.jpg) +- `wc4695242`: "NRWTag W Sonnborn 40 ies.jpg" by Frank Vincentz, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:NRWTag_W_Sonnborn_40_ies.jpg) +- `wc37097845`: "Penampang Sabah Dignitaries-at- Kaamatan-Celebrations-2014-01.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Penampang_Sabah_Dignitaries-at-_Kaamatan-Celebrations-2014-01.jpg) +- `wc40165063`: "Penampang Sabah Dignitaries-at- Kaamatan-Celebrations-2014-03.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Penampang_Sabah_Dignitaries-at-_Kaamatan-Celebrations-2014-03.jpg) +- `wc42363328`: "Semporna Sabah Regatta-Lepa-2015-06.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Regatta-Lepa-2015-06.jpg) +- `wc37669146`: "Shilin Yunnan China Shilin-Stone-Forest-09.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Shilin_Yunnan_China_Shilin-Stone-Forest-09.jpg) +- `wc38863393`: "Yogyakarta Indonesia Gamelan-players-with-gendèr-01.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Yogyakarta_Indonesia_Gamelan-players-with-gend%C3%A8r-01.jpg) +- `wc29965788`: "Jaisalmer-Citadel-06-Peacock fan merchant-20131010.jpg" by Daniel VILLAFRUELA, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Jaisalmer-Citadel-06-Peacock_fan_merchant-20131010.jpg) +- `wc50359073`: "20160607 Berlin Volbeat Volbeat 0393.jpg" by © Markus Felix | PushingPixels, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:20160607_Berlin_Volbeat_Volbeat_0393.jpg) +- `wc15690652`: "Valdi Totev.jpg" by Plamen Agov • studiolemontree, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Valdi_Totev.jpg) +- `wc41090507`: "Jakarta Indonesia Hawkers-in- Glodok-05.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Jakarta_Indonesia_Hawkers-in-_Glodok-05.jpg) +- `wc46729207`: "Taipei Taiwan Jiaozi-Restaurant-14th-avenue-04.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-04.jpg) +- `wc24879813`: "Pristina Bazaar February 2013 02.jpg" by Arild Vågen, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Pristina_Bazaar_February_2013_02.jpg) +- `wc33355555`: "BSBCC Sabah Wong-Siew-Te-02.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:BSBCC_Sabah_Wong-Siew-Te-02.jpg) +- `wc28942287`: "13-06 Budapest Dancing Show.jpg" by Achim Raschka, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:13-06_Budapest_Dancing_Show.jpg) +- `wc39110702`: "Ubud Bali Girl-with-selfie-stick-01.jpg" by CEphoto, Uwe Aranas, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Ubud_Bali_Girl-with-selfie-stick-01.jpg) +- `wc21375193`: "Paris - Crepe seller, Rue Mouffetard - 2008.jpg" by © Jorge Royan / http://www.royan.com.ar, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Paris_-_Crepe_seller,_Rue_Mouffetard_-_2008.jpg) +- `wc87185005`: "Slightly Business casual Informal wear - pose 2.jpg" by Tobias ToMar Maier, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Slightly_Business_casual_Informal_wear_-_pose_2.jpg) + +## CC BY-SA 2.0 fr (1 photos, https://creativecommons.org/licenses/by-sa/2.0/fr/deed.en) + +- `wc15722258`: "Moriarty-IMG 6846.jpg" by Photograph by Rama, Wikimedia Commons, Cc-by-sa-2.0-fr, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Moriarty-IMG_6846.jpg) + +## CC BY 4.0 (8 photos, https://creativecommons.org/licenses/by/4.0) + +- `wc197117660`: "Suha Al-Masri.jpg" by Fuad Al-Qrize, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Suha_Al-Masri.jpg) +- `wc36722719`: "November 11th ceremony in Toulouse in 2014 - 3826.jpg" by Pierre-Selim Huard, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:November_11th_ceremony_in_Toulouse_in_2014_-_3826.jpg) +- `wc143058460`: "Eva Nogales in 2023 06.jpg" by Cmichel67, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Eva_Nogales_in_2023_06.jpg) +- `wc77136330`: "IntoPIX aux Journées de l'Industrie 2019, UCLouvain (DSCF7897).jpg" by Trougnouf (Benoit Brummer), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:IntoPIX_aux_Journ%C3%A9es_de_l%27Industrie_2019,_UCLouvain_(DSCF7897).jpg) +- `wc148617194`: "Woman hanging out with a donkey in Louvain-la-Neuve (DSC03050).jpg" by Trougnouf (Benoit Brummer), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Woman_hanging_out_with_a_donkey_in_Louvain-la-Neuve_(DSC03050).jpg) +- `wc64787263`: "Adrian Horridge FRS.jpg" by Thennicke, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Adrian_Horridge_FRS.jpg) +- `wc149960906`: "Les Cuirs d'Agathe (DSC04126).jpg" by Trougnouf (Benoit Brummer), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Les_Cuirs_d%27Agathe_(DSC04126).jpg) +- `wc122361298`: "Hookah shop owners in Ramallah, Palestine (DSC03509).jpg" by Trougnouf (Benoit Brummer), Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Hookah_shop_owners_in_Ramallah,_Palestine_(DSC03509).jpg) + +## CC0 (27 photos, no attribution required; listed for provenance) + +- `f25a67e0-e2c3-4918-a19b-fe9e1a65bd8f`: "Couple Park" by Senior Living, Stocksnap via Openverse (https://stocksnap.io/photo/couple-park-GL9XJQTLJK) +- `ef82c049-117e-4e35-a432-b4d6796efb0e`: "Crittenden Rawlins, Critt Rawlins's tiny" by Carol M Highsmith, Rawpixel via Openverse (https://www.rawpixel.com/image/8068533/photo-image-person-shirt-clothing) +- `ba7f0e82-efc6-4fe8-a12b-804c45c1c361`: "Woman Reading" by Burst, Stocksnap via Openverse (https://stocksnap.io/photo/woman-reading-VJM1ZWXLPY) +- `wc25393535`: "Coconut water vendor.jpg" by Wilfredor, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Coconut_water_vendor.jpg) +- `wc145843601`: "Khasi Lady in a Kitchen.jpg" by Wann Majaw, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Khasi_Lady_in_a_Kitchen.jpg) +- `ba231d2e-b834-4898-b6a0-2f154e708c09`: "Hospital Waiting" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/hospital-waiting-SSDEQHS17S) +- `wc25152397`: "Sad tomato seller.jpg" by Wilfredor, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sad_tomato_seller.jpg) +- `dc5c1ac5-784d-469a-a37f-e313079908ee`: "Stairs Stairway" by Brooke Cagle, Stocksnap via Openverse (https://stocksnap.io/photo/stairs-stairway-D4XWI5PN82) +- `63a89c1d-dc76-41e5-95e9-5157825cd504`: "People Man" by Glen McCallum, Stocksnap via Openverse (https://stocksnap.io/photo/people-man-RWMC95HRC0) +- `b036af66-8c49-403b-9f0b-38ff46a89f73`: "Man Entering" by Bruce Mars, Stocksnap via Openverse (https://stocksnap.io/photo/man-entering-7GXMY2JMR4) +- `c70bc7ee-1701-4a79-94cd-f5325b6d5e30`: "Male Nurse" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/male-nurse-8OYPFEL4K8) +- `04e3d2a8-27ca-431c-92e1-402527e6b824`: "Wheelchair Person" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/wheelchair-person-OQZYXPNK5H) +- `6e58849a-cb37-4b82-930f-5546480e7417`: "Doctor Patient" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/doctor-patient-RZCTEGBC2V) +- `3b81d7c7-3cf6-4be8-8f01-75c9919c9bb8`: "Male Nurse" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/male-nurse-U1PTBWATO7) +- `wc26244423`: "Upholstering the seats of your own car, Margarita Island, Venezuela.jpg" by Wilfredor, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Upholstering_the_seats_of_your_own_car,_Margarita_Island,_Venezuela.jpg) +- `wc25393546`: "Palms seller for Palm Sunday.jpg" by Wilfredor, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Palms_seller_for_Palm_Sunday.jpg) +- `32b862ba-7f9b-4cac-b802-20e3661dcfe5`: "ORAU summer program ORNL 2014" by usdoe, Rawpixel via Openverse (https://www.rawpixel.com/image/8736408/orau-summer-program-ornl-2014-oak-ridge) +- `4114f183-6307-4f8e-8e87-b68d8620009f`: "FD Student Chef Team" by U.S. Army, Rawpixel via Openverse (https://www.rawpixel.com/image/8739012/student-chef-team) +- `16657fe8-b95c-4888-93ba-ed5a8d56735a`: "Young man wood workshop" by The African Union Mission in Somalia, Rawpixel via Openverse (https://www.rawpixel.com/image/8708782/photo-image-public-domain-person-black) +- `4951796a-8d80-4937-87a6-6c40afae9dae`: "NTRC 3D printing 2014 Knoxville" by usdoe, Rawpixel via Openverse (https://www.rawpixel.com/image/8736316/ntrc-printing-2014-knoxville) +- `wc107976362`: "Alexander Serov (directeur sportif Gazprom) au matin de la première étape du Tour de l'Ain 2021.jpg" by Benoît Prieur, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Alexander_Serov_(directeur_sportif_Gazprom)_au_matin_de_la_premi%C3%A8re_%C3%A9tape_du_Tour_de_l%27Ain_2021.jpg) +- `255d4a22-4470-4638-9128-f10a6ebb503e`: "Happy Couple" by Senior Living, Stocksnap via Openverse (https://stocksnap.io/photo/happy-couple-7HBHYQSHPL) +- `40f1c4c5-b84c-42a0-a81d-ae528001bd7c`: "Diverse Workplace" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/diverse-workplace-UJ1P4WLT4N) +- `wc24642095`: "Cepillao ice cream vendor.jpg" by Wilfredor, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Cepillao_ice_cream_vendor.jpg) +- `10494e50-fd2e-47f6-9295-0248b1eeed09`: "Happy Couple" by Senior Living, Stocksnap via Openverse (https://stocksnap.io/photo/happy-couple-VXFRCXXFG6) +- `4cc5938a-c9bd-4377-a4c6-d57192056040`: "Man Desk" by LinkedIn Sales Navigator, Stocksnap via Openverse (https://stocksnap.io/photo/man-desk-QPJWWR3W2E) +- `5f2648aa-cf39-42f7-b53a-e5fa703a296f`: "Man Exiting" by Bruce Mars, Stocksnap via Openverse (https://stocksnap.io/photo/man-exiting-1GYKJQOTMM) diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..d111cd06221eb144c33c0b29524b9ff133527a2e --- /dev/null +++ b/README.md @@ -0,0 +1,81 @@ +--- +license: cc-by-sa-4.0 +pretty_name: Multi-step Image Edit (identity drift at step 5) +tags: +- image-editing +- human-preference +- benchmark +- identity +size_categories: +- 10K png rule), seed optional", + "status": "on_leaderboard", + "participant_id": "par_1Zqcin3reEdVrL", + "list_price_per_image_usd": 0.043, + "price_basis": "Google: 1,120 out tok x $30/M + 1,120 in x $1.50/M + ~1,000 thinking x $7.50/M", + "reached_step5": "192/199" + }, + { + "name": "nano-banana-pro", + "label": "Nano Banana Pro", + "provider": "fal", + "endpoint": "fal-ai/nano-banana-pro/edit", + "image_field": "image_urls", + "shape": "aspect_ratio", + "send": { + "resolution": "1K", + "output_format": "png", + "safety_tolerance": "6", + "enable_web_search": false, + "limit_generations": true, + "num_images": 1 + }, + "seed": true, + "source": "as Nano Banana 2.1; thinking always on with a single level, so not sent", + "status": "on_leaderboard", + "participant_id": "par_1ZqcjI3Jy4BUCH", + "list_price_per_image_usd": 0.148, + "price_basis": "Google: 1,120 out tok x $120/M + 560 in x $2/M + ~1,000 thinking x $12/M", + "reached_step5": "185/199" + }, + { + "name": "seedream-5-pro", + "label": "Seedream 5.0 Pro", + "provider": "fal", + "endpoint": "bytedance/seedream/v5/pro/edit", + "image_field": "image_urls", + "shape": "fixed", + "send": { + "image_size": "auto_2K", + "watermark": false, + "output_format": "jpeg", + "enhance_prompt_mode": "standard", + "background": "opaque", + "num_images": 1, + "enable_safety_checker": false + }, + "seed": false, + "source": "BytePlus ModelArk: watermark default true (-> off, intervention), output_format default jpeg, optimize_prompt mode default standard, size 2K", + "status": "on_leaderboard", + "participant_id": "par_1ZqcjmwxM2fP66", + "list_price_per_image_usd": 0.09, + "price_basis": "BytePlus ModelArk >2.61 MP tier $0.09/image (v2 outputs 4.15 MP at the 2K default)", + "reached_step5": "192/199" + }, + { + "name": "seedream-5-lite", + "label": "Seedream 5.0 Lite", + "provider": "fal", + "endpoint": "bytedance/seedream/v5/lite/edit", + "image_field": "image_urls", + "shape": "fixed", + "send": { + "image_size": "auto_2K", + "watermark": false, + "output_format": "jpeg", + "num_images": 1, + "max_images": 1, + "enable_safety_checker": false + }, + "seed": false, + "source": "BytePlus ModelArk: watermark default true (-> off), output_format jpeg, prompt optimisation standard (fast unsupported), default size 2048x2048 square (-> keep-aspect auto_2K, shape intervention), min 2560x1440", + "status": "on_leaderboard", + "participant_id": "par_1ZqckGxhfElEwY", + "list_price_per_image_usd": 0.035, + "price_basis": "BytePlus ModelArk $0.035/image, input free", + "reached_step5": "188/199" + }, + { + "name": "muse", + "label": "Muse Image", + "provider": "fal", + "endpoint": "meta/muse-image/edit", + "image_field": "image_urls", + "shape": "aspect_ratio", + "send": { + "output_format": "webp", + "num_images": 1 + }, + "seed": false, + "source": "Meta images API: output_format default webp, reasoning_strength default high (max; not exposed on fal), moderation auto/low (not exposed on fal), no seed", + "status": "on_leaderboard", + "participant_id": "par_1ZqckkPfwoUxSz", + "list_price_per_image_usd": 0.01, + "price_basis": "Meta Model API flat $0.01/image", + "reached_step5": "190/199" + }, + { + "name": "flux-3", + "label": "FLUX 3 Image", + "provider": "fal", + "endpoint": "blackforestlabs/flux-3/edit-image", + "image_field": "image_urls", + "shape": "aspect_ratio", + "send": { + "resolution": "1k", + "output_format": "png", + "safety_tolerance": 4, + "enable_prompt_expansion": false + }, + "seed": false, + "source": "BFL openapi Flux3ImageInputs: no format, seed or expansion field; resolution 1k; safety_tolerance default 2 on 0-7 (fal max 4); grounding true; docs: FLUX 3 expands every instruction itself", + "status": "on_leaderboard", + "participant_id": "par_1ZqclEHD4AV5Lx", + "list_price_per_image_usd": 0.048, + "price_basis": "BFL 1k tier 4.8c, reference images free", + "reached_step5": "193/199" + }, + { + "name": "ideogram-4.5", + "label": "Ideogram 4.5 (High Quality, High Precision)", + "provider": "fal", + "endpoint": "ideogram/v4.5/edit", + "image_field": "image_url", + "shape": "fixed", + "send": { + "image_size": "auto", + "quality": "high", + "edit_precision": "high", + "context_window": "none", + "num_images": 1, + "enable_safety_checker": false + }, + "seed": true, + "source": "Ideogram openapi precise-edit/ideogram-4-5: quality default medium (max high), seed supported, no magic_prompt on precise edit; no format setting", + "status": "on_leaderboard", + "participant_id": "par_1ZqcliNedxU86d", + "list_price_per_image_usd": 0.22, + "price_basis": "Ideogram API quality high $0.22/image", + "reached_step5": "195/199" + }, + { + "name": "mai-image-2.5-pro", + "label": "MAI-Image-2.5-Pro", + "provider": "fal", + "endpoint": "microsoft/mai-image-2.5-pro/edit", + "image_field": "image_url", + "shape": "aspect_ratio", + "send": { + "output_format": "png", + "num_images": 1 + }, + "seed": false, + "source": "Microsoft Foundry MAI: output always PNG, edit inputs JPEG/PNG, no size field on edits, 2.5 max 1,048,576 px", + "status": "on_leaderboard", + "participant_id": "par_1ZqcmCtOtXcinz", + "list_price_per_image_usd": 0.117, + "price_basis": "Microsoft Foundry $106/M out, $8/M image in; ~1,024 tok/MP inferred", + "reached_step5": "172/199" + }, + { + "name": "grok-imagine-2.0", + "label": "Grok Imagine Image 2.0 (Medium Quality)", + "provider": "fal", + "endpoint": "xai/grok-imagine-image/v2.0/edit", + "image_field": "image_urls", + "shape": "aspect_ratio", + "send": { + "quality": "medium", + "resolution": "1k", + "output_format": "jpeg", + "num_images": 1, + "enable_safety_checker": false + }, + "seed": false, + "source": "xAI images: quality low/medium/auto default auto (medium = max), resolution 1k, mime jpeg unless quality produces png, aspect default auto", + "status": "on_leaderboard", + "participant_id": "par_1ZqcofFmAZr4Yi", + "list_price_per_image_usd": 0.04, + "price_basis": "xAI pricing page, flat $0.04/image", + "reached_step5": "175/199" + }, + { + "name": "kling-o1", + "label": "Kling Image O1", + "provider": "fal", + "endpoint": "fal-ai/kling-image/o1", + "image_field": "image_urls", + "shape": "aspect_ratio", + "send": { + "resolution": "1K", + "output_format": "png", + "num_images": 1, + "enable_safety_checker": false + }, + "seed": false, + "source": "Kling omni image API: model_name default kling-image-o1 (this model), resolution 1k, aspect auto, watermark_info optional separate copy, no format field (-> png rule). Chosen over Kling Image 3.0 Omni because fal's o3 endpoint does not report which model runs (Ani, 2026-10-30)", + "status": "on_leaderboard", + "participant_id": "par_1Zqcme5IPaYe28", + "list_price_per_image_usd": 0.028, + "price_basis": "Kling API 8 units x $0.0035", + "reached_step5": "167/199" + }, + { + "name": "wan-2.7-pro", + "label": "Wan 2.7 Pro", + "provider": "fal", + "endpoint": "fal-ai/wan/v2.7/pro/edit", + "image_field": "image_urls", + "shape": "exact", + "send": { + "output_format": "png", + "enable_prompt_expansion": false, + "num_images": 1, + "enable_safety_checker": false + }, + "seed": true, + "source": "Alibaba Wan image API: PNG, watermark default false, edits 2K at input aspect, seed optional, no prompt_extend listed for wan2.7-image-pro", + "status": "on_leaderboard", + "participant_id": "par_1ZqcnCQjqEzo3J", + "list_price_per_image_usd": 0.075, + "price_basis": "Alibaba Model Studio wan2.7-image-pro $0.075, output only", + "reached_step5": "178/199" + }, + { + "name": "qwen-image-3.0-pro", + "label": "Qwen-Image-3.0-Pro (Thinking)", + "provider": "dashscope", + "endpoint": "qwen-image-3.0-pro", + "image_field": null, + "shape": "exact", + "send": { + "n": 1, + "watermark": false, + "prompt_extend": true, + "enable_thinking": true + }, + "seed": true, + "source": "Alibaba Model Studio qwen-image API: prompt_extend default true, enable_thinking default true, watermark default false, PNG output, size w*h (default model-picked), seed optional", + "status": "on_leaderboard", + "participant_id": "par_1Zqcnfvh0ICqlR", + "list_price_per_image_usd": 0.043, + "price_basis": "Alibaba Model Studio (Singapore) 1K $0.04 output + $0.003 input image", + "reached_step5": "191/199" + }, + { + "name": "qwen-image-2.1-pro", + "label": "Qwen-Image-2.1-Pro (Thinking)", + "provider": "dashscope", + "endpoint": "qwen-image-2.1-pro", + "image_field": null, + "shape": "exact", + "send": { + "n": 1, + "watermark": false, + "prompt_extend": true, + "enable_thinking": true + }, + "seed": true, + "source": "Alibaba Model Studio qwen-image API: prompt_extend default true, enable_thinking default true (requires prompt_extend), watermark default false, PNG output, size w*h, seed optional", + "status": "on_leaderboard", + "participant_id": "par_1ZqcoB8cEAbf76", + "list_price_per_image_usd": 0.04, + "price_basis": "Alibaba Model Studio (Singapore) $0.04/image", + "reached_step5": "191/199" + }, + { + "name": "qwen-image-edit-2511", + "label": "Qwen-Image-Edit-2511", + "provider": "fal", + "endpoint": "fal-ai/qwen-image-edit-2511", + "image_field": "image_urls", + "shape": "exact", + "send": { + "num_images": 1, + "output_format": "png", + "enable_safety_checker": false + }, + "seed": true, + "source": "open weights, no lab API: fal schema; steps 28, acceleration regular, guidance 4.5 left at default (v2 rule: open-weights dials at default); png default; checker off", + "status": "on_leaderboard", + "participant_id": "par_1ZrTY2UFNLac98", + "list_price_per_image_usd": 0.03, + "price_basis": "Alibaba Model Studio qwen-image-edit-plus $0.03/image (open weights)", + "reached_step5": "160/199" + }, + { + "name": "nano-banana-2", + "label": "Nano Banana 2 (High Thinking)", + "provider": "fal", + "endpoint": "fal-ai/nano-banana-2/edit", + "image_field": "image_urls", + "shape": "aspect_ratio", + "send": { + "thinking_level": "high", + "resolution": "1K", + "output_format": "png", + "safety_tolerance": "6", + "enable_web_search": false, + "limit_generations": true, + "num_images": 1 + }, + "seed": true, + "source": "as Nano Banana 2.1: Gemini 1K default, thinking high = max, png (no Google default), safety_tolerance 6 = least restrictive, web search off", + "status": "on_leaderboard", + "participant_id": "par_1ZrTYu0JqTTp2g", + "list_price_per_image_usd": 0.071, + "price_basis": "Google: 1,120 out tok x $60/M + input + ~1,000 thinking x $3/M", + "reached_step5": "183/199" + }, + { + "name": "gpt-image-2.6-sunburst", + "label": "GPT Image 2.6 Sunburst (Max Quality, High Reasoning)", + "provider": "fal", + "endpoint": "openai/gpt-image-2.6/sunburst/edit", + "image_field": "image_urls", + "shape": "fixed", + "send": { + "image_size": "auto", + "quality": "max", + "reasoning_effort": "high", + "background": "auto", + "output_format": "png", + "num_images": 1, + "enable_safety_checker": false + }, + "seed": false, + "source": "fal schema 2026-11-05: quality default high (max exists), reasoning_effort low/medium/high default high (= max), output_format default png, image_size auto keeps the input shape, background auto (OpenAI default); no seed; checker off", + "status": "on_leaderboard", + "list_price_per_image_usd": 0.18, + "price_basis": "OpenAI token rates ($30/M image out, $8/M image in, $5/M text in) × measured usage at our settings: 5,488 output tokens (3:2, 2:3), 8,232 (1:1); weighted 182/17", + "reached_step5": "196/199", + "participant_id": "par_1a2UkRyJ71D4J8" + }, + { + "name": "gpt-image-2.6-flare", + "label": "GPT Image 2.6 Flare (Max Quality, High Reasoning)", + "provider": "fal", + "endpoint": "openai/gpt-image-2.6/flare/edit", + "image_field": "image_urls", + "shape": "fixed", + "send": { + "image_size": "auto", + "quality": "max", + "reasoning_effort": "high", + "background": "auto", + "output_format": "png", + "num_images": 1, + "enable_safety_checker": false + }, + "seed": false, + "source": "fal schema 2026-11-05: quality default high (max exists), reasoning_effort low/medium/high default high (= max), output_format default png, image_size auto keeps the input shape, background auto (OpenAI default); no seed; checker off", + "status": "on_leaderboard", + "list_price_per_image_usd": 0.18, + "price_basis": "OpenAI token rates ($30/M image out, $8/M image in, $5/M text in) × measured usage at our settings: 5,488 output tokens (3:2, 2:3), 8,232 (1:1); weighted 182/17", + "reached_step5": "194/199", + "participant_id": "par_1a2UlVdJSE8VFt" + } + ] +} \ No newline at end of file diff --git a/metadata/photos.jsonl b/metadata/photos.jsonl new file mode 100644 index 0000000000000000000000000000000000000000..6ce160584e4857548411f7d38fa0367e4b124320 --- /dev/null +++ b/metadata/photos.jsonl @@ -0,0 +1,199 @@ +{"photo_id": "wc15467676", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change her green blouse to red.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the red blouse large white dots.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change her cream headscarf to blue.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "replace", "instruction": "Replace all the purple eggplants with red tomatoes.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the blue headscarf's material to silk.", "item": "hair_headwear_glasses"}], "people_visible": 2, "face_box": [0.30245, 0.0254, 0.53107, 0.36815], "tags": {"edit_target": ["hair_headwear_glasses", "objects", "tops_dresses"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:FarmWorker.JPG", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Arne Hückelheim", "attribution_required": "true"}, "source": {"title": "FarmWorker.JPG", "page": "https://commons.wikimedia.org/wiki/File:FarmWorker.JPG", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/2d/FarmWorker.JPG", "creator": "Arne Hückelheim", "creator_url": null, "original_width": 3888, "original_height": 2592, "found_via": "Openverse search: vendor"}, "reference_made_by": {"original_size": [3888, 2592], "crop_box_px": [0, 0, 3888, 2592], "size": [1248, 832], "icc_profile": "sRGB v1.31 (Canon)", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 45.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc61267439", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the trousers to black.", "item": "trousers_skirts_belts"}, {"step": 2, "edit_type": "replace", "instruction": "Replace his jacket with a white buttoned shirt on his body.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the black trousers' material to velvet.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Give the white shirt large blue flowers.", "item": "tops_dresses"}, {"step": 5, "edit_type": "add", "instruction": "Add a red scarf around his neck, below his chin.", "item": "scarves_ties_collars_badges"}], "people_visible": 1, "face_box": [0.44278, 0.00608, 0.63263, 0.19593], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:BandoneonistaMDP-jul2017.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Ezarate", "attribution_required": "true"}, "source": {"title": "BandoneonistaMDP-jul2017.jpg", "page": "https://commons.wikimedia.org/wiki/File:BandoneonistaMDP-jul2017.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/84/BandoneonistaMDP-jul2017.jpg", "creator": "Ezarate", "creator_url": null, "original_width": 3311, "original_height": 3546, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3311, 3546], "crop_box_px": [21, 277, 3290, 3546], "size": [1024, 1024], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 36.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "f25a67e0-e2c3-4918-a19b-fe9e1a65bd8f", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the woman's mustard yellow coat to red.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the man's navy jacket to green.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Give the green jacket large white stars.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the wooden bench slats to blue.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the woman's pink scarf to purple.", "item": "scarves_ties_collars_badges"}], "people_visible": 2, "face_box": [0.22904, 0.20877, 0.41462, 0.487], "tags": {"edit_target": ["objects", "scarves_ties_collars_badges", "tops_dresses"], "people": ["two"], "face_size": ["medium"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/couple-park-GL9XJQTLJK", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Senior Living", "attribution_required": "false"}, "source": {"title": "Couple Park", "page": "https://stocksnap.io/photo/couple-park-GL9XJQTLJK", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/GL9XJQTLJK.jpg", "creator": "Senior Living", "creator_url": "https://stocksnap.io/author/148922", "original_width": 5760, "original_height": 3840, "found_via": "Openverse search: couple park"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 41.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc31140258", "steps": [{"step": 1, "edit_type": "change", "instruction": "Give the shorts a pattern of large yellow stars.", "item": "trousers_skirts_belts"}, {"step": 2, "edit_type": "change", "instruction": "Change the black wristband to red.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "add", "instruction": "Add a thick silver chain necklace around his neck.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "change", "instruction": "Change the sleeveless shirt to green.", "item": "tops_dresses"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole red wristband.", "item": "jewellery_watches"}], "people_visible": 1, "face_box": [0.25672, 0.09569, 0.54307, 0.28668], "tags": {"edit_target": ["jewellery_watches", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Antti_Kiiski_-_Rakuunarock_2013.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Tuomas Vitikainen", "attribution_required": "true"}, "source": {"title": "Antti Kiiski - Rakuunarock 2013.jpg", "page": "https://commons.wikimedia.org/wiki/File:Antti_Kiiski_-_Rakuunarock_2013.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/5/50/Antti_Kiiski_-_Rakuunarock_2013.jpg", "creator": "Tuomas Vitikainen", "creator_url": null, "original_width": 2848, "original_height": 4288, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [2848, 4288], "crop_box_px": [0, 8, 2848, 4280], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 50.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc177092456", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the open grey shirt's material to jeans cloth.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a thick yellow necklace around his neck, over the T-shirt.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "add", "instruction": "Add large blue \"LIVE\" text across the T-shirt's lower chest.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the yellow necklace to blue.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the necklace with an orange bead necklace around his neck.", "item": "jewellery_watches"}], "people_visible": 1, "face_box": [0.07352, 0.01985, 0.63516, 0.39446], "tags": {"edit_target": ["jewellery_watches", "text_signs", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Max_Giesinger_-_2021-09-12_-_Mannheim_-_Sven_Mandel_-_1D_X_MK_II_-_0229_-_B70I3683_(re-developed).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Original: Sven Mandel Derivative work: Radomianin", "attribution_required": "true"}, "source": {"title": "Max Giesinger - 2021-09-12 - Mannheim - Sven Mandel - 1D X MK II - 0229 - B70I3683 (re-developed).jpg", "page": "https://commons.wikimedia.org/wiki/File:Max_Giesinger_-_2021-09-12_-_Mannheim_-_Sven_Mandel_-_1D_X_MK_II_-_0229_-_B70I3683_(re-developed).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/3/30/Max_Giesinger_-_2021-09-12_-_Mannheim_-_Sven_Mandel_-_1D_X_MK_II_-_0229_-_B70I3683_%28re-developed%29.jpg", "creator": "Original: Sven Mandel\nDerivative work: Radomianin", "creator_url": null, "original_width": 3082, "original_height": 4623, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [3082, 4623], "crop_box_px": [0, 0, 3082, 4623], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 51.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc61616231", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the man's shirt to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the man's jacket to wool.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a short red scarf around the man's neck, below his chin.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "add", "instruction": "Add a large white leaf picture on the man's lower jacket.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Give the man's orange turban large white dots.", "item": "hair_headwear_glasses"}], "people_visible": 2, "face_box": [0.22039, 0.09641, 0.4843, 0.49208], "tags": {"edit_target": ["hair_headwear_glasses", "scarves_ties_collars_badges", "tops_dresses"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Villagers_from_Madhya_Pradesh_Couple_1.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Suyash Dwivedi", "attribution_required": "true"}, "source": {"title": "Villagers from Madhya Pradesh Couple 1.jpg", "page": "https://commons.wikimedia.org/wiki/File:Villagers_from_Madhya_Pradesh_Couple_1.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/5/5c/Villagers_from_Madhya_Pradesh_Couple_1.jpg", "creator": "Suyash Dwivedi", "creator_url": null, "original_width": 4605, "original_height": 3070, "found_via": "Openverse search: farmer"}, "reference_made_by": {"original_size": [4605, 3070], "crop_box_px": [0, 0, 4605, 3070], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 42.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc98796115", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the brown jacket to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue jacket a large white check pattern.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the grey sweater to green.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Give the green sweater large black zigzags.", "item": "tops_dresses"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the blue jacket with white checks.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.36791, 0.11696, 0.71542, 0.63797], "tags": {"edit_target": ["tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Francesco_Maselli.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Giacomo Alessandroni", "attribution_required": "true"}, "source": {"title": "Francesco Maselli.jpg", "page": "https://commons.wikimedia.org/wiki/File:Francesco_Maselli.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/1/1d/Francesco_Maselli.jpg", "creator": "Giacomo Alessandroni", "creator_url": null, "original_width": 2856, "original_height": 2142, "found_via": "Openverse search: jacket"}, "reference_made_by": {"original_size": [2856, 2142], "crop_box_px": [0, 110, 2856, 2014], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 50.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "ef82c049-117e-4e35-a432-b4d6796efb0e", "steps": [{"step": 1, "edit_type": "change", "instruction": "Cover the man's jacket with brown and black leopard spots.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a wide brown cloth tie under his shirt collar.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "change", "instruction": "Make the brown tie knitted.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the leopard jacket with a brown vest over his shirt.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the knitted tie to orange.", "item": "scarves_ties_collars_badges"}], "people_visible": 1, "face_box": [0.40016, 0.0615, 0.57595, 0.32506], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Rawpixel via Openverse", "page": "https://www.rawpixel.com/image/8068533/photo-image-person-shirt-clothing", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Carol M Highsmith", "attribution_required": "false"}, "source": {"title": "Crittenden Rawlins, Critt Rawlins's tiny", "page": "https://www.rawpixel.com/image/8068533/photo-image-person-shirt-clothing", "image_url": "https://images.rawpixel.com/editor_1024/cHJpdmF0ZS9sci9pbWFnZXMvd2Vic2l0ZS8yMDIyLTA5L2xvYzIwMjA3MjIxNjgtaW1hZ2UuanBn.jpg", "creator": "Carol M Highsmith", "creator_url": null, "original_width": 13396, "original_height": 8957, "found_via": "Openverse search: clothing store"}, "reference_made_by": {"original_size": [1024, 685], "crop_box_px": [0, 1, 1024, 684], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 39.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc155185732", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the tie's material to thick, knitted wool.", "item": "scarves_ties_collars_badges"}, {"step": 2, "edit_type": "change", "instruction": "Give the jacket a pattern of large grey squares.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the man's white hair to brown.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the jacket with a long plain brown coat on the man.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the coat's colour to blue.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.26743, 0.10883, 0.73774, 0.42252], "tags": {"edit_target": ["hair_headwear_glasses", "scarves_ties_collars_badges", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Mississippi_Supreme_Court_Justice_Jim_Kitchens.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Timothy Holdiness", "attribution_required": "true"}, "source": {"title": "Mississippi Supreme Court Justice Jim Kitchens.jpg", "page": "https://commons.wikimedia.org/wiki/File:Mississippi_Supreme_Court_Justice_Jim_Kitchens.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/b/ba/Mississippi_Supreme_Court_Justice_Jim_Kitchens.jpg", "creator": "Timothy Holdiness", "creator_url": null, "original_width": 3024, "original_height": 4032, "found_via": "Openverse search: cook kitchen"}, "reference_made_by": {"original_size": [3024, 4032], "crop_box_px": [115, 0, 2803, 4032], "size": [832, 1248], "icc_profile": "Display P3", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 32.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "ba7f0e82-efc6-4fe8-a12b-804c45c1c361", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the white shirt with a blue long-sleeved sweater.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the black trousers to green.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "change", "instruction": "Change the woman's dark hair to pink.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "change", "instruction": "Change the blue sweater's pattern to large white zigzags.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the green trousers' pattern to large black spots.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.22567, 0.21047, 0.40514, 0.47954], "tags": {"edit_target": ["hair_headwear_glasses", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/woman-reading-VJM1ZWXLPY", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Burst", "attribution_required": "false"}, "source": {"title": "Woman Reading", "page": "https://stocksnap.io/photo/woman-reading-VJM1ZWXLPY", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/VJM1ZWXLPY.jpg", "creator": "Burst", "creator_url": "https://burst.shopify.com", "original_width": 4460, "original_height": 2973, "found_via": "Openverse search: woman reading book"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 42.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc170348170", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large red pin to the shirt's upper chest.", "item": "jewellery_watches"}, {"step": 2, "edit_type": "change", "instruction": "Change the shirt's material to velvet.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the neck strap with a wide red one around his neck.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the velvet shirt with a white jacket on his upper body.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Give the white jacket a large green leaf pattern.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.31408, 0.12271, 0.68998, 0.37344], "tags": {"edit_target": ["jewellery_watches", "scarves_ties_collars_badges", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Dirk_Zedler,_Cycling_World_Europe_2025,_Meerbusch_(File1033-2-RR).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0/deed.en", "author": "Matti Blume", "attribution_required": "true"}, "source": {"title": "Dirk Zedler, Cycling World Europe 2025, Meerbusch (File1033-2-RR).jpg", "page": "https://commons.wikimedia.org/wiki/File:Dirk_Zedler,_Cycling_World_Europe_2025,_Meerbusch_(File1033-2-RR).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e0/Dirk_Zedler%2C_Cycling_World_Europe_2025%2C_Meerbusch_%28File1033-2-RR%29.jpg", "creator": "Matti Blume", "creator_url": null, "original_width": 3888, "original_height": 5184, "found_via": "Openverse search: engineer"}, "reference_made_by": {"original_size": [3888, 5184], "crop_box_px": [305, 0, 3761, 5184], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc22487838", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the white lab coat to purple.", "item": "tops_dresses"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the striped sweater with a yellow buttoned shirt under the coat.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the yellow shirt's material to wool with visible texture.", "item": "tops_dresses"}, {"step": 4, "edit_type": "add", "instruction": "Add a wide brown belt around the woman's waist, over the coat.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "change", "instruction": "Give the purple coat a pattern of large yellow triangles.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.35751, 0.11026, 0.81139, 0.413], "tags": {"edit_target": ["tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Geneetik_Riin_Tamm.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Lauri Kulpsoo", "attribution_required": "true"}, "source": {"title": "Geneetik Riin Tamm.jpg", "page": "https://commons.wikimedia.org/wiki/File:Geneetik_Riin_Tamm.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/88/Geneetik_Riin_Tamm.jpg", "creator": "Lauri Kulpsoo", "creator_url": null, "original_width": 2592, "original_height": 3888, "found_via": "Openverse search: laboratory"}, "reference_made_by": {"original_size": [2592, 3888], "crop_box_px": [0, 0, 2592, 3888], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 50.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc197117660", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change her white hoodie and trousers to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue hoodie and trousers large white dots.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change her dark hair to blonde.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "remove", "instruction": "Remove her whole silver wristwatch.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "replace", "instruction": "Replace both gold hoop earrings with small pearl earrings.", "item": "jewellery_watches"}], "people_visible": 1, "face_box": [0.14827, 0.05615, 0.68732, 0.41569], "tags": {"edit_target": ["hair_headwear_glasses", "jewellery_watches", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Suha_Al-Masri.jpg", "licence": "CC BY 4.0", "licence_url": "https://creativecommons.org/licenses/by/4.0", "author": "Fuad Al-Qrize", "attribution_required": "true"}, "source": {"title": "Suha Al-Masri.jpg", "page": "https://commons.wikimedia.org/wiki/File:Suha_Al-Masri.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/c6/Suha_Al-Masri.jpg", "creator": "Fuad Al-Qrize", "creator_url": null, "original_width": 3840, "original_height": 5760, "found_via": "Openverse search: woman musician"}, "reference_made_by": {"original_size": [3840, 5760], "crop_box_px": [0, 0, 3840, 5760], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 41.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc49640230", "steps": [{"step": 1, "edit_type": "change", "instruction": "Give the trousers a large grey check pattern.", "item": "trousers_skirts_belts"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the tie with a wide white tie under the collar.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "change", "instruction": "Change the jacket to pink.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the white tie to grey.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole tie.", "item": "scarves_ties_collars_badges"}], "people_visible": 1, "face_box": [0.28122, 0.01916, 0.56174, 0.20627], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Alon_Ben_David.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Channel10israel", "attribution_required": "true"}, "source": {"title": "Alon Ben David.jpg", "page": "https://commons.wikimedia.org/wiki/File:Alon_Ben_David.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/ab/Alon_Ben_David.jpg", "creator": "Channel10israel", "creator_url": null, "original_width": 3744, "original_height": 5616, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3744, 5616], "crop_box_px": [0, 0, 3744, 5616], "size": [832, 1248], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 40.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc127813216", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the black suit jacket to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a red bow tie at the white shirt's collar.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "change", "instruction": "Change the blue jacket's material to velvet.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the black trousers to grey.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the red bow tie.", "item": "scarves_ties_collars_badges"}], "people_visible": 1, "face_box": [0.32796, 0.03843, 0.77646, 0.33757], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Bakhtiyor_Rakhman.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Umarxon III", "attribution_required": "true"}, "source": {"title": "Bakhtiyor Rakhman.jpg", "page": "https://commons.wikimedia.org/wiki/File:Bakhtiyor_Rakhman.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/8a/Bakhtiyor_Rakhman.jpg", "creator": "Umarxon III", "creator_url": null, "original_width": 3840, "original_height": 5760, "found_via": "Openverse search: woman musician"}, "reference_made_by": {"original_size": [3840, 5760], "crop_box_px": [0, 0, 3840, 5760], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 56.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc113391732", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the medal and its ribbon.", "item": "scarves_ties_collars_badges"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the printed sleeveless shirt with a plain green one.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Give the green sleeveless shirt large white triangles.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the yellow helmet he is holding to blue.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add \"GO FAST\" in large black letters across the shirt.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.3639, 0.06056, 0.63263, 0.3293], "tags": {"edit_target": ["objects", "scarves_ties_collars_badges", "text_signs", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2021-12-12_Ebersp%C3%A4cher_Luge_World_Cup_Altenberg_1DX_4660_by_Stepro.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Steffen Prößdorf", "attribution_required": "true"}, "source": {"title": "2021-12-12 Eberspächer Luge World Cup Altenberg 1DX 4660 by Stepro.jpg", "page": "https://commons.wikimedia.org/wiki/File:2021-12-12_Ebersp%C3%A4cher_Luge_World_Cup_Altenberg_1DX_4660_by_Stepro.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/c2/2021-12-12_Ebersp%C3%A4cher_Luge_World_Cup_Altenberg_1DX_4660_by_Stepro.jpg", "creator": "Steffen Prößdorf", "creator_url": null, "original_width": 2738, "original_height": 2738, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2738, 2738], "crop_box_px": [0, 0, 2738, 2738], "size": [1024, 1024], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc128978025", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the black hat to dark green.", "item": "hair_headwear_glasses"}, {"step": 2, "edit_type": "remove", "instruction": "Remove the two medals from the jacket.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the white gloves with black leather gloves.", "item": "shoes_gloves"}, {"step": 4, "edit_type": "change", "instruction": "Change the black glasses frames to red.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "add", "instruction": "Add a red flower to the chest pocket on the picture's right.", "item": "scarves_ties_collars_badges"}], "people_visible": 8, "face_box": [0.24591, 0.03632, 0.76655, 0.38358], "tags": {"edit_target": ["hair_headwear_glasses", "scarves_ties_collars_badges", "shoes_gloves"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2023_National_Day_of_Brunei_52.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Pangalau", "attribution_required": "true"}, "source": {"title": "2023 National Day of Brunei 52.jpg", "page": "https://commons.wikimedia.org/wiki/File:2023_National_Day_of_Brunei_52.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/75/2023_National_Day_of_Brunei_52.jpg", "creator": "Pangalau", "creator_url": null, "original_width": 3191, "original_height": 4786, "found_via": "Openverse search: firefighter"}, "reference_made_by": {"original_size": [3191, 4786], "crop_box_px": [0, 0, 3191, 4786], "size": [832, 1248], "icc_profile": "Display P3", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 37.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc164397906", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the grey wall to light green.", "item": "objects"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the silver wristwatch with a gold wristwatch.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "change", "instruction": "Change the dark navy suit to grey.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the grey suit's material to corduroy.", "item": "tops_dresses"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole gold wristwatch.", "item": "jewellery_watches"}], "people_visible": 1, "face_box": [0.21859, 0.02334, 0.78764, 0.40289], "tags": {"edit_target": ["jewellery_watches", "objects", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Captain_Joe,_Friedrichshafen_(P1046580).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0/deed.en", "author": "Matti Blume", "attribution_required": "true"}, "source": {"title": "Captain Joe, Friedrichshafen (P1046580).jpg", "page": "https://commons.wikimedia.org/wiki/File:Captain_Joe,_Friedrichshafen_(P1046580).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/ec/Captain_Joe%2C_Friedrichshafen_%28P1046580%29.jpg", "creator": "Matti Blume", "creator_url": null, "original_width": 3608, "original_height": 4810, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3608, 4810], "crop_box_px": [6, 0, 3212, 4810], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 51.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc51544098", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the gold saxophone to silver.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the right man's brown jacket's material to denim.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Give the left man's blue suit large white dots.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the centre man's beige trousers to red.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole silver saxophone.", "item": "objects"}], "people_visible": 3, "face_box": [0.16147, 0.08006, 0.40157, 0.32016], "tags": {"edit_target": ["objects", "tops_dresses", "trousers_skirts_belts"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:WDR-Dreharbeiten_zu_Tatort_K%C3%B6ln_%E2%80%9EWacht_am_Rhein%E2%80%9C-8801.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Raimond Spekking", "attribution_required": "true"}, "source": {"title": "WDR-Dreharbeiten zu Tatort Köln „Wacht am Rhein“-8801.jpg", "page": "https://commons.wikimedia.org/wiki/File:WDR-Dreharbeiten_zu_Tatort_K%C3%B6ln_%E2%80%9EWacht_am_Rhein%E2%80%9C-8801.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e7/WDR-Dreharbeiten_zu_Tatort_K%C3%B6ln_%E2%80%9EWacht_am_Rhein%E2%80%9C-8801.jpg", "creator": "Raimond Spekking", "creator_url": null, "original_width": 3216, "original_height": 3216, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [3216, 3216], "crop_box_px": [0, 0, 3216, 3216], "size": [1024, 1024], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc186877996", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the centre woman's shirt background colour to orange.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a large purple bead necklace around the woman's neck.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "remove", "instruction": "Remove the purple bead necklace.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "change", "instruction": "Change the orange shirt's material to shiny silk.", "item": "tops_dresses"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the orange shirt with a yellow jacket on her upper body.", "item": "tops_dresses"}], "people_visible": 3, "face_box": [0.31651, 0.09633, 0.72024, 0.36562], "tags": {"edit_target": ["jewellery_watches", "tops_dresses"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Bhil_community_women_in_traditional_attire,_Jhabua,_Madhya_Pradesh,_India_(7).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Suyash Dwivedi", "attribution_required": "true"}, "source": {"title": "Bhil community women in traditional attire, Jhabua, Madhya Pradesh, India (7).jpg", "page": "https://commons.wikimedia.org/wiki/File:Bhil_community_women_in_traditional_attire,_Jhabua,_Madhya_Pradesh,_India_(7).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/5/59/Bhil_community_women_in_traditional_attire%2C_Jhabua%2C_Madhya_Pradesh%2C_India_%287%29.jpg", "creator": "Suyash Dwivedi", "creator_url": null, "original_width": 2178, "original_height": 3267, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [2178, 3267], "crop_box_px": [0, 0, 2178, 3267], "size": [832, 1248], "icc_profile": "Display P3", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 32.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc68327807", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the white scarf hanging over his shoulder.", "item": "scarves_ties_collars_badges"}, {"step": 2, "edit_type": "change", "instruction": "Change the white shirt to blue.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the blue shirt's pattern to large white leaves.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the trousers to brown.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the leaf-print shirt with a plain red shirt.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.45508, 0.11068, 0.58356, 0.30331], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Darshan_Singh,_Village_Akbarpur_Afghana.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Satdeep Gill", "attribution_required": "true"}, "source": {"title": "Darshan Singh, Village Akbarpur Afghana.jpg", "page": "https://commons.wikimedia.org/wiki/File:Darshan_Singh,_Village_Akbarpur_Afghana.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/3/34/Darshan_Singh%2C_Village_Akbarpur_Afghana.jpg", "creator": "Satdeep Gill", "creator_url": null, "original_width": 7952, "original_height": 5304, "found_via": "Openverse search: full length"}, "reference_made_by": {"original_size": [7952, 5304], "crop_box_px": [0, 0, 7952, 5302], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 41.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc45337546", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the right woman's purple bangle to yellow.", "item": "jewellery_watches"}, {"step": 2, "edit_type": "add", "instruction": "Add a wide red leather belt around the right woman's waist.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "change", "instruction": "Give the right woman's black dress large white dots.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the red leather belt to green.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the yellow bangle with a wide white bangle.", "item": "jewellery_watches"}], "people_visible": 2, "face_box": [0.67478, 0.17948, 0.88575, 0.49577], "tags": {"edit_target": ["jewellery_watches", "tops_dresses", "trousers_skirts_belts"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Ak55-Busy_afternoon.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Zuraj studio", "attribution_required": "true"}, "source": {"title": "Ak55-Busy afternoon.jpg", "page": "https://commons.wikimedia.org/wiki/File:Ak55-Busy_afternoon.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/c4/Ak55-Busy_afternoon.jpg", "creator": "Zuraj studio", "creator_url": null, "original_width": 5616, "original_height": 3744, "found_via": "Openverse search: fashion model"}, "reference_made_by": {"original_size": [5616, 3744], "crop_box_px": [0, 0, 5616, 3744], "size": [1248, 832], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 30.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc54050746", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the guitarist's black jacket to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the blue jacket from shiny leather to plain cloth.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the blue cloth jacket's pattern to large white squares.", "item": "tops_dresses"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the patterned blue jacket with a plain red sweater.", "item": "tops_dresses"}, {"step": 5, "edit_type": "add", "instruction": "Add a wide yellow scarf hanging around the guitarist's neck.", "item": "scarves_ties_collars_badges"}], "people_visible": 6, "face_box": [0.69698, 0.1475, 0.94826, 0.52425], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:ART_DANS_LA_RUE_ALGER_2.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "BRAHIM DJELLOUL Mustapha", "attribution_required": "true"}, "source": {"title": "ART DANS LA RUE ALGER 2.jpg", "page": "https://commons.wikimedia.org/wiki/File:ART_DANS_LA_RUE_ALGER_2.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/0/0e/ART_DANS_LA_RUE_ALGER_2.jpg", "creator": "BRAHIM DJELLOUL Mustapha", "creator_url": null, "original_width": 4928, "original_height": 3264, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4928, 3264], "crop_box_px": [16, 0, 4912, 3264], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 42.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc36840374", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the white sleeveless shirt to red.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a large brown bag over the left man's shoulder.", "item": "bags"}, {"step": 3, "edit_type": "change", "instruction": "Change the grey trousers to blue jeans cloth.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Give the red shirt large black dots.", "item": "tops_dresses"}, {"step": 5, "edit_type": "add", "instruction": "Add a large black hammer picture to the brown bag.", "item": "bags"}], "people_visible": 2, "face_box": [0.56077, 0.33135, 0.70528, 0.54801], "tags": {"edit_target": ["bags", "tops_dresses", "trousers_skirts_belts"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Marble_statue_makers,_near_Jaipur,_Rajasthan,_India.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Yann Forget", "attribution_required": "true"}, "source": {"title": "Marble statue makers, near Jaipur, Rajasthan, India.jpg", "page": "https://commons.wikimedia.org/wiki/File:Marble_statue_makers,_near_Jaipur,_Rajasthan,_India.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/b/be/Marble_statue_makers%2C_near_Jaipur%2C_Rajasthan%2C_India.jpg", "creator": "Yann Forget", "creator_url": null, "original_width": 3456, "original_height": 2304, "found_via": "Openverse search: craftsman"}, "reference_made_by": {"original_size": [3456, 2304], "crop_box_px": [0, 0, 3456, 2304], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 49.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc78443524", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change his black suit to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give his black tie large white dots.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "remove", "instruction": "Remove the whole headset microphone from his face.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the dotted tie with a red bow tie.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "change", "instruction": "Change his white shirt to pink.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.63877, 0.12764, 0.80387, 0.37517], "tags": {"edit_target": ["objects", "scarves_ties_collars_badges", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Rich_Kameda_BBG_New_York_April_2019.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "King of Hearts", "attribution_required": "true"}, "source": {"title": "Rich Kameda BBG New York April 2019.jpg", "page": "https://commons.wikimedia.org/wiki/File:Rich_Kameda_BBG_New_York_April_2019.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/91/Rich_Kameda_BBG_New_York_April_2019.jpg", "creator": "King of Hearts", "creator_url": null, "original_width": 4500, "original_height": 3000, "found_via": "Openverse search: living room"}, "reference_made_by": {"original_size": [4500, 3000], "crop_box_px": [0, 0, 4500, 3000], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc84023793", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the tan boots to black.", "item": "shoes_gloves"}, {"step": 2, "edit_type": "remove", "instruction": "Remove the whole arm patch from the jacket's sleeve.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the black watch with a red watch.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "change", "instruction": "Change the camouflage cap, jacket and trousers to plain navy.", "item": "tops_dresses"}, {"step": 5, "edit_type": "add", "instruction": "Add a large yellow star to the front of the navy cap.", "item": "hair_headwear_glasses"}], "people_visible": 1, "face_box": [0.33411, 0.1077, 0.66781, 0.33028], "tags": {"edit_target": ["hair_headwear_glasses", "jewellery_watches", "scarves_ties_collars_badges", "shoes_gloves", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:March_of_Ukraine%27s_Defenders_on_Independence_Day_in_Kyiv,_2019_373.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Ввласенко", "attribution_required": "true"}, "source": {"title": "March of Ukraine's Defenders on Independence Day in Kyiv, 2019 373.jpg", "page": "https://commons.wikimedia.org/wiki/File:March_of_Ukraine%27s_Defenders_on_Independence_Day_in_Kyiv,_2019_373.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/5/56/March_of_Ukraine%27s_Defenders_on_Independence_Day_in_Kyiv%2C_2019_373.jpg", "creator": "Ввласенко", "creator_url": null, "original_width": 2791, "original_height": 3731, "found_via": "Openverse search: volunteer"}, "reference_made_by": {"original_size": [2791, 3731], "crop_box_px": [161, 0, 2648, 3731], "size": [832, 1248], "icc_profile": "Nikon sRGB 4.0.0.3002", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc42363791", "steps": [{"step": 1, "edit_type": "change", "instruction": "Shorten the black shirt's sleeves to the elbows.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a large blue bead necklace around the man's neck.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "change", "instruction": "Change the red and green gas tank to blue.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the necklace with a thick orange chain necklace around his neck.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "change", "instruction": "Change \"Enduro\" on the engine to \"OCEAN\".", "item": "text_signs"}], "people_visible": 1, "face_box": [0.40088, 0.16113, 0.75705, 0.39869], "tags": {"edit_target": ["jewellery_watches", "objects", "text_signs", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Regatta-Lepa-2015-08.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Semporna Sabah Regatta-Lepa-2015-08.jpg", "page": "https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Regatta-Lepa-2015-08.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/4/4c/Semporna_Sabah_Regatta-Lepa-2015-08.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 3208, "original_height": 4151, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3208, 4151], "crop_box_px": [427, 0, 3194, 4151], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc35989646", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the centre man's white shirt, shorts and socks to red.", "item": "tops_dresses"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the centre man's yellow boots with black boots.", "item": "shoes_gloves"}, {"step": 3, "edit_type": "add", "instruction": "Add a black headband on the centre man's head.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "change", "instruction": "Give the centre man's red socks large white dots.", "item": "shoes_gloves"}, {"step": 5, "edit_type": "add", "instruction": "Add an orange cone on the grass beside the football.", "item": "objects"}], "people_visible": 10, "face_box": [0.47525, 0.05983, 0.59486, 0.23917], "tags": {"edit_target": ["hair_headwear_glasses", "objects", "shoes_gloves", "tops_dresses"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:20140808_-_Ligue_2_-_Cr%C3%A9teil-Ch%C3%A2teauroux_100.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Pierre-Yves Beaudouin", "attribution_required": "true"}, "source": {"title": "20140808 - Ligue 2 - Créteil-Châteauroux 100.jpg", "page": "https://commons.wikimedia.org/wiki/File:20140808_-_Ligue_2_-_Cr%C3%A9teil-Ch%C3%A2teauroux_100.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/f/f2/20140808_-_Ligue_2_-_Cr%C3%A9teil-Ch%C3%A2teauroux_100.jpg", "creator": "Pierre-Yves Beaudouin", "creator_url": null, "original_width": 3794, "original_height": 2530, "found_via": "Openverse search: backpack"}, "reference_made_by": {"original_size": [3794, 2530], "crop_box_px": [0, 0, 3794, 2530], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc36757782", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the pink striped top to yellow.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Lengthen the yellow top's sleeves to her wrists.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the green plastic bag with a brown woven bag.", "item": "bags"}, {"step": 4, "edit_type": "add", "instruction": "Add a wide straw hat on her head.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "change", "instruction": "Change the patterned wrap to plain dark green.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.40788, 0.10936, 0.68021, 0.29101], "tags": {"edit_target": ["bags", "hair_headwear_glasses", "tops_dresses"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Batangon-Darat_Sabah_Rungus-Woman-01.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Batangon-Darat Sabah Rungus-Woman-01.jpg", "page": "https://commons.wikimedia.org/wiki/File:Batangon-Darat_Sabah_Rungus-Woman-01.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/f/fa/Batangon-Darat_Sabah_Rungus-Woman-01.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 2597, "original_height": 3895, "found_via": "Openverse search: woman street"}, "reference_made_by": {"original_size": [2597, 3895], "crop_box_px": [0, 0, 2597, 3895], "size": [832, 1248], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 29.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc110020707", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the right man's white T-shirt to red.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the red T-shirt large white stars.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the right man's black bracelet with a red bead bracelet.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the right man's whole badge and its neck strap.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "add", "instruction": "Add a black cap on the right man's head.", "item": "hair_headwear_glasses"}], "people_visible": 6, "face_box": [0.7135, 0.0, 0.87356, 0.23996], "tags": {"edit_target": ["hair_headwear_glasses", "jewellery_watches", "scarves_ties_collars_badges", "tops_dresses"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Michelin_at_IAA_2021_1X7A0159.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Alexander Migl", "attribution_required": "true"}, "source": {"title": "Michelin at IAA 2021 1X7A0159.jpg", "page": "https://commons.wikimedia.org/wiki/File:Michelin_at_IAA_2021_1X7A0159.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e2/Michelin_at_IAA_2021_1X7A0159.jpg", "creator": "Alexander Migl", "creator_url": null, "original_width": 5827, "original_height": 3888, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [5827, 3888], "crop_box_px": [0, 2, 5827, 3886], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 39.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc51316724", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the shirt's stripes to large orange dots.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a large blue bead necklace over the scarf below her chin.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the jeans with brown cotton trousers on the woman's legs.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Change the blue bead necklace to orange.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "add", "instruction": "Add a large blue flower picture to the brown trousers.", "item": "trousers_skirts_belts"}], "people_visible": 2, "face_box": [0.49618, 0.10001, 0.65624, 0.33999], "tags": {"edit_target": ["jewellery_watches", "tops_dresses", "trousers_skirts_belts"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Costurera,_Mahdia,_T%C3%BAnez,_2016-09-03,_DD_04.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Diego Delso", "attribution_required": "true"}, "source": {"title": "Costurera, Mahdia, Túnez, 2016-09-03, DD 04.jpg", "page": "https://commons.wikimedia.org/wiki/File:Costurera,_Mahdia,_T%C3%BAnez,_2016-09-03,_DD_04.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/1/13/Costurera%2C_Mahdia%2C_T%C3%BAnez%2C_2016-09-03%2C_DD_04.jpg", "creator": "Diego Delso", "creator_url": null, "original_width": 4522, "original_height": 3324, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [4522, 3324], "crop_box_px": [1, 0, 4521, 3013], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc7231228", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the red shirt to purple.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Make the purple shirt sleeveless.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a large orange glass bead necklace around the woman's neck.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "change", "instruction": "Change the orange bead necklace to green.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "change", "instruction": "Make the green bead necklace from wood.", "item": "jewellery_watches"}], "people_visible": 1, "face_box": [0.4871, 0.1429, 0.66037, 0.40268], "tags": {"edit_target": ["jewellery_watches", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Woman_doing_laundry.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Bernard Gagnon", "attribution_required": "true"}, "source": {"title": "Woman doing laundry.jpg", "page": "https://commons.wikimedia.org/wiki/File:Woman_doing_laundry.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/2a/Woman_doing_laundry.jpg", "creator": "Bernard Gagnon", "creator_url": null, "original_width": 2485, "original_height": 1783, "found_via": "Openverse search: woman street"}, "reference_made_by": {"original_size": [2485, 1783], "crop_box_px": [0, 0, 2484, 1656], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc163677793", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the middle woman's pink socks to white.", "item": "shoes_gloves"}, {"step": 2, "edit_type": "change", "instruction": "Change the number 6 on the middle woman's shirt to 9.", "item": "text_signs"}, {"step": 3, "edit_type": "add", "instruction": "Add a black sports bag across the middle woman's lap.", "item": "bags"}, {"step": 4, "edit_type": "change", "instruction": "Give the black sports bag large white zigzags.", "item": "bags"}, {"step": 5, "edit_type": "add", "instruction": "Add a black headband to the middle woman's hair.", "item": "hair_headwear_glasses"}], "people_visible": 3, "face_box": [0.12251, 0.01469, 0.33245, 0.32945], "tags": {"edit_target": ["bags", "hair_headwear_glasses", "shoes_gloves", "text_signs"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2025-04-08_Fussball,_UEFA_Women%27s_Nations_League,_Deutschland_-_Schottland_STP_2074.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Steffen Prößdorf", "attribution_required": "true"}, "source": {"title": "2025-04-08 Fussball, UEFA Women's Nations League, Deutschland - Schottland STP 2074.jpg", "page": "https://commons.wikimedia.org/wiki/File:2025-04-08_Fussball,_UEFA_Women%27s_Nations_League,_Deutschland_-_Schottland_STP_2074.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/3/30/2025-04-08_Fussball%2C_UEFA_Women%27s_Nations_League%2C_Deutschland_-_Schottland_STP_2074.jpg", "creator": "Steffen Prößdorf", "creator_url": null, "original_width": 3240, "original_height": 2160, "found_via": "Openverse search: scooter"}, "reference_made_by": {"original_size": [3240, 2160], "crop_box_px": [0, 0, 3240, 2160], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 45.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc22907497", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the grey shirt to purple.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Extend the purple shirt's sleeves to the man's wrists.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the jeans with brown cloth trousers on the man's legs.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Give the purple shirt a pattern of large green squares.", "item": "tops_dresses"}, {"step": 5, "edit_type": "add", "instruction": "Add large yellow \"COCONUTS\" text across the shirt's chest.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.51182, 0.02815, 0.63668, 0.21535], "tags": {"edit_target": ["text_signs", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Vendedor_de_agua_de_coco_II.JPG", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Rjcastillo", "attribution_required": "true"}, "source": {"title": "Vendedor de agua de coco II.JPG", "page": "https://commons.wikimedia.org/wiki/File:Vendedor_de_agua_de_coco_II.JPG", "image_url": "https://upload.wikimedia.org/wikipedia/commons/3/38/Vendedor_de_agua_de_coco_II.JPG", "creator": "Rjcastillo", "creator_url": null, "original_width": 4451, "original_height": 2958, "found_via": "Openverse search: seller"}, "reference_made_by": {"original_size": [4451, 2958], "crop_box_px": [7, 0, 4444, 2958], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc12185576", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the grey trousers to blue.", "item": "trousers_skirts_belts"}, {"step": 2, "edit_type": "change", "instruction": "Give the red stool large white spots.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the black suitcase with a brown wooden crate.", "item": "bags"}, {"step": 4, "edit_type": "change", "instruction": "Change the blue trousers to velvet.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the black shoe with a white boot.", "item": "shoes_gloves"}], "people_visible": 1, "face_box": [0.20749, 0.05121, 0.4777, 0.23144], "tags": {"edit_target": ["bags", "objects", "shoes_gloves", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Quito_Accordion_player.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Cayambe", "attribution_required": "true"}, "source": {"title": "Quito Accordion player.jpg", "page": "https://commons.wikimedia.org/wiki/File:Quito_Accordion_player.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/0/0a/Quito_Accordion_player.jpg", "creator": "Cayambe", "creator_url": null, "original_width": 2581, "original_height": 3231, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [2581, 3231], "crop_box_px": [3, 0, 2157, 3231], "size": [832, 1248], "icc_profile": "Nikon sRGB 4.0.0.3001", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc132567368", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the blue shirt's material to velvet.", "item": "tops_dresses"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the shorts with blue trousers on the man's legs.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "add", "instruction": "Add a large brown cloth shoulder bag against the man's chest.", "item": "bags"}, {"step": 4, "edit_type": "change", "instruction": "Change the bag's material to brown straw.", "item": "bags"}, {"step": 5, "edit_type": "change", "instruction": "Give the blue trousers large white squares.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.28149, 0.19572, 0.6085, 0.41384], "tags": {"edit_target": ["bags", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Vendor_at_Mahankaal_Temple,_Kathmandu-6316.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Bijay Chaurasia", "attribution_required": "true"}, "source": {"title": "Vendor at Mahankaal Temple, Kathmandu-6316.jpg", "page": "https://commons.wikimedia.org/wiki/File:Vendor_at_Mahankaal_Temple,_Kathmandu-6316.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/8d/Vendor_at_Mahankaal_Temple%2C_Kathmandu-6316.jpg", "creator": "Bijay Chaurasia", "creator_url": null, "original_width": 3837, "original_height": 5756, "found_via": "Openverse search: vendor"}, "reference_made_by": {"original_size": [3837, 5756], "crop_box_px": [0, 0, 3837, 5756], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc46729005", "steps": [{"step": 1, "edit_type": "change", "instruction": "Shorten the black shirt's sleeves to the elbows.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the left woman's red apron to green.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a large yellow dumpling picture on the green apron's chest.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Give the left woman's red headscarf large yellow stars.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "change", "instruction": "Make the green apron shiny plastic.", "item": "tops_dresses"}], "people_visible": 2, "face_box": [0.29328, 0.05421, 0.44763, 0.28563], "tags": {"edit_target": ["hair_headwear_glasses", "tops_dresses"], "people": ["two"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-01.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Taipei Taiwan Jiaozi-Restaurant-14th-avenue-01.jpg", "page": "https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-01.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/eb/Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-01.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 5268, "original_height": 3514, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [5268, 3514], "crop_box_px": [0, 0, 5268, 3512], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc36823435", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large yellow leaf picture on the pipe-smoking man's shirt.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Shorten the pipe-smoking man's shirt sleeves to above the elbows.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the pipe-smoking man's shirt colour to green.", "item": "tops_dresses"}, {"step": 4, "edit_type": "add", "instruction": "Add a wide brown bracelet around the man's raised wrist.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the pipe-smoking man's leg cloth with loose brown trousers.", "item": "trousers_skirts_belts"}], "people_visible": 3, "face_box": [0.369, 0.06875, 0.7431, 0.31827], "tags": {"edit_target": ["jewellery_watches", "tops_dresses", "trousers_skirts_belts"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Old_man_smoking_hookah,_near_Jaipur,_Rajasthan,_India.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Yann Forget", "attribution_required": "true"}, "source": {"title": "Old man smoking hookah, near Jaipur, Rajasthan, India.jpg", "page": "https://commons.wikimedia.org/wiki/File:Old_man_smoking_hookah,_near_Jaipur,_Rajasthan,_India.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/2d/Old_man_smoking_hookah%2C_near_Jaipur%2C_Rajasthan%2C_India.jpg", "creator": "Yann Forget", "creator_url": null, "original_width": 2152, "original_height": 3156, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2152, 3156], "crop_box_px": [24, 0, 2128, 3156], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc39796818", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the tiger-pattern shirt to plain green.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the green shirt large white flowers.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the bearded man's beige trousers to black.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "add", "instruction": "Add a black cap on the bearded man's head.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the green flowered shirt with a plain white shirt.", "item": "tops_dresses"}], "people_visible": 14, "face_box": [0.52599, 0.14724, 0.66192, 0.35103], "tags": {"edit_target": ["hair_headwear_glasses", "tops_dresses", "trousers_skirts_belts"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Official-Opening-of-Tun-Sakaran-Museum-10.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Semporna Sabah Official-Opening-of-Tun-Sakaran-Museum-10.jpg", "page": "https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Official-Opening-of-Tun-Sakaran-Museum-10.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/4/4a/Semporna_Sabah_Official-Opening-of-Tun-Sakaran-Museum-10.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 4030, "original_height": 2879, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4030, 2879], "crop_box_px": [1, 193, 4029, 2879], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 40.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc48134404", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the shirt's stripes to large blue and white squares.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the trousers to red.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the shirt with a plain yellow long-sleeved shirt.", "item": "tops_dresses"}, {"step": 4, "edit_type": "add", "instruction": "Add a blue scarf around the man's neck, hanging down his chest.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "change", "instruction": "Give the yellow shirt a pattern of large black dots.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.40492, 0.14453, 0.55015, 0.36227], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Cobbler_in_Udaipur.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Clément Bardot", "attribution_required": "true"}, "source": {"title": "Cobbler in Udaipur.jpg", "page": "https://commons.wikimedia.org/wiki/File:Cobbler_in_Udaipur.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/8b/Cobbler_in_Udaipur.jpg", "creator": "Clément Bardot", "creator_url": null, "original_width": 4016, "original_height": 2627, "found_via": "Openverse search: shoemaker"}, "reference_made_by": {"original_size": [4016, 2627], "crop_box_px": [38, 0, 3978, 2627], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc25393535", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the shirt's stripes to large white spots on a blue background.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the blue jeans to black.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the spotted shirt with a plain red T-shirt.", "item": "tops_dresses"}, {"step": 4, "edit_type": "add", "instruction": "Add \"FRESH FRUIT\" in large white letters across the red T-shirt's chest.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Change \"FRESH FRUIT\" on the red T-shirt to \"GOOD DAY\".", "item": "text_signs"}], "people_visible": 1, "face_box": [0.3009, 0.08174, 0.64337, 0.31017], "tags": {"edit_target": ["text_signs", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Coconut_water_vendor.jpg", "licence": "CC0", "licence_url": "http://creativecommons.org/publicdomain/zero/1.0/deed.en", "author": "Wilfredor", "attribution_required": "false"}, "source": {"title": "Coconut water vendor.jpg", "page": "https://commons.wikimedia.org/wiki/File:Coconut_water_vendor.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/4/4b/Coconut_water_vendor.jpg", "creator": "Wilfredor", "creator_url": null, "original_width": 2511, "original_height": 3549, "found_via": "Openverse search: vendor"}, "reference_made_by": {"original_size": [2511, 3549], "crop_box_px": [8, 0, 2374, 3549], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc187580499", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the man's grey work coat to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue coat large white stars.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the fez on the man's head to black.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "change", "instruction": "Change the blue coat's material to corduroy.", "item": "tops_dresses"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the three red fezzes from the front table.", "item": "objects"}], "people_visible": 1, "face_box": [0.39087, 0.17823, 0.56752, 0.44308], "tags": {"edit_target": ["hair_headwear_glasses", "objects", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Chechia_Maker_in_his_shop.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "IssamBarhoumi", "attribution_required": "true"}, "source": {"title": "Chechia Maker in his shop.jpg", "page": "https://commons.wikimedia.org/wiki/File:Chechia_Maker_in_his_shop.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/70/Chechia_Maker_in_his_shop.jpg", "creator": "IssamBarhoumi", "creator_url": null, "original_width": 8021, "original_height": 5236, "found_via": "Openverse search: souk"}, "reference_made_by": {"original_size": [8021, 5236], "crop_box_px": [84, 0, 7938, 5236], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc16841673", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the dress's flower pattern to large white dots.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the dress's dark background to blue, keeping the white dots.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a large yellow bag hanging from her shoulder.", "item": "bags"}, {"step": 4, "edit_type": "add", "instruction": "Add \"HELLO\" in large black letters across the yellow bag.", "item": "text_signs"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the yellow bag and its strap.", "item": "bags"}], "people_visible": 1, "face_box": [0.46234, 0.07295, 0.66861, 0.3822], "tags": {"edit_target": ["bags", "text_signs", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:11-10-02-barnim-by-RalfR-02.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Ralf Roletschek (talk) - Fahrradtechnik auf fahrradmonteur.de", "attribution_required": "true"}, "source": {"title": "11-10-02-barnim-by-RalfR-02.jpg", "page": "https://commons.wikimedia.org/wiki/File:11-10-02-barnim-by-RalfR-02.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/4/4d/11-10-02-barnim-by-RalfR-02.jpg", "creator": "Ralf Roletschek (talk) - Fahrradtechnik auf fahrradmonteur.de", "creator_url": null, "original_width": 4288, "original_height": 2848, "found_via": "Openverse search: fashion model"}, "reference_made_by": {"original_size": [4288, 2848], "crop_box_px": [8, 0, 4280, 2848], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 33.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc9590173", "steps": [{"step": 1, "edit_type": "change", "instruction": "Make the man's shirt sleeveless.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a large yellow bead necklace around the man's neck.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "change", "instruction": "Change the man's sleeveless shirt to purple.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Add large yellow dots to the purple shirt.", "item": "tops_dresses"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the clay bowl of water with a metal bucket.", "item": "objects"}], "people_visible": 4, "face_box": [0.54825, 0.23575, 0.79182, 0.39821], "tags": {"edit_target": ["jewellery_watches", "objects", "tops_dresses"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Potter_and_his_wife.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Yann (talk)", "attribution_required": "true"}, "source": {"title": "Potter and his wife.jpg", "page": "https://commons.wikimedia.org/wiki/File:Potter_and_his_wife.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/1/11/Potter_and_his_wife.jpg", "creator": "Yann (talk)", "creator_url": null, "original_width": 2465, "original_height": 3575, "found_via": "Openverse search: potter"}, "reference_made_by": {"original_size": [2465, 3575], "crop_box_px": [78, 0, 2461, 3575], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc68508073", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large silver pendant necklace around the woman's neck.", "item": "jewellery_watches"}, {"step": 2, "edit_type": "replace", "instruction": "Replace her necklace with a large black bead necklace around her neck.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "replace", "instruction": "Replace her shirt with a brown buttoned shirt on her torso.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Cover the brown shirt with a pattern of large black squares.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the black bead necklace to orange.", "item": "jewellery_watches"}], "people_visible": 1, "face_box": [0.32481, 0.04073, 0.6762, 0.2751], "tags": {"edit_target": ["jewellery_watches", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Woman_with_hand-rolled_cigarette_cutting_rice.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Basile Morin", "attribution_required": "true"}, "source": {"title": "Woman with hand-rolled cigarette cutting rice.jpg", "page": "https://commons.wikimedia.org/wiki/File:Woman_with_hand-rolled_cigarette_cutting_rice.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/3/31/Woman_with_hand-rolled_cigarette_cutting_rice.jpg", "creator": "Basile Morin", "creator_url": null, "original_width": 3068, "original_height": 4091, "found_via": "Openverse search: farmer"}, "reference_made_by": {"original_size": [3068, 4091], "crop_box_px": [1, 0, 2728, 4091], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc30113648", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the crouching man's shirt colour to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the blue shirt's pattern to large white triangles.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the brown shorts with plain yellow shorts of the same fit.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Change the yellow shorts' pattern to large black spots.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "add", "instruction": "Add a wide red scarf around the man's neck.", "item": "scarves_ties_collars_badges"}], "people_visible": 3, "face_box": [0.31961, 0.06035, 0.4964, 0.32541], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Vendedor_callejero_de_gallinas,_Ciudad_Ho_Chi_Minh,_Vietnam,_2013-08-14,_DD_01.JPG", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Diego Delso", "attribution_required": "true"}, "source": {"title": "Vendedor callejero de gallinas, Ciudad Ho Chi Minh, Vietnam, 2013-08-14, DD 01.JPG", "page": "https://commons.wikimedia.org/wiki/File:Vendedor_callejero_de_gallinas,_Ciudad_Ho_Chi_Minh,_Vietnam,_2013-08-14,_DD_01.JPG", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/cb/Vendedor_callejero_de_gallinas%2C_Ciudad_Ho_Chi_Minh%2C_Vietnam%2C_2013-08-14%2C_DD_01.JPG", "creator": "Diego Delso", "creator_url": null, "original_width": 4337, "original_height": 3142, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4337, 3142], "crop_box_px": [0, 1, 4337, 2892], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 44.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc64396409", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the grey shirt to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue shirt large blue and white hearts.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the heart-print shirt with a plain red jacket.", "item": "tops_dresses"}, {"step": 4, "edit_type": "add", "instruction": "Add a white apron over the red jacket.", "item": "tops_dresses"}, {"step": 5, "edit_type": "add", "instruction": "Add large black \"FRESH BREAD\" text on the apron.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.41032, 0.14397, 0.53561, 0.33182], "tags": {"edit_target": ["text_signs", "tops_dresses"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Beignet_maker.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "IssamBarhoumi", "attribution_required": "true"}, "source": {"title": "Beignet maker.jpg", "page": "https://commons.wikimedia.org/wiki/File:Beignet_maker.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a5/Beignet_maker.jpg", "creator": "IssamBarhoumi", "creator_url": null, "original_width": 3821, "original_height": 2616, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3821, 2616], "crop_box_px": [0, 0, 3821, 2548], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc181130944", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a wide orange cloth belt around the woman's waist.", "item": "trousers_skirts_belts"}, {"step": 2, "edit_type": "change", "instruction": "Change the orange cloth belt to glossy plastic.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "change", "instruction": "Change the blue dress to yellow.", "item": "tops_dresses"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the brown boots with blue rain boots on her feet.", "item": "shoes_gloves"}, {"step": 5, "edit_type": "change", "instruction": "Give the yellow dress a large blue leaf pattern.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.34587, 0.08189, 0.66617, 0.29553], "tags": {"edit_target": ["shoes_gloves", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Knitted_Dress_as_additional_warm_layer_over_street_clothing_-_ginger_woman_sitting_on_a_park_bench_outside_of_Praha_hlavn%C3%AD_n%C3%A1dra%C5%BE%C3%AD.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Tobias ToMar Maier", "attribution_required": "true"}, "source": {"title": "Knitted Dress as additional warm layer over street clothing - ginger woman sitting on a park bench outside of Praha hlavní nádraží.jpg", "page": "https://commons.wikimedia.org/wiki/File:Knitted_Dress_as_additional_warm_layer_over_street_clothing_-_ginger_woman_sitting_on_a_park_bench_outside_of_Praha_hlavn%C3%AD_n%C3%A1dra%C5%BE%C3%AD.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e6/Knitted_Dress_as_additional_warm_layer_over_street_clothing_-_ginger_woman_sitting_on_a_park_bench_outside_of_Praha_hlavn%C3%AD_n%C3%A1dra%C5%BE%C3%AD.jpg", "creator": "Tobias ToMar Maier", "creator_url": null, "original_width": 4543, "original_height": 6814, "found_via": "Openverse search: woman street"}, "reference_made_by": {"original_size": [4543, 6814], "crop_box_px": [0, 0, 4543, 6814], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc74708391", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the fabric belt with a wide black belt around her waist.", "item": "trousers_skirts_belts"}, {"step": 2, "edit_type": "change", "instruction": "Change the black belt to white.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the flowered dress with a plain pink dress of the same cut.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the pink dress to brown.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Give the brown dress a pattern of large black dots.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.34533, 0.13296, 0.64944, 0.3358], "tags": {"edit_target": ["tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Copihue_de_Oro_2018_-_Fernanda_Figueroa_-_02.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Carlos Figueroa Rojas", "attribution_required": "true"}, "source": {"title": "Copihue de Oro 2018 - Fernanda Figueroa - 02.jpg", "page": "https://commons.wikimedia.org/wiki/File:Copihue_de_Oro_2018_-_Fernanda_Figueroa_-_02.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/5/5b/Copihue_de_Oro_2018_-_Fernanda_Figueroa_-_02.jpg", "creator": "Carlos Figueroa Rojas", "creator_url": null, "original_width": 3945, "original_height": 5917, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [3945, 5917], "crop_box_px": [0, 0, 3945, 5917], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc164348921", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a necklace with large yellow beads around the woman's neck.", "item": "jewellery_watches"}, {"step": 2, "edit_type": "change", "instruction": "Give the shirt a pattern of large pink flowers.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the yellow necklace to purple.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "change", "instruction": "Change the jacket's colour to grey.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the grey jacket's material to knitted.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.26117, 0.10478, 0.79084, 0.45806], "tags": {"edit_target": ["jewellery_watches", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:%D0%A2%D0%B0%D1%88%D0%BA%D0%B5%D0%BD%D1%82,_%D0%B2%D0%B8%D0%BA%D0%B8-%D0%BA%D1%80%D0%B0%D0%B5%D0%B2%D0%B5%D0%B4_%D0%BD%D0%B0_%D1%81%D0%BA%D0%B0%D0%BC%D0%B5%D0%B9%D0%BA%D0%B5_%D1%83_%D0%A8%D0%B5%D0%B2%D1%87%D0%B5%D0%BD%D0%BA%D0%BE_1_(2).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Nikolai Bulykin", "attribution_required": "true"}, "source": {"title": "Ташкент, вики-краевед на скамейке у Шевченко 1 (2).jpg", "page": "https://commons.wikimedia.org/wiki/File:%D0%A2%D0%B0%D1%88%D0%BA%D0%B5%D0%BD%D1%82,_%D0%B2%D0%B8%D0%BA%D0%B8-%D0%BA%D1%80%D0%B0%D0%B5%D0%B2%D0%B5%D0%B4_%D0%BD%D0%B0_%D1%81%D0%BA%D0%B0%D0%BC%D0%B5%D0%B9%D0%BA%D0%B5_%D1%83_%D0%A8%D0%B5%D0%B2%D1%87%D0%B5%D0%BD%D0%BA%D0%BE_1_(2).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/5/5d/%D0%A2%D0%B0%D1%88%D0%BA%D0%B5%D0%BD%D1%82%2C_%D0%B2%D0%B8%D0%BA%D0%B8-%D0%BA%D1%80%D0%B0%D0%B5%D0%B2%D0%B5%D0%B4_%D0%BD%D0%B0_%D1%81%D0%BA%D0%B0%D0%BC%D0%B5%D0%B9%D0%BA%D0%B5_%D1%83_%D0%A8%D0%B5%D0%B2%D1%87%D0%B5%D0%BD%D0%BA%D0%BE_1_%282%29.jpg", "creator": "Nikolai Bulykin", "creator_url": null, "original_width": 3448, "original_height": 5172, "found_via": "Openverse search: woman street"}, "reference_made_by": {"original_size": [3448, 5172], "crop_box_px": [0, 0, 3448, 5172], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 50.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc36722719", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the front soldier's white neck scarf to red.", "item": "scarves_ties_collars_badges"}, {"step": 2, "edit_type": "change", "instruction": "Change the front soldier's red beret to green.", "item": "hair_headwear_glasses"}, {"step": 3, "edit_type": "add", "instruction": "Add a large yellow star patch to the front soldier's right sleeve.", "item": "tops_dresses"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the front soldier's belt with a black leather belt.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "change", "instruction": "Change the red neck scarf to blue.", "item": "scarves_ties_collars_badges"}], "people_visible": 20, "face_box": [0.58777, 0.23157, 0.71624, 0.42418], "tags": {"edit_target": ["hair_headwear_glasses", "scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:November_11th_ceremony_in_Toulouse_in_2014_-_3826.jpg", "licence": "CC BY 4.0", "licence_url": "https://creativecommons.org/licenses/by/4.0", "author": "Pierre-Selim Huard", "attribution_required": "true"}, "source": {"title": "November 11th ceremony in Toulouse in 2014 - 3826.jpg", "page": "https://commons.wikimedia.org/wiki/File:November_11th_ceremony_in_Toulouse_in_2014_-_3826.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/5/58/November_11th_ceremony_in_Toulouse_in_2014_-_3826.jpg", "creator": "Pierre-Selim Huard", "creator_url": null, "original_width": 5184, "original_height": 3456, "found_via": "Openverse search: backpack"}, "reference_made_by": {"original_size": [5184, 3456], "crop_box_px": [0, 0, 5184, 3456], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 44.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc132970669", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace his black spike shoes with plain white running shoes.", "item": "shoes_gloves"}, {"step": 2, "edit_type": "change", "instruction": "Change the number on his hip label to 3.", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the white hip label to yellow.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "change", "instruction": "Give the white running shoes large red zigzags.", "item": "shoes_gloves"}, {"step": 5, "edit_type": "add", "instruction": "Add a white headband on his head.", "item": "hair_headwear_glasses"}], "people_visible": 1, "face_box": [0.28901, 0.0364, 0.65717, 0.28195], "tags": {"edit_target": ["hair_headwear_glasses", "scarves_ties_collars_badges", "shoes_gloves", "text_signs"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2022-08-18_European_Championships_2022_%E2%80%93_Men%27s_200_Metres_by_Sandro_Halank%E2%80%93060.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Sandro Halank, Wikimedia Commons", "attribution_required": "true"}, "source": {"title": "2022-08-18 European Championships 2022 – Men's 200 Metres by Sandro Halank–060.jpg", "page": "https://commons.wikimedia.org/wiki/File:2022-08-18_European_Championships_2022_%E2%80%93_Men%27s_200_Metres_by_Sandro_Halank%E2%80%93060.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/d/da/2022-08-18_European_Championships_2022_%E2%80%93_Men%27s_200_Metres_by_Sandro_Halank%E2%80%93060.jpg", "creator": "Sandro Halank, Wikimedia Commons", "creator_url": null, "original_width": 2469, "original_height": 3402, "found_via": "Openverse search: full length"}, "reference_made_by": {"original_size": [2469, 3402], "crop_box_px": [12, 0, 2280, 3402], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 53.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc87185001", "steps": [{"step": 1, "edit_type": "change", "instruction": "Cover the left woman's white shirt with large purple zigzags.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the zigzag shirt's background colour to black.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a wide brown leather belt around the left woman's waist.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Change the brown leather belt to gold metal.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "change", "instruction": "Change the left woman's skirt material to jeans cloth.", "item": "trousers_skirts_belts"}], "people_visible": 2, "face_box": [0.18669, 0.0, 0.43183, 0.36752], "tags": {"edit_target": ["tops_dresses", "trousers_skirts_belts"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Contouring_the_cheekbone_with_makeup_in_proper_and_wrong_pose.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Tobias ToMar Maier", "attribution_required": "true"}, "source": {"title": "Contouring the cheekbone with makeup in proper and wrong pose.jpg", "page": "https://commons.wikimedia.org/wiki/File:Contouring_the_cheekbone_with_makeup_in_proper_and_wrong_pose.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/4/4d/Contouring_the_cheekbone_with_makeup_in_proper_and_wrong_pose.jpg", "creator": "Tobias ToMar Maier", "creator_url": null, "original_width": 3996, "original_height": 3197, "found_via": "Openverse search: fashion model"}, "reference_made_by": {"original_size": [3996, 3197], "crop_box_px": [0, 0, 3996, 2664], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 49.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc74785277", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the red vest with a plain blue vest.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue vest large white dots.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the red helmet to green.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "add", "instruction": "Add \"GO FAST\" in large black letters across the dotted vest's chest.", "item": "text_signs"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole dotted vest.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.43127, 0.07752, 0.7283, 0.37455], "tags": {"edit_target": ["hair_headwear_glasses", "text_signs", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2018-11-24_Women%27s_World_Cup_at_2018-19_Luge_World_Cup_in_Igls_by_Sandro_Halank%E2%80%93372.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Sandro Halank, Wikimedia Commons", "attribution_required": "true"}, "source": {"title": "2018-11-24 Women's World Cup at 2018-19 Luge World Cup in Igls by Sandro Halank–372.jpg", "page": "https://commons.wikimedia.org/wiki/File:2018-11-24_Women%27s_World_Cup_at_2018-19_Luge_World_Cup_in_Igls_by_Sandro_Halank%E2%80%93372.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/2c/2018-11-24_Women%27s_World_Cup_at_2018-19_Luge_World_Cup_in_Igls_by_Sandro_Halank%E2%80%93372.jpg", "creator": "Sandro Halank, Wikimedia Commons", "creator_url": null, "original_width": 2280, "original_height": 2720, "found_via": "Openverse search: farmer"}, "reference_made_by": {"original_size": [2280, 2720], "crop_box_px": [14, 0, 2266, 2252], "size": [1024, 1024], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc37036117", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the man's black vest.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the man's black shirt to red.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Give the man's red shirt a large white checkerboard pattern.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the singing man's black trousers' material to wool.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the white shoes with red boots on the man's feet.", "item": "shoes_gloves"}], "people_visible": 6, "face_box": [0.37559, 0.08933, 0.6424, 0.26729], "tags": {"edit_target": ["shoes_gloves", "tops_dresses", "trousers_skirts_belts"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Cheek_-_Rakuuna_Rock_2014_1.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Tuomas Vitikainen", "attribution_required": "true"}, "source": {"title": "Cheek - Rakuuna Rock 2014 1.jpg", "page": "https://commons.wikimedia.org/wiki/File:Cheek_-_Rakuuna_Rock_2014_1.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/94/Cheek_-_Rakuuna_Rock_2014_1.jpg", "creator": "Tuomas Vitikainen", "creator_url": null, "original_width": 2848, "original_height": 4288, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [2848, 4288], "crop_box_px": [0, 8, 2848, 4280], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 49.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc6900196", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the long green cloth to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the blue cloth's pattern to large white dots.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace her black bead necklace with a gold chain necklace.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "add", "instruction": "Add a large red flower in her hair.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole red flower.", "item": "hair_headwear_glasses"}], "people_visible": 1, "face_box": [0.26938, 0.07558, 0.64396, 0.32543], "tags": {"edit_target": ["hair_headwear_glasses", "jewellery_watches", "tops_dresses"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Sari_2.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Yann (talk)", "attribution_required": "true"}, "source": {"title": "Sari 2.jpg", "page": "https://commons.wikimedia.org/wiki/File:Sari_2.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/72/Sari_2.jpg", "creator": "Yann (talk)", "creator_url": null, "original_width": 1733, "original_height": 3487, "found_via": "Openverse search: outfit"}, "reference_made_by": {"original_size": [1733, 3487], "crop_box_px": [22, 0, 1711, 2534], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 45.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc54338875", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the black sleeveless jacket to red.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the red sleeveless jacket large white stars.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the guitarist's white cowboy hat with a black top hat.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "add", "instruction": "Add \"ROCK\" in large yellow letters across the red jacket's chest.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Change the foreground man's black trousers to white.", "item": "trousers_skirts_belts"}], "people_visible": 3, "face_box": [0.33051, 0.16833, 0.53992, 0.48229], "tags": {"edit_target": ["hair_headwear_glasses", "text_signs", "tops_dresses", "trousers_skirts_belts"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:The_BossHoss_-_Oberhausen_-_Leonhard_Kreissig_-_06.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Leonhard Kreissig", "attribution_required": "true"}, "source": {"title": "The BossHoss - Oberhausen - Leonhard Kreissig - 06.jpg", "page": "https://commons.wikimedia.org/wiki/File:The_BossHoss_-_Oberhausen_-_Leonhard_Kreissig_-_06.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/3/3a/The_BossHoss_-_Oberhausen_-_Leonhard_Kreissig_-_06.jpg", "creator": "Leonhard Kreissig", "creator_url": null, "original_width": 3000, "original_height": 2000, "found_via": "Openverse search: office worker"}, "reference_made_by": {"original_size": [3000, 2000], "crop_box_px": [0, 0, 3000, 2000], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc81720138", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the wooden tambourine to red.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the green tinsel garland at the top to gold.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the white tent roof large blue stars.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a large yellow balloon above the tambourine woman's head.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole red tambourine.", "item": "objects"}], "people_visible": 10, "face_box": [0.27279, 0.31296, 0.56383, 0.50709], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Tambourin.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Bertrand Fanonnel | Eight Studio", "attribution_required": "true"}, "source": {"title": "Tambourin.jpg", "page": "https://commons.wikimedia.org/wiki/File:Tambourin.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/98/Tambourin.jpg", "creator": "Bertrand Fanonnel | Eight Studio", "creator_url": null, "original_width": 4912, "original_height": 7360, "found_via": "Openverse search: woman musician"}, "reference_made_by": {"original_size": [4912, 7360], "crop_box_px": [3, 0, 4909, 7360], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc1651809", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the dark shirt's colour to green.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the green shirt's pattern to large white zigzags.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the zigzag shirt with a plain red sweater.", "item": "tops_dresses"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the blue jeans with plain black trousers on the man's legs.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "change", "instruction": "Change the man's hair colour to pink.", "item": "hair_headwear_glasses"}], "people_visible": 1, "face_box": [0.40137, 0.30384, 0.72825, 0.52187], "tags": {"edit_target": ["hair_headwear_glasses", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:4.FMC_-_Dullahan_-_Marek_Przew%C5%82ocki_-_01a.jpg", "licence": "CC BY-SA 3.0", "licence_url": "http://creativecommons.org/licenses/by-sa/3.0/", "author": "Lestat (Jan Mehlich)", "attribution_required": "true"}, "source": {"title": "4.FMC - Dullahan - Marek Przewłocki - 01a.jpg", "page": "https://commons.wikimedia.org/wiki/File:4.FMC_-_Dullahan_-_Marek_Przew%C5%82ocki_-_01a.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/3/32/4.FMC_-_Dullahan_-_Marek_Przew%C5%82ocki_-_01a.jpg", "creator": "Lestat (Jan Mehlich)", "creator_url": null, "original_width": 1563, "original_height": 2084, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [1563, 2084], "crop_box_px": [173, 0, 1563, 2084], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 41.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc145843601", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the dress's flower pattern to a large blue and white leaf pattern.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the pink jacket to green.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a wide yellow scarf around the woman's neck.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "change", "instruction": "Give the yellow scarf large black spots.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the spotted yellow scarf.", "item": "scarves_ties_collars_badges"}], "people_visible": 1, "face_box": [0.55206, 0.06458, 0.74115, 0.34809], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Khasi_Lady_in_a_Kitchen.jpg", "licence": "CC0", "licence_url": "http://creativecommons.org/publicdomain/zero/1.0/deed.en", "author": "Wann Majaw", "attribution_required": "false"}, "source": {"title": "Khasi Lady in a Kitchen.jpg", "page": "https://commons.wikimedia.org/wiki/File:Khasi_Lady_in_a_Kitchen.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/96/Khasi_Lady_in_a_Kitchen.jpg", "creator": "Wann Majaw", "creator_url": null, "original_width": 2848, "original_height": 1800, "found_via": "Openverse search: cook kitchen"}, "reference_made_by": {"original_size": [2848, 1800], "crop_box_px": [148, 0, 2848, 1800], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 45.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc30778085", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the woman's black dress to red.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the woman's black guitar strap to white.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "add", "instruction": "Add a thick silver necklace around the woman's neck.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "change", "instruction": "Give the woman's red dress long sleeves.", "item": "tops_dresses"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the woman's silver necklace.", "item": "jewellery_watches"}], "people_visible": 4, "face_box": [0.2929, 0.1922, 0.42741, 0.39387], "tags": {"edit_target": ["jewellery_watches", "scarves_ties_collars_badges", "tops_dresses"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Dover_-_Dover_came_to_me_2014_-_01.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Carlos Delgado", "attribution_required": "true"}, "source": {"title": "Dover - Dover came to me 2014 - 01.jpg", "page": "https://commons.wikimedia.org/wiki/File:Dover_-_Dover_came_to_me_2014_-_01.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/c9/Dover_-_Dover_came_to_me_2014_-_01.jpg", "creator": "Carlos Delgado", "creator_url": null, "original_width": 2592, "original_height": 1728, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [2592, 1728], "crop_box_px": [0, 0, 2592, 1728], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc79628058", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the woman's black jacket to red.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the woman's red jacket large white triangles.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the triangle-print jacket with a plain blue jacket.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the woman's blue jacket to velvet.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the woman's black trousers to white.", "item": "trousers_skirts_belts"}], "people_visible": 2, "face_box": [0.58765, 0.06773, 0.70136, 0.23821], "tags": {"edit_target": ["tops_dresses", "trousers_skirts_belts"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:P2N2019ClaraLuciani_03.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Selbymay", "attribution_required": "true"}, "source": {"title": "P2N2019ClaraLuciani 03.jpg", "page": "https://commons.wikimedia.org/wiki/File:P2N2019ClaraLuciani_03.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/3/37/P2N2019ClaraLuciani_03.jpg", "creator": "Selbymay", "creator_url": null, "original_width": 4000, "original_height": 2670, "found_via": "Openverse search: guitarist"}, "reference_made_by": {"original_size": [4000, 2670], "crop_box_px": [0, 2, 4000, 2669], "size": [1248, 832], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 32.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc62403000", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the stage man's light blue shirt to pink.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a large red pocket square to the stage man's jacket.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the stage man's silver wristwatch with a gold wristwatch.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "change", "instruction": "Change the stage man's grey suit to dark green.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the gold wristwatch's strap to brown leather.", "item": "jewellery_watches"}], "people_visible": 2, "face_box": [0.44943, 0.34691, 0.5909, 0.55902], "tags": {"edit_target": ["jewellery_watches", "scarves_ties_collars_badges", "tops_dresses"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Kia,_IAA_2017_(1Y7A2595).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "MB-one", "attribution_required": "true"}, "source": {"title": "Kia, IAA 2017 (1Y7A2595).jpg", "page": "https://commons.wikimedia.org/wiki/File:Kia,_IAA_2017_(1Y7A2595).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a9/Kia%2C_IAA_2017_%281Y7A2595%29.jpg", "creator": "MB-one", "creator_url": null, "original_width": 5760, "original_height": 3840, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [5760, 3840], "crop_box_px": [0, 0, 5760, 3840], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc197388139", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the front piper's black hat to blue.", "item": "hair_headwear_glasses"}, {"step": 2, "edit_type": "change", "instruction": "Change the front piper's green vest and green sash to purple.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Give the purple vest and sash large white dots.", "item": "tops_dresses"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the red patterned waist scarf with a plain yellow scarf.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the front piper's white shirt with a pink shirt.", "item": "tops_dresses"}], "people_visible": 6, "face_box": [0.31812, 0.16093, 0.72937, 0.43524], "tags": {"edit_target": ["hair_headwear_glasses", "scarves_ties_collars_badges", "tops_dresses"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2026_Domingo_26_de_xullo._Desfile_de_traxes_tradicionais._Santiago_de_Compostela_05.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Luis Miguel Bugallo Sánchez", "attribution_required": "true"}, "source": {"title": "2026 Domingo 26 de xullo. Desfile de traxes tradicionais. Santiago de Compostela 05.jpg", "page": "https://commons.wikimedia.org/wiki/File:2026_Domingo_26_de_xullo._Desfile_de_traxes_tradicionais._Santiago_de_Compostela_05.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/c0/2026_Domingo_26_de_xullo._Desfile_de_traxes_tradicionais._Santiago_de_Compostela_05.jpg", "creator": "Luis Miguel Bugallo Sánchez", "creator_url": null, "original_width": 2727, "original_height": 4090, "found_via": "Openverse search: woman musician"}, "reference_made_by": {"original_size": [2727, 4090], "crop_box_px": [0, 0, 2727, 4090], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc71781613", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the red shirt to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the blue shirt's pattern to large white dots.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the grey trousers with brown trousers of the same fit.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Change the brown trousers' material to jeans cloth.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the dotted blue shirt with a plain green shirt.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.34274, 0.20384, 0.71451, 0.45181], "tags": {"edit_target": ["tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:David_Stellner_(Kunst_am_Kanal_-_12_Jahre_Werk_in_Wien)_11.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Manfred Werner (Tsui)", "attribution_required": "true"}, "source": {"title": "David Stellner (Kunst am Kanal - 12 Jahre Werk in Wien) 11.jpg", "page": "https://commons.wikimedia.org/wiki/File:David_Stellner_(Kunst_am_Kanal_-_12_Jahre_Werk_in_Wien)_11.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e8/David_Stellner_%28Kunst_am_Kanal_-_12_Jahre_Werk_in_Wien%29_11.jpg", "creator": "Manfred Werner (Tsui)", "creator_url": null, "original_width": 3200, "original_height": 4800, "found_via": "Openverse search: guitarist"}, "reference_made_by": {"original_size": [3200, 4800], "crop_box_px": [0, 0, 3200, 4800], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 50.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc130741178", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the dribbling woman's yellow shirt to red.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the red shirt large red and white leaves.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the dribbling woman's blue shorts with plain black shorts.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Change the dribbling woman's shirt number to the large black word \"PLAY\".", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Give the black shorts large white circles.", "item": "trousers_skirts_belts"}], "people_visible": 9, "face_box": [0.3833, 0.01177, 0.52401, 0.22273], "tags": {"edit_target": ["text_signs", "tops_dresses", "trousers_skirts_belts"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2023-04-11_Fussball,_Frauen,_L%C3%A4nderspiel,_Deutschland_-_Brasilien_1DX_0181_by_Stepro.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Steffen Prößdorf", "attribution_required": "true"}, "source": {"title": "2023-04-11 Fussball, Frauen, Länderspiel, Deutschland - Brasilien 1DX 0181 by Stepro.jpg", "page": "https://commons.wikimedia.org/wiki/File:2023-04-11_Fussball,_Frauen,_L%C3%A4nderspiel,_Deutschland_-_Brasilien_1DX_0181_by_Stepro.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/7a/2023-04-11_Fussball%2C_Frauen%2C_L%C3%A4nderspiel%2C_Deutschland_-_Brasilien_1DX_0181_by_Stepro.jpg", "creator": "Steffen Prößdorf", "creator_url": null, "original_width": 3240, "original_height": 2160, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [3240, 2160], "crop_box_px": [0, 0, 3240, 2160], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc57090152", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the numbered vest with a plain green vest.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the green vest large white dots.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the black parts of the trousers to purple.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "add", "instruction": "Add \"GO FAST\" in large black letters on the dotted vest.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Change \"GO FAST\" on the dotted vest to \"TEAM ONE\".", "item": "text_signs"}], "people_visible": 1, "face_box": [0.34205, 0.09828, 0.66242, 0.31196], "tags": {"edit_target": ["text_signs", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2017-02-24_Emily_Sweeney_by_Sandro_Halank%E2%80%931.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Sandro Halank, Wikimedia Commons", "attribution_required": "true"}, "source": {"title": "2017-02-24 Emily Sweeney by Sandro Halank–1.jpg", "page": "https://commons.wikimedia.org/wiki/File:2017-02-24_Emily_Sweeney_by_Sandro_Halank%E2%80%931.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a1/2017-02-24_Emily_Sweeney_by_Sandro_Halank%E2%80%931.jpg", "creator": "Sandro Halank, Wikimedia Commons", "creator_url": null, "original_width": 2104, "original_height": 2577, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [2104, 2577], "crop_box_px": [361, 0, 2079, 2577], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc181185691", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the one-piece suit to pink.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a large grey bead necklace around her neck.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "change", "instruction": "Change the chain belt to white.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Shorten the pink suit's sleeves to above the elbows.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change her beige boots to black.", "item": "shoes_gloves"}], "people_visible": 1, "face_box": [0.29963, 0.03976, 0.61625, 0.25094], "tags": {"edit_target": ["jewellery_watches", "shoes_gloves", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Catsuit_made_of_velvet_in_cappuccino_color_-_German_Ervy_brand_number_12282_-_with_back_zipper_and_standing_collar_extended_to_6cm_-_Pose_2.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Tobias ToMar Maier", "attribution_required": "true"}, "source": {"title": "Catsuit made of velvet in cappuccino color - German Ervy brand number 12282 - with back zipper and standing collar extended to 6cm - Pose 2.jpg", "page": "https://commons.wikimedia.org/wiki/File:Catsuit_made_of_velvet_in_cappuccino_color_-_German_Ervy_brand_number_12282_-_with_back_zipper_and_standing_collar_extended_to_6cm_-_Pose_2.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/b/bb/Catsuit_made_of_velvet_in_cappuccino_color_-_German_Ervy_brand_number_12282_-_with_back_zipper_and_standing_collar_extended_to_6cm_-_Pose_2.jpg", "creator": "Tobias ToMar Maier", "creator_url": null, "original_width": 4776, "original_height": 8491, "found_via": "Openverse search: full-length"}, "reference_made_by": {"original_size": [4776, 8491], "crop_box_px": [0, 0, 4776, 7164], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc61382438", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the singing man's white jacket fabric to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue jacket a large blue and white checkerboard pattern.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the singing man's hair colour to orange.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the checkerboard jacket with a plain grey jacket.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the grey jacket's material to fur.", "item": "tops_dresses"}], "people_visible": 3, "face_box": [0.32292, 0.12546, 0.65561, 0.34736], "tags": {"edit_target": ["hair_headwear_glasses", "tops_dresses"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:DCVDNS_1_%E2%80%93_splash!_Festival_20_(2017).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Nicolas Völcker", "attribution_required": "true"}, "source": {"title": "DCVDNS 1 – splash! Festival 20 (2017).jpg", "page": "https://commons.wikimedia.org/wiki/File:DCVDNS_1_%E2%80%93_splash!_Festival_20_(2017).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/5/54/DCVDNS_1_%E2%80%93_splash%21_Festival_20_%282017%29.jpg", "creator": "Nicolas Völcker", "creator_url": null, "original_width": 2172, "original_height": 3144, "found_via": "Openverse search: jacket"}, "reference_made_by": {"original_size": [2172, 3144], "crop_box_px": [6, 0, 2102, 3144], "size": [832, 1248], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 36.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc77297064", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the red microphone with a silver microphone.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change her red hair to blue.", "item": "hair_headwear_glasses"}, {"step": 3, "edit_type": "add", "instruction": "Add a thick white necklace around her neck.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the whole white necklace.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "change", "instruction": "Change the silver microphone to gold.", "item": "objects"}], "people_visible": 2, "face_box": [0.4396, 0.07058, 0.55527, 0.24399], "tags": {"edit_target": ["hair_headwear_glasses", "jewellery_watches", "objects"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Sanni_-_Ilosaarirock_2018_-_02.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Tuomas Vitikainen", "attribution_required": "true"}, "source": {"title": "Sanni - Ilosaarirock 2018 - 02.jpg", "page": "https://commons.wikimedia.org/wiki/File:Sanni_-_Ilosaarirock_2018_-_02.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/ca/Sanni_-_Ilosaarirock_2018_-_02.jpg", "creator": "Tuomas Vitikainen", "creator_url": null, "original_width": 3795, "original_height": 2525, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [3795, 2525], "crop_box_px": [4, 0, 3791, 2525], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 49.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc44437091", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the whole brown shoulder bag.", "item": "bags"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the patterned scarf with a plain yellow scarf.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "remove", "instruction": "Remove the whole brown glove from her hand.", "item": "shoes_gloves"}, {"step": 4, "edit_type": "change", "instruction": "Change the whole brown jacket, fur collar included, to green.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Give the yellow scarf large black dots.", "item": "scarves_ties_collars_badges"}], "people_visible": 1, "face_box": [0.36121, 0.19972, 0.71988, 0.43894], "tags": {"edit_target": ["bags", "scarves_ties_collars_badges", "shoes_gloves", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Lady_on_Neva_river_Saint_Petersburg.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "This Photo was taken by Wolfgang Moroder. Feel free to use my photos, but please mention me as the author and send me a ", "attribution_required": "true"}, "source": {"title": "Lady on Neva river Saint Petersburg.jpg", "page": "https://commons.wikimedia.org/wiki/File:Lady_on_Neva_river_Saint_Petersburg.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/ee/Lady_on_Neva_river_Saint_Petersburg.jpg", "creator": "This Photo was taken by Wolfgang Moroder. \n\nFeel free to use my photos, but ple", "creator_url": null, "original_width": 4000, "original_height": 5993, "found_via": "Openverse search: street fashion"}, "reference_made_by": {"original_size": [4000, 5993], "crop_box_px": [2, 0, 3998, 5993], "size": [832, 1248], "icc_profile": "Nikon sRGB 4.0.0.3002", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc71365077", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the jacket with a green wool jacket over the shirt.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the green wool jacket to grey.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a wide green tie at the man's shirt collar.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the tie with a wide green bow tie at his collar.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the grey wool jacket.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.48713, 0.2854, 0.62164, 0.48706], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:IAA_2017,_Frankfurt_(1Y7A1813).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Matti Blume", "attribution_required": "true"}, "source": {"title": "IAA 2017, Frankfurt (1Y7A1813).jpg", "page": "https://commons.wikimedia.org/wiki/File:IAA_2017,_Frankfurt_(1Y7A1813).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e2/IAA_2017%2C_Frankfurt_%281Y7A1813%29.jpg", "creator": "Matti Blume", "creator_url": null, "original_width": 5760, "original_height": 3840, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [5760, 3840], "crop_box_px": [0, 0, 5760, 3840], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc144533378", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the black dress to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the furry bag with a large plain red bag.", "item": "bags"}, {"step": 3, "edit_type": "change", "instruction": "Give the blue dress large white stars.", "item": "tops_dresses"}, {"step": 4, "edit_type": "add", "instruction": "Add \"HELLO\" in large white letters across the red bag.", "item": "text_signs"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the red bag, including its chain.", "item": "bags"}], "people_visible": 1, "face_box": [0.24891, 0.05012, 0.7128, 0.35953], "tags": {"edit_target": ["bags", "text_signs", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Cynthia_Okorafor-104A3488.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Frank Schulenburg", "attribution_required": "true"}, "source": {"title": "Sundance Film Festival 2024 - Cynthia Okorafor-104A3488.jpg", "page": "https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Cynthia_Okorafor-104A3488.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/9b/Sundance_Film_Festival_2024_-_Cynthia_Okorafor-104A3488.jpg", "creator": "Frank Schulenburg", "creator_url": null, "original_width": 3917, "original_height": 5875, "found_via": "Openverse search: street fashion"}, "reference_made_by": {"original_size": [3917, 5875], "crop_box_px": [0, 0, 3917, 5875], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc198272116", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change both of his green shirts to yellow.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the yellow shirt large black zigzags.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the zigzag shirt with a plain blue jacket.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the blue jacket's material to corduroy.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Give the grey trousers large white zigzags.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.26638, 0.07742, 0.70479, 0.36984], "tags": {"edit_target": ["tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2026_M%C3%BAsico_do_grupo_de_Felisa_Segade_no_TradFest_2026._A_Quintana._Santiago_de_Compostela._Galiza.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Luis Miguel Bugallo Sánchez", "attribution_required": "true"}, "source": {"title": "2026 Músico do grupo de Felisa Segade no TradFest 2026. A Quintana. Santiago de Compostela. Galiza.jpg", "page": "https://commons.wikimedia.org/wiki/File:2026_M%C3%BAsico_do_grupo_de_Felisa_Segade_no_TradFest_2026._A_Quintana._Santiago_de_Compostela._Galiza.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/7b/2026_M%C3%BAsico_do_grupo_de_Felisa_Segade_no_TradFest_2026._A_Quintana._Santiago_de_Compostela._Galiza.jpg", "creator": "Luis Miguel Bugallo Sánchez", "creator_url": null, "original_width": 4759, "original_height": 7138, "found_via": "Openverse search: woman musician"}, "reference_made_by": {"original_size": [4759, 7138], "crop_box_px": [0, 0, 4759, 7138], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 49.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc165131491", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the blue neck strap and its hanging card.", "item": "scarves_ties_collars_badges"}, {"step": 2, "edit_type": "change", "instruction": "Change the shirt's orange colour to blue.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the shirt's pattern to large white dots on blue.", "item": "tops_dresses"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the dotted shirt with a plain red shirt.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the red shirt's pattern to large white leaves.", "item": "tops_dresses"}], "people_visible": 3, "face_box": [0.19626, 0.02006, 0.72771, 0.37453], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:%D0%A2%D0%B0%D1%88%D0%BA%D0%B5%D0%BD%D1%82,_%D0%BA%D1%8B%D1%80%D0%B3%D1%8B%D0%B7%D1%81%D0%BA%D0%B8%D0%B9_%D0%B2%D0%B8%D0%BA%D0%B8%D0%BC%D0%B5%D0%B4%D0%B8%D0%B5%D1%86_%D0%BD%D0%B0_%D0%91%D1%83%D1%8E%D0%BA_%D0%A2%D1%83%D1%80%D0%BE%D0%BD_(2).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Nikolai Bulykin", "attribution_required": "true"}, "source": {"title": "Ташкент, кыргызский викимедиец на Буюк Турон (2).jpg", "page": "https://commons.wikimedia.org/wiki/File:%D0%A2%D0%B0%D1%88%D0%BA%D0%B5%D0%BD%D1%82,_%D0%BA%D1%8B%D1%80%D0%B3%D1%8B%D0%B7%D1%81%D0%BA%D0%B8%D0%B9_%D0%B2%D0%B8%D0%BA%D0%B8%D0%BC%D0%B5%D0%B4%D0%B8%D0%B5%D1%86_%D0%BD%D0%B0_%D0%91%D1%83%D1%8E%D0%BA_%D0%A2%D1%83%D1%80%D0%BE%D0%BD_(2).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/1/1b/%D0%A2%D0%B0%D1%88%D0%BA%D0%B5%D0%BD%D1%82%2C_%D0%BA%D1%8B%D1%80%D0%B3%D1%8B%D0%B7%D1%81%D0%BA%D0%B8%D0%B9_%D0%B2%D0%B8%D0%BA%D0%B8%D0%BC%D0%B5%D0%B4%D0%B8%D0%B5%D1%86_%D0%BD%D0%B0_%D0%91%D1%83%D1%8E%D0%BA_%D0%A2%D1%83%D1%80%D0%BE%D0%BD_%282%29.jpg", "creator": "Nikolai Bulykin", "creator_url": null, "original_width": 2811, "original_height": 4217, "found_via": "Openverse search: woman street"}, "reference_made_by": {"original_size": [2811, 4217], "crop_box_px": [0, 0, 2811, 4217], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc70180444", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the blue wristband to yellow.", "item": "jewellery_watches"}, {"step": 2, "edit_type": "change", "instruction": "Change her green hair to purple.", "item": "hair_headwear_glasses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the bone crown with a gold crown.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "change", "instruction": "Give both black gloves large white stars.", "item": "shoes_gloves"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole gold crown.", "item": "hair_headwear_glasses"}], "people_visible": 1, "face_box": [0.28746, 0.20146, 0.79501, 0.53999], "tags": {"edit_target": ["hair_headwear_glasses", "jewellery_watches", "shoes_gloves"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Mermaid_Parade_(60015).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Rhododendrites", "attribution_required": "true"}, "source": {"title": "Mermaid Parade (60015).jpg", "page": "https://commons.wikimedia.org/wiki/File:Mermaid_Parade_(60015).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/ed/Mermaid_Parade_%2860015%29.jpg", "creator": "Rhododendrites", "creator_url": null, "original_width": 2469, "original_height": 4195, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2469, 4195], "crop_box_px": [22, 0, 2447, 3638], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc75115465", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the jacket.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the tie's colour to brown.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "change", "instruction": "Change the brown tie's material to velvet.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "add", "instruction": "Add a gold tie clip to the brown velvet tie.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "change", "instruction": "Change the trousers' colour to green.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.32041, 0.0, 0.7756, 0.30361], "tags": {"edit_target": ["jewellery_watches", "scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Geneva_International_Motor_Show_2018,_Le_Grand-Saconnex_(1X7A0394).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Matti Blume", "attribution_required": "true"}, "source": {"title": "Geneva International Motor Show 2018, Le Grand-Saconnex (1X7A0394).jpg", "page": "https://commons.wikimedia.org/wiki/File:Geneva_International_Motor_Show_2018,_Le_Grand-Saconnex_(1X7A0394).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/d/dd/Geneva_International_Motor_Show_2018%2C_Le_Grand-Saconnex_%281X7A0394%29.jpg", "creator": "Matti Blume", "creator_url": null, "original_width": 2575, "original_height": 3862, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2575, 3862], "crop_box_px": [0, 0, 2575, 3862], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 51.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc144784911", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the black jacket to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue jacket large blue and white triangles.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the triangle-print jacket with an open brown leather jacket.", "item": "tops_dresses"}, {"step": 4, "edit_type": "add", "instruction": "Add large white \"GOOD DAY\" text to the black shirt.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Change \"GOOD DAY\" on the black shirt to \"STAY KIND\".", "item": "text_signs"}], "people_visible": 1, "face_box": [0.23465, 0.0, 0.73226, 0.3319], "tags": {"edit_target": ["text_signs", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Jamal_Trulove-104A3197.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Frank Schulenburg", "attribution_required": "true"}, "source": {"title": "Sundance Film Festival 2024 - Jamal Trulove-104A3197.jpg", "page": "https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Jamal_Trulove-104A3197.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/90/Sundance_Film_Festival_2024_-_Jamal_Trulove-104A3197.jpg", "creator": "Frank Schulenburg", "creator_url": null, "original_width": 3770, "original_height": 5278, "found_via": "Openverse search: street fashion"}, "reference_made_by": {"original_size": [3770, 5278], "crop_box_px": [29, 0, 3547, 5278], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 51.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc87185004", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the white shirt to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Make the black skirt knitted.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "change", "instruction": "Change the woman's hair colour to red.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "add", "instruction": "Add a wide white belt around the woman's waist over the skirt.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "change", "instruction": "Give the blue shirt large white hearts.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.41481, 0.0, 0.74588, 0.22082], "tags": {"edit_target": ["hair_headwear_glasses", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Slightly_business_casual_Informal_wear_-_pose_1.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Tobias ToMar Maier", "attribution_required": "true"}, "source": {"title": "Slightly business casual Informal wear - pose 1.jpg", "page": "https://commons.wikimedia.org/wiki/File:Slightly_business_casual_Informal_wear_-_pose_1.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/c3/Slightly_business_casual_Informal_wear_-_pose_1.jpg", "creator": "Tobias ToMar Maier", "creator_url": null, "original_width": 2991, "original_height": 5317, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [2991, 5317], "crop_box_px": [0, 0, 2991, 4486], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 53.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc145940545", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the blue jacket to green.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the speaking man's white shirt a large purple leaf pattern.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a long red tie under the speaking man's shirt collar.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "change", "instruction": "Make the green jacket wool, with the same green colour.", "item": "tops_dresses"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole tie.", "item": "scarves_ties_collars_badges"}], "people_visible": 3, "face_box": [0.23401, 0.01869, 0.70409, 0.33223], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:S%C3%B8ren_W._Rasmussen,_COTY,_GIMS_2024,_Le_Grand-Saconnex_(GIMS0032).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0/deed.en", "author": "Matti Blume", "attribution_required": "true"}, "source": {"title": "Søren W. Rasmussen, COTY, GIMS 2024, Le Grand-Saconnex (GIMS0032).jpg", "page": "https://commons.wikimedia.org/wiki/File:S%C3%B8ren_W._Rasmussen,_COTY,_GIMS_2024,_Le_Grand-Saconnex_(GIMS0032).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/3/38/S%C3%B8ren_W._Rasmussen%2C_COTY%2C_GIMS_2024%2C_Le_Grand-Saconnex_%28GIMS0032%29.jpg", "creator": "Matti Blume", "creator_url": null, "original_width": 2432, "original_height": 3648, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2432, 3648], "crop_box_px": [0, 0, 2432, 3648], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 51.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc144339350", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the red jacket to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the patterned scarf with a plain white scarf.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the blue trousers with plain black trousers.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Change the blue jacket's material to thick blue wool, keeping its shape.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Add large black dots to the white scarf.", "item": "scarves_ties_collars_badges"}], "people_visible": 1, "face_box": [0.26453, 0.06147, 0.72549, 0.36893], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Seeking_Mavis_Beacon_-_Guetty_Felin-104A2142.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Frank Schulenburg", "attribution_required": "true"}, "source": {"title": "Sundance Film Festival 2024 - Seeking Mavis Beacon - Guetty Felin-104A2142.jpg", "page": "https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Seeking_Mavis_Beacon_-_Guetty_Felin-104A2142.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/eb/Sundance_Film_Festival_2024_-_Seeking_Mavis_Beacon_-_Guetty_Felin-104A2142.jpg", "creator": "Frank Schulenburg", "creator_url": null, "original_width": 3479, "original_height": 4871, "found_via": "Openverse search: jacket"}, "reference_made_by": {"original_size": [3479, 4871], "crop_box_px": [26, 0, 3274, 4871], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc186877998", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the blue scarf to green.", "item": "scarves_ties_collars_badges"}, {"step": 2, "edit_type": "replace", "instruction": "Replace her gold earrings with large silver hoop earrings.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "change", "instruction": "Change the trousers to yellow.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Change the green scarf to shiny silk.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "change", "instruction": "Give the yellow trousers large blue triangles.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.33793, 0.05566, 0.77453, 0.34687], "tags": {"edit_target": ["jewellery_watches", "scarves_ties_collars_badges", "trousers_skirts_belts"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Bhil_community_women_in_traditional_attire,_Jhabua,_Madhya_Pradesh,_India_(8).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Suyash Dwivedi", "attribution_required": "true"}, "source": {"title": "Bhil community women in traditional attire, Jhabua, Madhya Pradesh, India (8).jpg", "page": "https://commons.wikimedia.org/wiki/File:Bhil_community_women_in_traditional_attire,_Jhabua,_Madhya_Pradesh,_India_(8).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/0/08/Bhil_community_women_in_traditional_attire%2C_Jhabua%2C_Madhya_Pradesh%2C_India_%288%29.jpg", "creator": "Suyash Dwivedi", "creator_url": null, "original_width": 2020, "original_height": 3030, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [2020, 3030], "crop_box_px": [0, 0, 2020, 3030], "size": [832, 1248], "icc_profile": "Display P3", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 31.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc43469543", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the centre drummer's green shirt to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the centre drummer's white trousers large black flowers.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "change", "instruction": "Make the blue shirt's sleeves reach the wrists.", "item": "tops_dresses"}, {"step": 4, "edit_type": "add", "instruction": "Add a yellow scarf around the centre drummer's neck.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "change", "instruction": "Change the yellow scarf to red.", "item": "scarves_ties_collars_badges"}], "people_visible": 8, "face_box": [0.40424, 0.03062, 0.78264, 0.283], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Groupe_Tribal_Percussions_-_248.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Another one of my pictures: This photograph was taken by Medium69 (William Crochot) and released under the license state", "attribution_required": "true"}, "source": {"title": "Groupe Tribal Percussions - 248.jpg", "page": "https://commons.wikimedia.org/wiki/File:Groupe_Tribal_Percussions_-_248.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/4/4c/Groupe_Tribal_Percussions_-_248.jpg", "creator": "Another one of my pictures:\n\n\n\nThis photograph was taken by Medium69 (William Cr", "creator_url": null, "original_width": 2419, "original_height": 3629, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [2419, 3629], "crop_box_px": [0, 0, 2419, 3629], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc132970461", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the watch with a round red watch on that wrist.", "item": "jewellery_watches"}, {"step": 2, "edit_type": "remove", "instruction": "Remove the race label from the blue shirt.", "item": "text_signs"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the blue shirt with a purple T-shirt on his chest.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Give the purple T-shirt large yellow stars.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the blue shorts to shiny fabric.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.29722, 0.01672, 0.62783, 0.34733], "tags": {"edit_target": ["jewellery_watches", "text_signs", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2022-08-18_European_Championships_2022_%E2%80%93_Men%27s_200_Metres_by_Sandro_Halank%E2%80%93045.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Sandro Halank, Wikimedia Commons", "attribution_required": "true"}, "source": {"title": "2022-08-18 European Championships 2022 – Men's 200 Metres by Sandro Halank–045.jpg", "page": "https://commons.wikimedia.org/wiki/File:2022-08-18_European_Championships_2022_%E2%80%93_Men%27s_200_Metres_by_Sandro_Halank%E2%80%93045.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/5/56/2022-08-18_European_Championships_2022_%E2%80%93_Men%27s_200_Metres_by_Sandro_Halank%E2%80%93045.jpg", "creator": "Sandro Halank, Wikimedia Commons", "creator_url": null, "original_width": 2896, "original_height": 2934, "found_via": "Openverse search: full length"}, "reference_made_by": {"original_size": [2896, 2934], "crop_box_px": [0, 19, 2896, 2915], "size": [1024, 1024], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 52.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc164861272", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large orange flower picture to the dress's lower front.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the pink shirt to blue.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Lengthen the blue shirt's sleeves to her wrists.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the white hose on the ground to red.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a wide brown belt around the woman's waist.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.32706, 0.11146, 0.67365, 0.34263], "tags": {"edit_target": ["objects", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Khasi_Woman_Dress_Mawphanlur_Oct24_A7CR_04247.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Timothy A. Gonsalves", "attribution_required": "true"}, "source": {"title": "Khasi Woman Dress Mawphanlur Oct24 A7CR 04247.jpg", "page": "https://commons.wikimedia.org/wiki/File:Khasi_Woman_Dress_Mawphanlur_Oct24_A7CR_04247.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/0/0d/Khasi_Woman_Dress_Mawphanlur_Oct24_A7CR_04247.jpg", "creator": "Timothy A. Gonsalves", "creator_url": null, "original_width": 5480, "original_height": 7306, "found_via": "Openverse search: woman street"}, "reference_made_by": {"original_size": [5480, 7306], "crop_box_px": [430, 0, 5300, 7306], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 44.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc198351927", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the grey shirt to yellow.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the yellow shirt large black dots.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the dotted shirt with a closed blue jacket.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the blue jacket's material to jeans cloth.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the grey trousers to white.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.38241, 0.07544, 0.63154, 0.24161], "tags": {"edit_target": ["tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2026_Saxofonista_do_grupo_de_Felisa_Segade._TradFest._Galiza.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Luis Miguel Bugallo Sánchez", "attribution_required": "true"}, "source": {"title": "2026 Saxofonista do grupo de Felisa Segade. TradFest. Galiza.jpg", "page": "https://commons.wikimedia.org/wiki/File:2026_Saxofonista_do_grupo_de_Felisa_Segade._TradFest._Galiza.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/b/b2/2026_Saxofonista_do_grupo_de_Felisa_Segade._TradFest._Galiza.jpg", "creator": "Luis Miguel Bugallo Sánchez", "creator_url": null, "original_width": 4139, "original_height": 6208, "found_via": "Openverse search: woman musician"}, "reference_made_by": {"original_size": [4139, 6208], "crop_box_px": [0, 0, 4139, 6208], "size": [832, 1248], "icc_profile": "DxO WideGamut RGB", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 29.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc18749683", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the light blue helmet to red.", "item": "hair_headwear_glasses"}, {"step": 2, "edit_type": "change", "instruction": "Change the yellow cardigan to green.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Give the green cardigan large white dots.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the red helmet's material to wood.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "change", "instruction": "Change the brown guitar body to blue.", "item": "objects"}], "people_visible": 2, "face_box": [0.25673, 0.05845, 0.75569, 0.39124], "tags": {"edit_target": ["hair_headwear_glasses", "objects", "tops_dresses"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Cody_ChesnuTT_-_Ilosaarirock_2011.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Tuomas Vitikainen", "attribution_required": "true"}, "source": {"title": "Cody ChesnuTT - Ilosaarirock 2011.jpg", "page": "https://commons.wikimedia.org/wiki/File:Cody_ChesnuTT_-_Ilosaarirock_2011.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/1/12/Cody_ChesnuTT_-_Ilosaarirock_2011.jpg", "creator": "Tuomas Vitikainen", "creator_url": null, "original_width": 2609, "original_height": 3929, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [2609, 3929], "crop_box_px": [0, 8, 2609, 3921], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc163677788", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the number 13 on the shirt to 7.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the left woman's blonde hair to dark brown.", "item": "hair_headwear_glasses"}, {"step": 3, "edit_type": "change", "instruction": "Change the white \"VfL\" logo on the left seat to yellow.", "item": "text_signs"}, {"step": 4, "edit_type": "add", "instruction": "Add a white headband to the left woman's hair.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "change", "instruction": "Give the left woman's white headband large blue dots.", "item": "hair_headwear_glasses"}], "people_visible": 2, "face_box": [0.31321, 0.0, 0.75271, 0.4395], "tags": {"edit_target": ["hair_headwear_glasses", "text_signs"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2025-04-08_Fussball,_UEFA_Women%27s_Nations_League,_Deutschland_-_Schottland_STP_2073.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Steffen Prößdorf", "attribution_required": "true"}, "source": {"title": "2025-04-08 Fussball, UEFA Women's Nations League, Deutschland - Schottland STP 2073.jpg", "page": "https://commons.wikimedia.org/wiki/File:2025-04-08_Fussball,_UEFA_Women%27s_Nations_League,_Deutschland_-_Schottland_STP_2073.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/d/da/2025-04-08_Fussball%2C_UEFA_Women%27s_Nations_League%2C_Deutschland_-_Schottland_STP_2073.jpg", "creator": "Steffen Prößdorf", "creator_url": null, "original_width": 2645, "original_height": 2645, "found_via": "Openverse search: scooter"}, "reference_made_by": {"original_size": [2645, 2645], "crop_box_px": [0, 0, 2645, 2645], "size": [1024, 1024], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc18529819", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the dark shirt to yellow.", "item": "tops_dresses"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the dark trousers with blue jeans of the same fit.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "change", "instruction": "Change the man's long hair colour to white.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "change", "instruction": "Give the yellow shirt large black stars.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the blue jeans to shiny silver fabric.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.3361, 0.1091, 0.67062, 0.33222], "tags": {"edit_target": ["hair_headwear_glasses", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:John_Petrucci_-_02.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Carlos Delgado", "attribution_required": "true"}, "source": {"title": "John Petrucci - 02.jpg", "page": "https://commons.wikimedia.org/wiki/File:John_Petrucci_-_02.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/6d/John_Petrucci_-_02.jpg", "creator": "Carlos Delgado", "creator_url": null, "original_width": 2250, "original_height": 3000, "found_via": "Openverse search: guitarist"}, "reference_made_by": {"original_size": [2250, 3000], "crop_box_px": [65, 0, 2065, 3000], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc87185002", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the white shirt to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a long red scarf around her neck, hanging over her shirt.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "change", "instruction": "Give the red scarf large white stars.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the red and white scarf.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "change", "instruction": "Give the black skirt large white dots.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.44556, 0.0, 0.75974, 0.20956], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Slightly_business_casual_Informal_wear_-_pose_2_with_fishnet_tights.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Tobias ToMar Maier", "attribution_required": "true"}, "source": {"title": "Slightly business casual Informal wear - pose 2 with fishnet tights.jpg", "page": "https://commons.wikimedia.org/wiki/File:Slightly_business_casual_Informal_wear_-_pose_2_with_fishnet_tights.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e1/Slightly_business_casual_Informal_wear_-_pose_2_with_fishnet_tights.jpg", "creator": "Tobias ToMar Maier", "creator_url": null, "original_width": 3687, "original_height": 5530, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [3687, 5530], "crop_box_px": [0, 0, 3687, 5530], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 53.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc50966261", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the white shirt to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the skirt's flower pattern to large white dots on black.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the striped scarf with a plain yellow scarf.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the whole yellow scarf.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "change", "instruction": "Give the blue shirt large white stars.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.37571, 0.19416, 0.74508, 0.44053], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:20160807_spice_merchant_Nyaung_Shwe_Myanmar_8917.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Jakub Hałun", "attribution_required": "true"}, "source": {"title": "20160807 spice merchant Nyaung Shwe Myanmar 8917.jpg", "page": "https://commons.wikimedia.org/wiki/File:20160807_spice_merchant_Nyaung_Shwe_Myanmar_8917.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a6/20160807_spice_merchant_Nyaung_Shwe_Myanmar_8917.jpg", "creator": "Jakub Hałun", "creator_url": null, "original_width": 2496, "original_height": 3768, "found_via": "Openverse search: vendor"}, "reference_made_by": {"original_size": [2496, 3768], "crop_box_px": [0, 12, 2496, 3756], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc143058460", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the white coat to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the blue coat's material to shiny plastic.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add large white \"LAB\" text above the coat's pocket.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Shorten the coat's sleeves to the elbows.", "item": "tops_dresses"}, {"step": 5, "edit_type": "add", "instruction": "Add a large red badge to the blue coat's collar.", "item": "scarves_ties_collars_badges"}], "people_visible": 1, "face_box": [0.29306, 0.08179, 0.88859, 0.479], "tags": {"edit_target": ["scarves_ties_collars_badges", "text_signs", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Eva_Nogales_in_2023_06.jpg", "licence": "CC BY 4.0", "licence_url": "https://creativecommons.org/licenses/by/4.0", "author": "Cmichel67", "attribution_required": "true"}, "source": {"title": "Eva Nogales in 2023 06.jpg", "page": "https://commons.wikimedia.org/wiki/File:Eva_Nogales_in_2023_06.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a7/Eva_Nogales_in_2023_06.jpg", "creator": "Cmichel67", "creator_url": null, "original_width": 5464, "original_height": 8192, "found_via": "Openverse search: laboratory"}, "reference_made_by": {"original_size": [5464, 8192], "crop_box_px": [1, 0, 5463, 8192], "size": [832, 1248], "icc_profile": "Display P3", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 42.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc15722258", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the dress's stripes to large black and white squares.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the guitar's red body to blue.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the black belt with a wide red belt.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the whole belt.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "change", "instruction": "Change the black and white dress's material to satin.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.33034, 0.12581, 0.67039, 0.35262], "tags": {"edit_target": ["objects", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Moriarty-IMG_6846.jpg", "licence": "CC BY-SA 2.0 fr", "licence_url": "https://creativecommons.org/licenses/by-sa/2.0/fr/deed.en", "author": "Rama", "attribution_required": "true"}, "source": {"title": "Moriarty-IMG 6846.jpg", "page": "https://commons.wikimedia.org/wiki/File:Moriarty-IMG_6846.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e2/Moriarty-IMG_6846.jpg", "creator": "Rama", "creator_url": null, "original_width": 3744, "original_height": 5616, "found_via": "Openverse search: woman musician"}, "reference_made_by": {"original_size": [3744, 5616], "crop_box_px": [0, 0, 3744, 5616], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 54.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc27115652", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large orange star to the shirt's front.", "item": "tops_dresses"}, {"step": 2, "edit_type": "remove", "instruction": "Remove the chain hanging from the trousers.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "change", "instruction": "Change the trousers' material to leather.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "add", "instruction": "Add a thick gold necklace around the man's neck.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "change", "instruction": "Change the shirt's white fabric to grey.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.39898, 0.08581, 0.7245, 0.30293], "tags": {"edit_target": ["jewellery_watches", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:13-06-07_RiP_The_BossHoss_Boss_Burns_6.JPG", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Antje Naumann (AllSystemsRed)", "attribution_required": "true"}, "source": {"title": "13-06-07 RiP The BossHoss Boss Burns 6.JPG", "page": "https://commons.wikimedia.org/wiki/File:13-06-07_RiP_The_BossHoss_Boss_Burns_6.JPG", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/c2/13-06-07_RiP_The_BossHoss_Boss_Burns_6.JPG", "creator": "Antje Naumann (AllSystemsRed)", "creator_url": null, "original_width": 2248, "original_height": 3372, "found_via": "Openverse search: woman musician"}, "reference_made_by": {"original_size": [2248, 3372], "crop_box_px": [0, 0, 2248, 3372], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 53.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc15099922", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the woman's red hair to blonde.", "item": "hair_headwear_glasses"}, {"step": 2, "edit_type": "add", "instruction": "Add a red knitted hat on the woman's head.", "item": "hair_headwear_glasses"}, {"step": 3, "edit_type": "change", "instruction": "Give the red hat large white stars.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "add", "instruction": "Add a large yellow buoy on the wooden table.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the \"Dive Rite\" letters on the backpack to yellow.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.32222, 0.20331, 0.59298, 0.38391], "tags": {"edit_target": ["hair_headwear_glasses", "objects", "text_signs"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Agnes_Milowka_by_J_Axford.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "James Axford, Melbourne", "attribution_required": "true"}, "source": {"title": "Agnes Milowka by J Axford.jpg", "page": "https://commons.wikimedia.org/wiki/File:Agnes_Milowka_by_J_Axford.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/83/Agnes_Milowka_by_J_Axford.jpg", "creator": "James Axford, Melbourne", "creator_url": null, "original_width": 1856, "original_height": 2784, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [1856, 2784], "crop_box_px": [0, 0, 1856, 2784], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "ba231d2e-b834-4898-b6a0-2f154e708c09", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the man's light blue scrubs to dark green.", "item": "tops_dresses"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the man's brown shoes with white trainers.", "item": "shoes_gloves"}, {"step": 3, "edit_type": "add", "instruction": "Add a large red heart shape to the man's green top.", "item": "tops_dresses"}, {"step": 4, "edit_type": "add", "instruction": "Add a black wristwatch to the man's left wrist.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "change", "instruction": "Change the white trainers to bright red.", "item": "shoes_gloves"}], "people_visible": 2, "face_box": [0.42523, 0.17476, 0.55449, 0.36855], "tags": {"edit_target": ["jewellery_watches", "shoes_gloves", "tops_dresses"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/hospital-waiting-SSDEQHS17S", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Direct Media", "attribution_required": "false"}, "source": {"title": "Hospital Waiting", "page": "https://stocksnap.io/photo/hospital-waiting-SSDEQHS17S", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/SSDEQHS17S.jpg", "creator": "Direct Media", "creator_url": "https://stocksnap.io/author/145556", "original_width": 6082, "original_height": 4054, "found_via": "Openverse search: nurse hospital"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 42.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc12797457", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the jacket's red fabric to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the jacket's leaf pattern to large yellow triangles.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the blue jacket's fabric to fur.", "item": "tops_dresses"}, {"step": 4, "edit_type": "add", "instruction": "Add a wide red belt around the man's waist over the jacket.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "change", "instruction": "Change the black trousers to white.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.34648, 0.12793, 0.73434, 0.38664], "tags": {"edit_target": ["tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:7th_Marquis_of_Colmondeley_2.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Allan Warren", "attribution_required": "true"}, "source": {"title": "7th Marquis of Colmondeley 2.jpg", "page": "https://commons.wikimedia.org/wiki/File:7th_Marquis_of_Colmondeley_2.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/7c/7th_Marquis_of_Colmondeley_2.jpg", "creator": "Allan Warren", "creator_url": null, "original_width": 4423, "original_height": 6423, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4423, 6423], "crop_box_px": [137, 0, 4419, 6423], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc87258958", "steps": [{"step": 1, "edit_type": "change", "instruction": "Give the black top a pattern of large white flowers.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the grey leggings to blue.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "change", "instruction": "Shorten the blue leggings to just below the knees.", "item": "trousers_skirts_belts"}, {"step": 4, "edit_type": "change", "instruction": "Change the flowered top to knitted fabric.", "item": "tops_dresses"}, {"step": 5, "edit_type": "add", "instruction": "Add a wide brown belt around the woman's waist.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.32194, 0.03705, 0.62693, 0.24047], "tags": {"edit_target": ["tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Wolford_fatal_dress_as_a_mini_dress_to_cover_the_see_trough_part_of_a_too_thin_jeggings.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Tobias ToMar Maier", "attribution_required": "true"}, "source": {"title": "Wolford fatal dress as a mini dress to cover the see trough part of a too thin jeggings.jpg", "page": "https://commons.wikimedia.org/wiki/File:Wolford_fatal_dress_as_a_mini_dress_to_cover_the_see_trough_part_of_a_too_thin_jeggings.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/f/fc/Wolford_fatal_dress_as_a_mini_dress_to_cover_the_see_trough_part_of_a_too_thin_jeggings.jpg", "creator": "Tobias ToMar Maier", "creator_url": null, "original_width": 3241, "original_height": 5761, "found_via": "Openverse search: fashion model"}, "reference_made_by": {"original_size": [3241, 5761], "crop_box_px": [0, 0, 3241, 4861], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 52.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc25152397", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the front man's striped polo shirt to plain green.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the green polo shirt large white dots.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change all the red net bags to blue.", "item": "bags"}, {"step": 4, "edit_type": "change", "instruction": "Change the wooden cart side on the left to metal.", "item": "objects"}, {"step": 5, "edit_type": "replace", "instruction": "Replace all the oranges with green apples.", "item": "objects"}], "people_visible": 4, "face_box": [0.30994, 0.02325, 0.7546, 0.31984], "tags": {"edit_target": ["bags", "objects", "tops_dresses"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Sad_tomato_seller.jpg", "licence": "CC0", "licence_url": "http://creativecommons.org/publicdomain/zero/1.0/deed.en", "author": "Wilfredor", "attribution_required": "false"}, "source": {"title": "Sad tomato seller.jpg", "page": "https://commons.wikimedia.org/wiki/File:Sad_tomato_seller.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/d/dc/Sad_tomato_seller.jpg", "creator": "Wilfredor", "creator_url": null, "original_width": 2767, "original_height": 3956, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2767, 3956], "crop_box_px": [65, 0, 2702, 3956], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 49.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "dc5c1ac5-784d-469a-a37f-e313079908ee", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the shirt's print to large purple hearts.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the shirt's background colour to orange.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Extend the shirt's sleeves to his wrists.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Make the shirt shiny silk.", "item": "tops_dresses"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the shirt with a closed green jacket on the man.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.44058, 0.27774, 0.55543, 0.44992], "tags": {"edit_target": ["tops_dresses"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/stairs-stairway-D4XWI5PN82", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Brooke Cagle", "attribution_required": "false"}, "source": {"title": "Stairs Stairway", "page": "https://stocksnap.io/photo/stairs-stairway-D4XWI5PN82", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/D4XWI5PN82.jpg", "creator": "Brooke Cagle", "creator_url": "https://stocksnap.io/author/7552", "original_width": 5371, "original_height": 3581, "found_via": "Openverse search: man sitting stairs"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 52.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc55676665", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the front man's patterned brown scarf to blue.", "item": "scarves_ties_collars_badges"}, {"step": 2, "edit_type": "change", "instruction": "Change the front man's red fez to green.", "item": "hair_headwear_glasses"}, {"step": 3, "edit_type": "change", "instruction": "Change the front man's drum to red.", "item": "objects"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the whole palm tree.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Give the blue scarf large white stars.", "item": "scarves_ties_collars_badges"}], "people_visible": 6, "face_box": [0.22896, 0.30808, 0.63099, 0.57623], "tags": {"edit_target": ["hair_headwear_glasses", "objects", "scarves_ties_collars_badges"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Tunisian_Musicians_04.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Hamed Gamaoun", "attribution_required": "true"}, "source": {"title": "Tunisian Musicians 04.jpg", "page": "https://commons.wikimedia.org/wiki/File:Tunisian_Musicians_04.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/0/0f/Tunisian_Musicians_04.jpg", "creator": "Hamed Gamaoun", "creator_url": null, "original_width": 4000, "original_height": 6016, "found_via": "Openverse search: drummer"}, "reference_made_by": {"original_size": [4000, 6016], "crop_box_px": [0, 9, 4000, 6009], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "63a89c1d-dc76-41e5-95e9-5157825cd504", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the man's dark suit to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue suit a large white checkerboard pattern.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the man's dark tie with a red bow tie.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "add", "instruction": "Add a red rose to the checkerboard jacket's lapel.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "change", "instruction": "Give the red bow tie large white dots.", "item": "scarves_ties_collars_badges"}], "people_visible": 2, "face_box": [0.39518, 0.27159, 0.53064, 0.47468], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses"], "people": ["two"], "face_size": ["medium"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/people-man-RWMC95HRC0", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Glen McCallum", "attribution_required": "false"}, "source": {"title": "People Man", "page": "https://stocksnap.io/photo/people-man-RWMC95HRC0", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/RWMC95HRC0.jpg", "creator": "Glen McCallum", "creator_url": "https://stocksnap.io/author/45752", "original_width": 6000, "original_height": 4000, "found_via": "Openverse search: woman flowers"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 45.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc45035857", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the black head wrap to red.", "item": "hair_headwear_glasses"}, {"step": 2, "edit_type": "change", "instruction": "Change the white scarf around her neck to yellow.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "change", "instruction": "Change the woman's blue robe to green.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the red head wrap's material to silk.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "add", "instruction": "Add a white sign with blue \"WELCOME\" letters at top left.", "item": "text_signs"}], "people_visible": 3, "face_box": [0.06036, 0.15852, 0.65066, 0.55225], "tags": {"edit_target": ["hair_headwear_glasses", "scarves_ties_collars_badges", "text_signs", "tops_dresses"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:GedFunerailles0.JPG", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Mbiele Happi", "attribution_required": "true"}, "source": {"title": "GedFunerailles0.JPG", "page": "https://commons.wikimedia.org/wiki/File:GedFunerailles0.JPG", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/24/GedFunerailles0.JPG", "creator": "Mbiele Happi", "creator_url": null, "original_width": 2592, "original_height": 3872, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [2592, 3872], "crop_box_px": [5, 0, 2587, 3872], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc86971536", "steps": [{"step": 1, "edit_type": "change", "instruction": "Shorten the dress sleeves to end halfway down the upper arms.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Print a large yellow star on the front of the dress.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the heels with brown ankle boots on the woman's feet.", "item": "shoes_gloves"}, {"step": 4, "edit_type": "add", "instruction": "Add a wide brown belt around the woman's waist.", "item": "trousers_skirts_belts"}, {"step": 5, "edit_type": "change", "instruction": "Give the white radiator a green and brown camouflage pattern.", "item": "objects"}], "people_visible": 1, "face_box": [0.3639, 0.0, 0.6539, 0.19343], "tags": {"edit_target": ["objects", "shoes_gloves", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Simple_sweater_dress_with_with_turtleneck_-_pose_1.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Tobias ToMar Maier", "attribution_required": "true"}, "source": {"title": "Simple sweater dress with with turtleneck - pose 1.jpg", "page": "https://commons.wikimedia.org/wiki/File:Simple_sweater_dress_with_with_turtleneck_-_pose_1.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/0/00/Simple_sweater_dress_with_with_turtleneck_-_pose_1.jpg", "creator": "Tobias ToMar Maier", "creator_url": null, "original_width": 3983, "original_height": 5974, "found_via": "Openverse search: fashion model"}, "reference_made_by": {"original_size": [3983, 5974], "crop_box_px": [0, 0, 3983, 5974], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "b036af66-8c49-403b-9f0b-38ff46a89f73", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the coat with a short brown jacket on his torso.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a large train picture to the jacket's lower front.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change the brown jacket to green.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the green jacket's material to knitted.", "item": "tops_dresses"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the green knitted jacket.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.49014, 0.13675, 0.67531, 0.41436], "tags": {"edit_target": ["tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/man-entering-7GXMY2JMR4", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Bruce Mars", "attribution_required": "false"}, "source": {"title": "Man Entering", "page": "https://stocksnap.io/photo/man-entering-7GXMY2JMR4", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/7GXMY2JMR4.jpg", "creator": "Bruce Mars", "creator_url": "https://stocksnap.io/author/brucemars", "original_width": 5816, "original_height": 3877, "found_via": "Openverse search: train platform people"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 43.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc11127070", "steps": [{"step": 1, "edit_type": "change", "instruction": "Lengthen the shirt sleeves to the wrists.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a large orange bead necklace around the man's neck.", "item": "jewellery_watches"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the dark cap with a white cowboy hat.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "change", "instruction": "Give the shirt's white front a large yellow leaf pattern.", "item": "tops_dresses"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the orange bead necklace.", "item": "jewellery_watches"}], "people_visible": 1, "face_box": [0.28103, 0.09994, 0.64901, 0.34538], "tags": {"edit_target": ["hair_headwear_glasses", "jewellery_watches", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Nottingham_Pride_MMB_67_Kenelis.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "mattbuck (category)", "attribution_required": "true"}, "source": {"title": "Nottingham Pride MMB 67 Kenelis.jpg", "page": "https://commons.wikimedia.org/wiki/File:Nottingham_Pride_MMB_67_Kenelis.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/6a/Nottingham_Pride_MMB_67_Kenelis.jpg", "creator": "mattbuck (category)", "creator_url": null, "original_width": 2537, "original_height": 3661, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [2537, 3661], "crop_box_px": [10, 0, 2451, 3661], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "c70bc7ee-1701-4a79-94cd-f5325b6d5e30", "steps": [{"step": 1, "edit_type": "change", "instruction": "Extend the shirt sleeves to his wrists.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change his light blue scrubs to green.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a brown leather bag over his shoulder on picture right.", "item": "bags"}, {"step": 4, "edit_type": "change", "instruction": "Change the brown bag from leather to thick cloth.", "item": "bags"}, {"step": 5, "edit_type": "change", "instruction": "Cover the green scrubs with large white triangles.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.66921, 0.19265, 0.82517, 0.42648], "tags": {"edit_target": ["bags", "tops_dresses"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/male-nurse-8OYPFEL4K8", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Direct Media", "attribution_required": "false"}, "source": {"title": "Male Nurse", "page": "https://stocksnap.io/photo/male-nurse-8OYPFEL4K8", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/8OYPFEL4K8.jpg", "creator": "Direct Media", "creator_url": "https://stocksnap.io/author/145556", "original_width": 8688, "original_height": 5792, "found_via": "Openverse search: hospital nurse"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 44.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "04e3d2a8-27ca-431c-92e1-402527e6b824", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large brown cloth shoulder bag against the man's hip.", "item": "bags"}, {"step": 2, "edit_type": "change", "instruction": "Change the brown bag's material to straw.", "item": "bags"}, {"step": 3, "edit_type": "add", "instruction": "Add large white words \"FIRST AID\" to the brown bag's front.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the man's shirt colour to green.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Give the green shirt large white zigzags.", "item": "tops_dresses"}], "people_visible": 2, "face_box": [0.34498, 0.0679, 0.59062, 0.23174], "tags": {"edit_target": ["bags", "text_signs", "tops_dresses"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/wheelchair-person-OQZYXPNK5H", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Direct Media", "attribution_required": "false"}, "source": {"title": "Wheelchair Person", "page": "https://stocksnap.io/photo/wheelchair-person-OQZYXPNK5H", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/OQZYXPNK5H.jpg", "creator": "Direct Media", "creator_url": "https://stocksnap.io/author/145556", "original_width": 5529, "original_height": 8293, "found_via": "Openverse search: nurse hospital"}, "reference_made_by": {"original_size": [960, 1440], "crop_box_px": [8, 11, 952, 1429], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 25.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "6e58849a-cb37-4b82-930f-5546480e7417", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the white coat to blue.", "item": "tops_dresses"}, {"step": 2, "edit_type": "remove", "instruction": "Remove the stethoscope from around the man's neck.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the blue coat's pattern to large white squares.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the hair on top of the doctor's head to brown.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the pen pot on the desk with a white coffee mug.", "item": "objects"}], "people_visible": 3, "face_box": [0.72015, 0.06437, 0.91617, 0.35825], "tags": {"edit_target": ["hair_headwear_glasses", "objects", "tops_dresses"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/doctor-patient-RZCTEGBC2V", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Direct Media", "attribution_required": "false"}, "source": {"title": "Doctor Patient", "page": "https://stocksnap.io/photo/doctor-patient-RZCTEGBC2V", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/RZCTEGBC2V.jpg", "creator": "Direct Media", "creator_url": "https://stocksnap.io/author/145556", "original_width": 6720, "original_height": 4480, "found_via": "Openverse search: hospital nurse"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 43.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "3b81d7c7-3cf6-4be8-8f01-75c9919c9bb8", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large green circle to the shirt front.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Cover the trousers with a large pink flower pattern.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "change", "instruction": "Lengthen the shirt sleeves to the wrists.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the shirt's light blue fabric to purple.", "item": "tops_dresses"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the brown shoes with green sports shoes on his feet.", "item": "shoes_gloves"}], "people_visible": 1, "face_box": [0.63165, 0.07818, 0.80934, 0.34458], "tags": {"edit_target": ["shoes_gloves", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/male-nurse-U1PTBWATO7", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Direct Media", "attribution_required": "false"}, "source": {"title": "Male Nurse", "page": "https://stocksnap.io/photo/male-nurse-U1PTBWATO7", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/U1PTBWATO7.jpg", "creator": "Direct Media", "creator_url": "https://stocksnap.io/author/145556", "original_width": 8688, "original_height": 5792, "found_via": "Openverse search: nurse hospital"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 44.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc47590527", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the scarf's plaid pattern to large blue, white and red stars.", "item": "scarves_ties_collars_badges"}, {"step": 2, "edit_type": "change", "instruction": "Change the black coat to green.", "item": "tops_dresses"}, {"step": 3, "edit_type": "remove", "instruction": "Remove the star-print scarf.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "add", "instruction": "Add a large plain yellow scarf around her shoulders.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "change", "instruction": "Give the yellow scarf a pattern of large black dots.", "item": "scarves_ties_collars_badges"}], "people_visible": 1, "face_box": [0.27599, 0.22918, 0.72176, 0.5265], "tags": {"edit_target": ["scarves_ties_collars_badges", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Ca%C3%B1ari_woman_02.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Bernard Gagnon", "attribution_required": "true"}, "source": {"title": "Cañari woman 02.jpg", "page": "https://commons.wikimedia.org/wiki/File:Ca%C3%B1ari_woman_02.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/d/db/Ca%C3%B1ari_woman_02.jpg", "creator": "Bernard Gagnon", "creator_url": null, "original_width": 1596, "original_height": 2234, "found_via": "Openverse search: woman street"}, "reference_made_by": {"original_size": [1596, 2234], "crop_box_px": [94, 0, 1584, 2234], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 44.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc26567769", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the brown padded vest to dark green.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the khaki trousers a large blue checkerboard pattern.", "item": "trousers_skirts_belts"}, {"step": 3, "edit_type": "change", "instruction": "Change the white figure on the orange T-shirt to black.", "item": "tops_dresses"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the whole green vest.", "item": "tops_dresses"}, {"step": 5, "edit_type": "add", "instruction": "Add a red baseball cap on the man's head.", "item": "hair_headwear_glasses"}], "people_visible": 1, "face_box": [0.35837, 0.03985, 0.64309, 0.32457], "tags": {"edit_target": ["hair_headwear_glasses", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:University_Park_MMB_%C2%ABN6_Students%27_Union_Elections_2013.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "mattbuck (category)", "attribution_required": "true"}, "source": {"title": "University Park MMB «N6 Students' Union Elections 2013.jpg", "page": "https://commons.wikimedia.org/wiki/File:University_Park_MMB_%C2%ABN6_Students%27_Union_Elections_2013.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/d/d6/University_Park_MMB_%C2%ABN6_Students%27_Union_Elections_2013.jpg", "creator": "mattbuck (category)", "creator_url": null, "original_width": 3126, "original_height": 2607, "found_via": "Openverse search: police officer"}, "reference_made_by": {"original_size": [3126, 2607], "crop_box_px": [284, 0, 2891, 2607], "size": [1024, 1024], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc40941239", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the whole microphone and its stand.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the brown leather jacket to black.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a yellow tie around the singer's neck, hanging over his shirt.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the yellow tie with a yellow bow tie at his neck.", "item": "scarves_ties_collars_badges"}, {"step": 5, "edit_type": "change", "instruction": "Give the black jacket large white stars.", "item": "tops_dresses"}], "people_visible": 3, "face_box": [0.33451, 0.00439, 0.66979, 0.33967], "tags": {"edit_target": ["objects", "scarves_ties_collars_badges", "tops_dresses"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Guy_Sebastian_ESC2015_Eurovision_Village_Vienna_08crop.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Manfred Werner - Tsui", "attribution_required": "true"}, "source": {"title": "Guy Sebastian ESC2015 Eurovision Village Vienna 08crop.jpg", "page": "https://commons.wikimedia.org/wiki/File:Guy_Sebastian_ESC2015_Eurovision_Village_Vienna_08crop.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/85/Guy_Sebastian_ESC2015_Eurovision_Village_Vienna_08crop.jpg", "creator": "Manfred Werner - Tsui", "creator_url": null, "original_width": 3030, "original_height": 2800, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [3030, 2800], "crop_box_px": [38, 0, 2838, 2800], "size": [1024, 1024], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 45.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc145784234", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the jacket's denim to green corduroy.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Change the red scarf's material to silk.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "remove", "instruction": "Remove the red silk scarf.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "change", "instruction": "Change the black beanie to orange.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "change", "instruction": "Make the corduroy jacket sleeveless.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.10965, 0.0, 0.61656, 0.50691], "tags": {"edit_target": ["hair_headwear_glasses", "scarves_ties_collars_badges", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Kevin_Carmant-104A3458.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Frank Schulenburg", "attribution_required": "true"}, "source": {"title": "Sundance Film Festival 2024 - Kevin Carmant-104A3458.jpg", "page": "https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Kevin_Carmant-104A3458.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/89/Sundance_Film_Festival_2024_-_Kevin_Carmant-104A3458.jpg", "creator": "Frank Schulenburg", "creator_url": null, "original_width": 3905, "original_height": 3905, "found_via": "Openverse search: jacket"}, "reference_made_by": {"original_size": [3905, 3905], "crop_box_px": [0, 0, 3905, 3905], "size": [1024, 1024], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 45.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc154107516", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the blue shirt to brown.", "item": "tops_dresses"}, {"step": 2, "edit_type": "add", "instruction": "Add a large yellow star to the front of the shirt.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a wide green bracelet around the wrist holding the microphone.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "change", "instruction": "Change the green bracelet to white.", "item": "jewellery_watches"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the white bracelet.", "item": "jewellery_watches"}], "people_visible": 2, "face_box": [0.21243, 0.05117, 0.79631, 0.44061], "tags": {"edit_target": ["jewellery_watches", "tops_dresses"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Buchmesse_2024,_Frankfurt_am_Main_(P1200850-2).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0/deed.en", "author": "Matti Blume", "attribution_required": "true"}, "source": {"title": "Buchmesse 2024, Frankfurt am Main (P1200850-2).jpg", "page": "https://commons.wikimedia.org/wiki/File:Buchmesse_2024,_Frankfurt_am_Main_(P1200850-2).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/b/b0/Buchmesse_2024%2C_Frankfurt_am_Main_%28P1200850-2%29.jpg", "creator": "Matti Blume", "creator_url": null, "original_width": 3456, "original_height": 4608, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3456, 4608], "crop_box_px": [73, 0, 3145, 4608], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 50.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc107302058", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the grey jacket to red.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the red jacket a large white leaf pattern.", "item": "tops_dresses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the leaf-print jacket with an open blue jeans jacket.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the man's brown hair to blonde.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "change", "instruction": "Change the blue trousers from cloth to velvet.", "item": "trousers_skirts_belts"}], "people_visible": 1, "face_box": [0.17891, 0.00459, 0.78695, 0.41015], "tags": {"edit_target": ["hair_headwear_glasses", "tops_dresses", "trousers_skirts_belts"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Young_men_smiling_with_teeth,_studio_portrait.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Dmitry Makeev", "attribution_required": "true"}, "source": {"title": "Young men smiling with teeth, studio portrait.jpg", "page": "https://commons.wikimedia.org/wiki/File:Young_men_smiling_with_teeth,_studio_portrait.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/ac/Young_men_smiling_with_teeth%2C_studio_portrait.jpg", "creator": "Dmitry Makeev", "creator_url": null, "original_width": 3436, "original_height": 5000, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3436, 5000], "crop_box_px": [0, 0, 3333, 5000], "size": [832, 1248], "icc_profile": "Apple RGB", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 25.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc36507851", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the dress pattern to large black and white triangles.", "item": "tops_dresses"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the silver trophy with a tall gold cup.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the dress's white triangles to yellow.", "item": "tops_dresses"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the whole gold cup.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the dress's triangles to large black dots on yellow fabric.", "item": "tops_dresses"}], "people_visible": 1, "face_box": [0.24174, 0.06545, 0.74067, 0.39823], "tags": {"edit_target": ["objects", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Austrian_Sportspeople_of_the_Year_2014_winners_09_Mirna_Jukic.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Manfred Werner - Tsui", "attribution_required": "true"}, "source": {"title": "Austrian Sportspeople of the Year 2014 winners 09 Mirna Jukic.jpg", "page": "https://commons.wikimedia.org/wiki/File:Austrian_Sportspeople_of_the_Year_2014_winners_09_Mirna_Jukic.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/21/Austrian_Sportspeople_of_the_Year_2014_winners_09_Mirna_Jukic.jpg", "creator": "Manfred Werner - Tsui", "creator_url": null, "original_width": 2400, "original_height": 3600, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [2400, 3600], "crop_box_px": [0, 0, 2400, 3600], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc77136330", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the trophy from the white table.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the white counter's front and sides to blue.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the orchid with a large green plant in a brown pot.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Give the blue counter a large blue and white checkerboard pattern.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the screen behind the white table.", "item": "objects"}], "people_visible": 2, "face_box": [0.33358, 0.06924, 0.47453, 0.28057], "tags": {"edit_target": ["objects"], "people": ["two"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:IntoPIX_aux_Journ%C3%A9es_de_l%27Industrie_2019,_UCLouvain_(DSCF7897).jpg", "licence": "CC BY 4.0", "licence_url": "https://creativecommons.org/licenses/by/4.0", "author": "Trougnouf (Benoit Brummer)", "attribution_required": "true"}, "source": {"title": "IntoPIX aux Journées de l'Industrie 2019, UCLouvain (DSCF7897).jpg", "page": "https://commons.wikimedia.org/wiki/File:IntoPIX_aux_Journ%C3%A9es_de_l%27Industrie_2019,_UCLouvain_(DSCF7897).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/25/IntoPIX_aux_Journ%C3%A9es_de_l%27Industrie_2019%2C_UCLouvain_%28DSCF7897%29.jpg", "creator": "Trougnouf (Benoit Brummer)", "creator_url": null, "original_width": 4286, "original_height": 2895, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4286, 2895], "crop_box_px": [0, 19, 4286, 2876], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc9590080", "steps": [{"step": 1, "edit_type": "change", "instruction": "Give the silver tray at bottom right large yellow triangles.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change all the grey clay pots to red.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the tray at bottom right with a large woven straw tray.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the pale sacks behind the pots to blue.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the wooden ladder on the right to blue.", "item": "objects"}], "people_visible": 1, "face_box": [0.67893, 0.09114, 0.85182, 0.35036], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Potter_and_his_work,_Jaura,_India.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Yann (talk)", "attribution_required": "true"}, "source": {"title": "Potter and his work, Jaura, India.jpg", "page": "https://commons.wikimedia.org/wiki/File:Potter_and_his_work,_Jaura,_India.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a9/Potter_and_his_work%2C_Jaura%2C_India.jpg", "creator": "Yann (talk)", "creator_url": null, "original_width": 3806, "original_height": 2464, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3806, 2464], "crop_box_px": [109, 0, 3805, 2464], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc146462387", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the brown paper bag to blue.", "item": "bags"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the blue paper bag with a large red box.", "item": "bags"}, {"step": 3, "edit_type": "change", "instruction": "Give the red box large white stars.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the framed wall picture with a large round clock.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the round wall clock.", "item": "objects"}], "people_visible": 1, "face_box": [0.35165, 0.2696, 0.50789, 0.50383], "tags": {"edit_target": ["bags", "objects"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:At_Princeton_University_2024_058_-_Bruce_T._Draine.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Photograph by Mike Peel (www.mikepeel.net).", "attribution_required": "true"}, "source": {"title": "At Princeton University 2024 058 - Bruce T. Draine.jpg", "page": "https://commons.wikimedia.org/wiki/File:At_Princeton_University_2024_058_-_Bruce_T._Draine.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/9a/At_Princeton_University_2024_058_-_Bruce_T._Draine.jpg", "creator": "Photograph by Mike Peel (www.mikepeel.net).", "creator_url": null, "original_width": 6030, "original_height": 4640, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [6030, 4640], "crop_box_px": [1, 0, 6029, 4018], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 42.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc29828836", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the red pillar to blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the white railing's material to dark wood.", "item": "objects"}, {"step": 3, "edit_type": "remove", "instruction": "Remove the whole microphone and its cable.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a black cap on the player's head.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "change", "instruction": "Give the blue pillar large white zigzags.", "item": "objects"}], "people_visible": 3, "face_box": [0.20205, 0.17552, 0.65606, 0.47833], "tags": {"edit_target": ["hair_headwear_glasses", "objects"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Dalian_Liaoning_China_Ruan-Player-in-Dalian-Labour-Park-01.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Dalian Liaoning China Ruan-Player-in-Dalian-Labour-Park-01.jpg", "page": "https://commons.wikimedia.org/wiki/File:Dalian_Liaoning_China_Ruan-Player-in-Dalian-Labour-Park-01.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/76/Dalian_Liaoning_China_Ruan-Player-in-Dalian-Labour-Park-01.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 2366, "original_height": 3500, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [2366, 3500], "crop_box_px": [16, 0, 2350, 3500], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc32720436", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the small grey wall plaque with a round white wall clock.", "item": "objects"}, {"step": 2, "edit_type": "remove", "instruction": "Remove the whole brown cloth bundle from the boxes.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the tall metal jar on the boxes to red.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change all the cardboard boxes to blue.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a green plant in a white pot on the blue boxes.", "item": "objects"}], "people_visible": 1, "face_box": [0.23112, 0.05038, 0.64997, 0.67835], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Xian_China_Yang-Jide-01.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Xian China Yang-Jide-01.jpg", "page": "https://commons.wikimedia.org/wiki/File:Xian_China_Yang-Jide-01.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/4/48/Xian_China_Yang-Jide-01.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 2636, "original_height": 2109, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2636, 2109], "crop_box_px": [0, 0, 2636, 1757], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc52136996", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the striped white flour sack to plain red.", "item": "bags"}, {"step": 2, "edit_type": "change", "instruction": "Change the two small white bowls at bottom left to red.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the centre man's white shirt large blue stars.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the large white sign at top left to green.", "item": "text_signs"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the red sack with a brown burlap sack.", "item": "bags"}], "people_visible": 3, "face_box": [0.43197, 0.34829, 0.55305, 0.52982], "tags": {"edit_target": ["bags", "objects", "text_signs", "tops_dresses"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Panader%C3%ADa_en_Yazd,_Ir%C3%A1n,_2016-09-21,_DD_44.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Diego Delso", "attribution_required": "true"}, "source": {"title": "Panadería en Yazd, Irán, 2016-09-21, DD 44.jpg", "page": "https://commons.wikimedia.org/wiki/File:Panader%C3%ADa_en_Yazd,_Ir%C3%A1n,_2016-09-21,_DD_44.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/96/Panader%C3%ADa_en_Yazd%2C_Ir%C3%A1n%2C_2016-09-21%2C_DD_44.jpg", "creator": "Diego Delso", "creator_url": null, "original_width": 5257, "original_height": 3578, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [5257, 3578], "crop_box_px": [0, 73, 5257, 3577], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 38.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc133986723", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the man's purple tie to green.", "item": "scarves_ties_collars_badges"}, {"step": 2, "edit_type": "change", "instruction": "Change the orange cloth on the mat to yellow.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the man's grey suit's material to corduroy.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Give the yellow cloth large black dots.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole white bowl.", "item": "objects"}], "people_visible": 3, "face_box": [0.16458, 0.20629, 0.4941, 0.42607], "tags": {"edit_target": ["objects", "scarves_ties_collars_badges", "tops_dresses"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Japanese_garden_at_Sch%C3%B6nbrunn_Palace_in_Vienna,_Austria_-_teahouse_Heterotopia_tea_ceremony-water_PNr%C2%B01026.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "D-Kuru", "attribution_required": "true"}, "source": {"title": "Japanese garden at Schönbrunn Palace in Vienna, Austria - teahouse Heterotopia tea ceremony-water PNr°1026.jpg", "page": "https://commons.wikimedia.org/wiki/File:Japanese_garden_at_Sch%C3%B6nbrunn_Palace_in_Vienna,_Austria_-_teahouse_Heterotopia_tea_ceremony-water_PNr%C2%B01026.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/cb/Japanese_garden_at_Sch%C3%B6nbrunn_Palace_in_Vienna%2C_Austria_-_teahouse_Heterotopia_tea_ceremony-water_PNr%C2%B01026.jpg", "creator": "D-Kuru", "creator_url": null, "original_width": 2830, "original_height": 3434, "found_via": "Openverse search: tea house"}, "reference_made_by": {"original_size": [2830, 3434], "crop_box_px": [262, 0, 2551, 3434], "size": [832, 1248], "icc_profile": "GIMP built-in sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc26244423", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the tall thread stand beside the window.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the sewing machine's colour to yellow.", "item": "objects"}, {"step": 3, "edit_type": "add", "instruction": "Add a large brown box on the table beside the window.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Cover the brown box with large green zigzags.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the yellow sewing machine's material to gold.", "item": "objects"}], "people_visible": 1, "face_box": [0.52597, 0.16501, 0.79253, 0.56466], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Upholstering_the_seats_of_your_own_car,_Margarita_Island,_Venezuela.jpg", "licence": "CC0", "licence_url": "http://creativecommons.org/publicdomain/zero/1.0/deed.en", "author": "Wilfredor", "attribution_required": "false"}, "source": {"title": "Upholstering the seats of your own car, Margarita Island, Venezuela.jpg", "page": "https://commons.wikimedia.org/wiki/File:Upholstering_the_seats_of_your_own_car,_Margarita_Island,_Venezuela.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/0/00/Upholstering_the_seats_of_your_own_car%2C_Margarita_Island%2C_Venezuela.jpg", "creator": "Wilfredor", "creator_url": null, "original_width": 3011, "original_height": 2000, "found_via": "Openverse search: exhibition stand"}, "reference_made_by": {"original_size": [3011, 2000], "crop_box_px": [6, 0, 3006, 2000], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc16957573", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the brown tablecloth to blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue tablecloth large white dots.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change all four brown beer bottles to green glass.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the white napkin under the sausage to red.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a white teapot on the dotted tablecloth.", "item": "objects"}], "people_visible": 4, "face_box": [0.12083, 0.23464, 0.32078, 0.53441], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Tatort_vier_Ermittler_2.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Superbass", "attribution_required": "true"}, "source": {"title": "Tatort vier Ermittler 2.jpg", "page": "https://commons.wikimedia.org/wiki/File:Tatort_vier_Ermittler_2.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/6e/Tatort_vier_Ermittler_2.jpg", "creator": "Superbass", "creator_url": null, "original_width": 4731, "original_height": 3403, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4731, 3403], "crop_box_px": [2, 212, 4729, 3364], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2-1 black scaled", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 41.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc186192168", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the left man's red striped tie to plain blue.", "item": "scarves_ties_collars_badges"}, {"step": 2, "edit_type": "change", "instruction": "Change the woman's white hair to brown.", "item": "hair_headwear_glasses"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the pink flowers at bottom left with yellow sunflowers.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the black grand piano to white.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the yellow sunflowers at bottom left.", "item": "objects"}], "people_visible": 3, "face_box": [0.39545, 0.25648, 0.59352, 0.55345], "tags": {"edit_target": ["hair_headwear_glasses", "objects", "scarves_ties_collars_badges"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:AC_SO_Karlspreis%C3%BCbergabe_14.03.2026_Gespr%C3%A4chsrunde_VI.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Grunpfnul", "attribution_required": "true"}, "source": {"title": "AC SO Karlspreisübergabe 14.03.2026 Gesprächsrunde VI.jpg", "page": "https://commons.wikimedia.org/wiki/File:AC_SO_Karlspreis%C3%BCbergabe_14.03.2026_Gespr%C3%A4chsrunde_VI.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/25/AC_SO_Karlspreis%C3%BCbergabe_14.03.2026_Gespr%C3%A4chsrunde_VI.jpg", "creator": "Grunpfnul", "creator_url": null, "original_width": 5065, "original_height": 3377, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [5065, 3377], "crop_box_px": [0, 0, 5065, 3377], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 44.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc63914699", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large red flower pot on the path's right edge.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the red flower pot large white dots.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change both of his white knee socks to red.", "item": "shoes_gloves"}, {"step": 4, "edit_type": "change", "instruction": "Change the blue hose on the right to green.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change his khaki shorts to blue.", "item": "trousers_skirts_belts"}], "people_visible": 2, "face_box": [0.31675, 0.05799, 0.58875, 0.23942], "tags": {"edit_target": ["objects", "shoes_gloves", "trousers_skirts_belts"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Adrian_Horridge_FRS_on_his_90th_birthday.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Thennicke", "attribution_required": "true"}, "source": {"title": "Adrian Horridge FRS on his 90th birthday.jpg", "page": "https://commons.wikimedia.org/wiki/File:Adrian_Horridge_FRS_on_his_90th_birthday.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/2a/Adrian_Horridge_FRS_on_his_90th_birthday.jpg", "creator": "Thennicke", "creator_url": null, "original_width": 3868, "original_height": 5794, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3868, 5794], "crop_box_px": [3, 0, 3865, 5794], "size": [832, 1248], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 44.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc15739979", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the white round mirror frame to pink marble.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the round mirror frame a pattern of large blue dots.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the man's black shirt to dark red.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Change the man's grey hair to brown.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the man's wine glass with a red coffee mug.", "item": "objects"}], "people_visible": 4, "face_box": [0.0, 0.14165, 0.3817, 0.52335], "tags": {"edit_target": ["hair_headwear_glasses", "objects", "tops_dresses"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Giorgio_Moroder.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "This Photo was taken by Wolfgang Moroder. Feel free to use my photos, but please mention me as the author and send me a ", "attribution_required": "true"}, "source": {"title": "Giorgio Moroder.jpg", "page": "https://commons.wikimedia.org/wiki/File:Giorgio_Moroder.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/1/10/Giorgio_Moroder.jpg", "creator": "This Photo was taken by Wolfgang Moroder. \n\nFeel free to use my photos, but ple", "creator_url": null, "original_width": 2508, "original_height": 2304, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2508, 2304], "crop_box_px": [204, 0, 2508, 2304], "size": [1024, 1024], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc49316526", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large brown cardboard box on the empty seat, far right.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Cover the brown box with a pattern of large white dots.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the dotted box from brown to black.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the white dots on the black box to red.", "item": "objects"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the dotted box with a large blue plastic crate.", "item": "objects"}], "people_visible": 3, "face_box": [0.21686, 0.14481, 0.36896, 0.37285], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Kadavar-Bandfoto.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Henry W. Laurisch", "attribution_required": "true"}, "source": {"title": "Kadavar-Bandfoto.jpg", "page": "https://commons.wikimedia.org/wiki/File:Kadavar-Bandfoto.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a3/Kadavar-Bandfoto.jpg", "creator": "Henry W. Laurisch", "creator_url": null, "original_width": 3500, "original_height": 2333, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3500, 2333], "crop_box_px": [0, 0, 3500, 2333], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc148617194", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large brown plant pot on the concrete beam at top left.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the pot's material to stone.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the stone pot a pattern of large yellow triangles.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the stone pot with a large glass vase on the beam.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the glass vase to blue.", "item": "objects"}], "people_visible": 1, "face_box": [0.37843, 0.20806, 0.63248, 0.58895], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Woman_hanging_out_with_a_donkey_in_Louvain-la-Neuve_(DSC03050).jpg", "licence": "CC BY 4.0", "licence_url": "https://creativecommons.org/licenses/by/4.0", "author": "Trougnouf (Benoit Brummer)", "attribution_required": "true"}, "source": {"title": "Woman hanging out with a donkey in Louvain-la-Neuve (DSC03050).jpg", "page": "https://commons.wikimedia.org/wiki/File:Woman_hanging_out_with_a_donkey_in_Louvain-la-Neuve_(DSC03050).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/6d/Woman_hanging_out_with_a_donkey_in_Louvain-la-Neuve_%28DSC03050%29.jpg", "creator": "Trougnouf (Benoit Brummer)", "creator_url": null, "original_width": 4968, "original_height": 4021, "found_via": "Openverse search: woman street"}, "reference_made_by": {"original_size": [4968, 4021], "crop_box_px": [0, 709, 4968, 4021], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 40.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc25393546", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the large white car on the left to red.", "item": "objects"}, {"step": 2, "edit_type": "add", "instruction": "Add a large green trash bin on the sidewalk on the right.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the green trash bin a pattern of large yellow dots.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Give the red car on the left large white stars.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole trash bin on the right sidewalk.", "item": "objects"}], "people_visible": 7, "face_box": [0.31795, 0.05046, 0.5858, 0.45204], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Palms_seller_for_Palm_Sunday.jpg", "licence": "CC0", "licence_url": "http://creativecommons.org/publicdomain/zero/1.0/deed.en", "author": "Wilfredor", "attribution_required": "false"}, "source": {"title": "Palms seller for Palm Sunday.jpg", "page": "https://commons.wikimedia.org/wiki/File:Palms_seller_for_Palm_Sunday.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/85/Palms_seller_for_Palm_Sunday.jpg", "creator": "Wilfredor", "creator_url": null, "original_width": 3648, "original_height": 2315, "found_via": "Openverse search: seller"}, "reference_made_by": {"original_size": [3648, 2315], "crop_box_px": [175, 0, 3648, 2315], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "32b862ba-7f9b-4cac-b802-20e3661dcfe5", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the fridge's black frame to red.", "item": "objects"}, {"step": 2, "edit_type": "remove", "instruction": "Remove the whole black lamp above the bench.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the large white jug with a large blue plastic bottle.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the large crumpled foil on the bench to red paper.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a yellow mug on the bench near the blue plates.", "item": "objects"}], "people_visible": 1, "face_box": [0.52085, 0.0, 0.88611, 0.54762], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Rawpixel via Openverse", "page": "https://www.rawpixel.com/image/8736408/orau-summer-program-ornl-2014-oak-ridge", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "usdoe", "attribution_required": "false"}, "source": {"title": "ORAU summer program ORNL 2014", "page": "https://www.rawpixel.com/image/8736408/orau-summer-program-ornl-2014-oak-ridge", "image_url": "https://images.rawpixel.com/editor_1024/cHJpdmF0ZS9sci9pbWFnZXMvd2Vic2l0ZS8yMDIyLTExL2ZsNTA2NDQxMDA5MjgtaW1hZ2UuanBn.jpg", "creator": "usdoe", "creator_url": null, "original_width": 4085, "original_height": 2848, "found_via": "Openverse search: laboratory scientist"}, "reference_made_by": {"original_size": [1024, 714], "crop_box_px": [0, 0, 1024, 683], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 39.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "4114f183-6307-4f8e-8e87-b68d8620009f", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the green cutting board to blue.", "item": "objects"}, {"step": 2, "edit_type": "replace", "instruction": "Replace all the chard on the board with whole carrots.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the knife's blade to black.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the small plastic cup with a white ceramic bowl.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add three red tomatoes on the blue cutting board.", "item": "objects"}], "people_visible": 2, "face_box": [0.18787, 0.0, 0.51252, 0.32465], "tags": {"edit_target": ["objects"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Rawpixel via Openverse", "page": "https://www.rawpixel.com/image/8739012/student-chef-team", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "U.S. Army", "attribution_required": "false"}, "source": {"title": "FD Student Chef Team", "page": "https://www.rawpixel.com/image/8739012/student-chef-team", "image_url": "https://images.rawpixel.com/editor_1024/cHJpdmF0ZS9sci9pbWFnZXMvd2Vic2l0ZS8yMDIyLTExL2ZsNTEzMzc1MDI4MzktaW1hZ2UuanBn.jpg", "creator": "U.S. Army", "creator_url": null, "original_width": 3024, "original_height": 3024, "found_via": "Openverse search: chef cooking kitchen"}, "reference_made_by": {"original_size": [1024, 1024], "crop_box_px": [0, 0, 1024, 1024], "size": [1024, 1024], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 42.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "16657fe8-b95c-4888-93ba-ed5a8d56735a", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the flowered white bucket on the left to plain red.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the large orange cloth at the top right to purple.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the green saw table to blue.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the red bucket with a metal bucket.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Give the purple cloth large white stars.", "item": "objects"}], "people_visible": 1, "face_box": [0.35879, 0.13414, 0.53995, 0.40576], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Rawpixel via Openverse", "page": "https://www.rawpixel.com/image/8708782/photo-image-public-domain-person-black", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "The African Union Mission in Somalia", "attribution_required": "false"}, "source": {"title": "Young man wood workshop", "page": "https://www.rawpixel.com/image/8708782/photo-image-public-domain-person-black", "image_url": "https://images.rawpixel.com/editor_1024/cHJpdmF0ZS9sci9pbWFnZXMvd2Vic2l0ZS8yMDIyLTExL2ZsNTE2NDQwMzE2MDAtaW1hZ2UuanBn.jpg", "creator": "The African Union Mission in Somalia", "creator_url": null, "original_width": 5760, "original_height": 3840, "found_via": "Openverse search: carpenter workshop"}, "reference_made_by": {"original_size": [1024, 683], "crop_box_px": [0, 0, 1024, 683], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 39.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc49858555", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the pink basket on the left to blue.", "item": "objects"}, {"step": 2, "edit_type": "add", "instruction": "Add a large closed grey plastic box on the platform's left end.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Make the grey box from woven straw.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the woven straw box to yellow.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Give the yellow box a pattern of large red stars.", "item": "objects"}], "people_visible": 1, "face_box": [0.70091, 0.2423, 0.84647, 0.46052], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Tachileik_Myanmar_Kayan-People-Woman-03.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Tachileik Myanmar Kayan-People-Woman-03.jpg", "page": "https://commons.wikimedia.org/wiki/File:Tachileik_Myanmar_Kayan-People-Woman-03.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Tachileik_Myanmar_Kayan-People-Woman-03.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 3914, "original_height": 2810, "found_via": "Openverse search: woman street"}, "reference_made_by": {"original_size": [3914, 2810], "crop_box_px": [0, 0, 3914, 2609], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 44.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc165584587", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the brown shutter behind the women to blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue shutter large white zigzags.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the black metal gate on the right to gold.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the gold gate on the right to white.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole gate on the right.", "item": "objects"}], "people_visible": 2, "face_box": [0.49441, 0.10259, 0.87523, 0.67355], "tags": {"edit_target": ["objects"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:%D0%91%D0%B8%D1%88%D0%BA%D0%B5%D0%BA,_%D0%B2%D0%B8%D0%BA%D0%B8-%D1%84%D0%BE%D1%82%D0%BE%D1%82%D1%80%D0%B5%D0%BD%D0%B8%D0%BD%D0%B3_2025_(31).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Nikolai Bulykin", "attribution_required": "true"}, "source": {"title": "Бишкек, вики-фототренинг 2025 (31).jpg", "page": "https://commons.wikimedia.org/wiki/File:%D0%91%D0%B8%D1%88%D0%BA%D0%B5%D0%BA,_%D0%B2%D0%B8%D0%BA%D0%B8-%D1%84%D0%BE%D1%82%D0%BE%D1%82%D1%80%D0%B5%D0%BD%D0%B8%D0%BD%D0%B3_2025_(31).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/60/%D0%91%D0%B8%D1%88%D0%BA%D0%B5%D0%BA%2C_%D0%B2%D0%B8%D0%BA%D0%B8-%D1%84%D0%BE%D1%82%D0%BE%D1%82%D1%80%D0%B5%D0%BD%D0%B8%D0%BD%D0%B3_2025_%2831%29.jpg", "creator": "Nikolai Bulykin", "creator_url": null, "original_width": 5009, "original_height": 2818, "found_via": "Openverse search: artisan workshop"}, "reference_made_by": {"original_size": [5009, 2818], "crop_box_px": [782, 0, 5009, 2818], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 38.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc36828929", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the broad wooden beam at the top to blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue beam at the top large white dots.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the ball of white yarn at the bottom left to red.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a large blue clay pot on the floor at bottom left.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a large woven straw basket on the floor at bottom right.", "item": "objects"}], "people_visible": 2, "face_box": [0.31783, 0.29673, 0.57972, 0.47141], "tags": {"edit_target": ["objects"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Carpet_makers,_near_Jaipur,_Rajasthan,_India.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Yann Forget", "attribution_required": "true"}, "source": {"title": "Carpet makers, near Jaipur, Rajasthan, India.jpg", "page": "https://commons.wikimedia.org/wiki/File:Carpet_makers,_near_Jaipur,_Rajasthan,_India.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/9f/Carpet_makers%2C_near_Jaipur%2C_Rajasthan%2C_India.jpg", "creator": "Yann Forget", "creator_url": null, "original_width": 2304, "original_height": 3204, "found_via": "Openverse search: craftsman"}, "reference_made_by": {"original_size": [2304, 3204], "crop_box_px": [1, 0, 2137, 3204], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc10677986", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large yellow flower wreath to the panel on the right.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the yellow flower wreath to purple.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Make the purple wreath from large folded paper flowers.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Make the paper flower wreath heart-shaped.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the heart-shaped paper flower wreath.", "item": "objects"}], "people_visible": 3, "face_box": [0.46725, 0.11399, 0.72684, 0.50318], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Royal_Wedding_Stockholm_2010-Slottsbacken-05.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Prolineserver (talk)", "attribution_required": "true"}, "source": {"title": "Royal Wedding Stockholm 2010-Slottsbacken-05.jpg", "page": "https://commons.wikimedia.org/wiki/File:Royal_Wedding_Stockholm_2010-Slottsbacken-05.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/70/Royal_Wedding_Stockholm_2010-Slottsbacken-05.jpg", "creator": "Prolineserver (talk)", "creator_url": null, "original_width": 2156, "original_height": 1524, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2156, 1524], "crop_box_px": [1, 0, 2155, 1436], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "4951796a-8d80-4937-87a6-6c40afae9dae", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change her grey cardigan to green.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the green cardigan large white dots.", "item": "tops_dresses"}, {"step": 3, "edit_type": "add", "instruction": "Add a large brown box on the workbench beneath the shelves.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the brown box's material to clear glass.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole glass box from the workbench.", "item": "objects"}], "people_visible": 1, "face_box": [0.48207, 0.0, 0.85772, 0.5632], "tags": {"edit_target": ["objects", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Rawpixel via Openverse", "page": "https://www.rawpixel.com/image/8736316/ntrc-printing-2014-knoxville", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "usdoe", "attribution_required": "false"}, "source": {"title": "NTRC 3D printing 2014 Knoxville", "page": "https://www.rawpixel.com/image/8736316/ntrc-printing-2014-knoxville", "image_url": "https://images.rawpixel.com/editor_1024/cHJpdmF0ZS9sci9pbWFnZXMvd2Vic2l0ZS8yMDIyLTExL2ZsNTA2NDQ5MTY1OTItaW1hZ2UuanBn.jpg", "creator": "usdoe", "creator_url": null, "original_width": 4288, "original_height": 2848, "found_via": "Openverse search: laboratory scientist"}, "reference_made_by": {"original_size": [1024, 680], "crop_box_px": [2, 0, 1022, 680], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 39.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc86477420", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the round white table to green marble.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the clear book holder to red plastic.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change her blue denim shirt to red.", "item": "tops_dresses"}, {"step": 4, "edit_type": "change", "instruction": "Give the red shirt large white dots.", "item": "tops_dresses"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the black phone from the round table.", "item": "objects"}], "people_visible": 1, "face_box": [0.24596, 0.0, 0.74649, 0.50053], "tags": {"edit_target": ["objects", "tops_dresses"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Miriam_Beizana_Vigo.002_-_Escritora.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Fernando Losada Rodríguez", "attribution_required": "true"}, "source": {"title": "Miriam Beizana Vigo.002 - Escritora.jpg", "page": "https://commons.wikimedia.org/wiki/File:Miriam_Beizana_Vigo.002_-_Escritora.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/7d/Miriam_Beizana_Vigo.002_-_Escritora.jpg", "creator": "Fernando Losada Rodríguez", "creator_url": null, "original_width": 5152, "original_height": 3864, "found_via": "Openverse search: bookshop"}, "reference_made_by": {"original_size": [5152, 3864], "crop_box_px": [869, 0, 4733, 3864], "size": [1024, 1024], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 42.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc46729139", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the stack of open boxes from the table.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the yellow tabletop to white.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Cover the white tabletop with a pattern of large green squares.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a large brown box on the table's right end.", "item": "objects"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the red food tub with a large blue glass bowl.", "item": "objects"}], "people_visible": 2, "face_box": [0.13821, 0.06635, 0.36295, 0.4033], "tags": {"edit_target": ["objects"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-03.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Taipei Taiwan Jiaozi-Restaurant-14th-avenue-03.jpg", "page": "https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-03.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a5/Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-03.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 5124, "original_height": 3660, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [5124, 3660], "crop_box_px": [1, 0, 5123, 3414], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 44.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc133986767", "steps": [{"step": 1, "edit_type": "change", "instruction": "Give the dark brown jar at bottom right large white dots.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the dotted jar's brown colour to green.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the green jar's material to glass.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a white stone bowl on the mat right of the jar.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole green glass jar.", "item": "objects"}], "people_visible": 3, "face_box": [0.23023, 0.01, 0.48256, 0.26233], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Japanese_garden_at_Sch%C3%B6nbrunn_Palace_in_Vienna,_Austria_-_teahouse_Heterotopia_tea_ceremony-whisk_PNr%C2%B01027.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "D-Kuru", "attribution_required": "true"}, "source": {"title": "Japanese garden at Schönbrunn Palace in Vienna, Austria - teahouse Heterotopia tea ceremony-whisk PNr°1027.jpg", "page": "https://commons.wikimedia.org/wiki/File:Japanese_garden_at_Sch%C3%B6nbrunn_Palace_in_Vienna,_Austria_-_teahouse_Heterotopia_tea_ceremony-whisk_PNr%C2%B01027.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/b/bb/Japanese_garden_at_Sch%C3%B6nbrunn_Palace_in_Vienna%2C_Austria_-_teahouse_Heterotopia_tea_ceremony-whisk_PNr%C2%B01027.jpg", "creator": "D-Kuru", "creator_url": null, "original_width": 3300, "original_height": 3648, "found_via": "Openverse search: tea house"}, "reference_made_by": {"original_size": [3300, 3648], "crop_box_px": [26, 399, 3274, 3648], "size": [1024, 1024], "icc_profile": "GIMP built-in sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc107976362", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the red logos and red text on the black wall to green.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the black logo wall to dark blue.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the green bird logo with a green heart.", "item": "text_signs"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the whole round white \"1882\" logo.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Give the dark blue wall large white dots.", "item": "objects"}], "people_visible": 1, "face_box": [0.07949, 0.01178, 0.81833, 0.50458], "tags": {"edit_target": ["objects", "text_signs"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Alexander_Serov_(directeur_sportif_Gazprom)_au_matin_de_la_premi%C3%A8re_%C3%A9tape_du_Tour_de_l%27Ain_2021.jpg", "licence": "CC0", "licence_url": "http://creativecommons.org/publicdomain/zero/1.0/deed.en", "author": "Benoît Prieur", "attribution_required": "false"}, "source": {"title": "Alexander Serov (directeur sportif Gazprom) au matin de la première étape du Tour de l'Ain 2021.jpg", "page": "https://commons.wikimedia.org/wiki/File:Alexander_Serov_(directeur_sportif_Gazprom)_au_matin_de_la_premi%C3%A8re_%C3%A9tape_du_Tour_de_l%27Ain_2021.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a6/Alexander_Serov_%28directeur_sportif_Gazprom%29_au_matin_de_la_premi%C3%A8re_%C3%A9tape_du_Tour_de_l%27Ain_2021.jpg", "creator": "Benoît Prieur", "creator_url": null, "original_width": 2576, "original_height": 3800, "found_via": "Openverse search: cyclist street"}, "reference_made_by": {"original_size": [2576, 3800], "crop_box_px": [21, 0, 2555, 3800], "size": [832, 1248], "icc_profile": "GIMP built-in sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "255d4a22-4470-4638-9128-f10a6ebb503e", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the grey sofa to red.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change both white pillows on the sofa to yellow.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the woman's white cup with a glass of orange juice.", "item": "objects"}, {"step": 4, "edit_type": "remove", "instruction": "Remove both pillows from the sofa.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the white window frames to black.", "item": "objects"}], "people_visible": 2, "face_box": [0.28856, 0.37627, 0.4575, 0.62955], "tags": {"edit_target": ["objects"], "people": ["two"], "face_size": ["medium"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/happy-couple-7HBHYQSHPL", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Senior Living", "attribution_required": "false"}, "source": {"title": "Happy Couple", "page": "https://stocksnap.io/photo/happy-couple-7HBHYQSHPL", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/7HBHYQSHPL.jpg", "creator": "Senior Living", "creator_url": "https://stocksnap.io/author/148922", "original_width": 5760, "original_height": 3840, "found_via": "Openverse search: woman reading book"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 39.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc113139332", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the long black table in front of the men to red.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the red table's material to glass.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the glass table with a long white marble table.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the white marble table to green.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole table in front of the men.", "item": "objects"}], "people_visible": 3, "face_box": [0.7818, 0.12801, 0.96235, 0.3987], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:2021-12-07_Unterzeichnung_des_Koalitionsvertrages_der_20._Wahlperiode_des_Bundestages_by_Sandro_Halank%E2%80%93016.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Sandro Halank, Wikimedia Commons", "attribution_required": "true"}, "source": {"title": "2021-12-07 Unterzeichnung des Koalitionsvertrages der 20. Wahlperiode des Bundestages by Sandro Halank–016.jpg", "page": "https://commons.wikimedia.org/wiki/File:2021-12-07_Unterzeichnung_des_Koalitionsvertrages_der_20._Wahlperiode_des_Bundestages_by_Sandro_Halank%E2%80%93016.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/83/2021-12-07_Unterzeichnung_des_Koalitionsvertrages_der_20._Wahlperiode_des_Bundestages_by_Sandro_Halank%E2%80%93016.jpg", "creator": "Sandro Halank, Wikimedia Commons", "creator_url": null, "original_width": 5333, "original_height": 2457, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [5333, 2457], "crop_box_px": [1250, 0, 4933, 2456], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 42.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc64787263", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the blue watering can on the brick wall to yellow.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the wooden chair holding the books to white marble.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the round tan pot holding the small cactus to blue.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Give the yellow watering can a pattern of large red dots.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the black box on the post at the left to red.", "item": "objects"}], "people_visible": 1, "face_box": [0.51872, 0.0, 0.73729, 0.3277], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Adrian_Horridge_FRS.jpg", "licence": "CC BY 4.0", "licence_url": "https://creativecommons.org/licenses/by/4.0", "author": "Thennicke", "attribution_required": "true"}, "source": {"title": "Adrian Horridge FRS.jpg", "page": "https://commons.wikimedia.org/wiki/File:Adrian_Horridge_FRS.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/b/bd/Adrian_Horridge_FRS.jpg", "creator": "Thennicke", "creator_url": null, "original_width": 5794, "original_height": 3868, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [5794, 3868], "crop_box_px": [1, 3, 5793, 3865], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 34.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc34012281", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the red frame of the lattice window to blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the red plaid scarf at the top large white dots.", "item": "scarves_ties_collars_badges"}, {"step": 3, "edit_type": "remove", "instruction": "Remove the grey plaid scarf hanging above the window.", "item": "scarves_ties_collars_badges"}, {"step": 4, "edit_type": "change", "instruction": "Change the window lattice to gold.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a large woven straw basket on the front wooden ledge, far left.", "item": "objects"}], "people_visible": 1, "face_box": [0.37782, 0.32633, 0.50415, 0.51574], "tags": {"edit_target": ["objects", "scarves_ties_collars_badges"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Lijiang_Yunnan_China-Woman-with-weaving-loom-01.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Lijiang Yunnan China-Woman-with-weaving-loom-01.jpg", "page": "https://commons.wikimedia.org/wiki/File:Lijiang_Yunnan_China-Woman-with-weaving-loom-01.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a0/Lijiang_Yunnan_China-Woman-with-weaving-loom-01.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 4026, "original_height": 2684, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4026, 2684], "crop_box_px": [0, 0, 4026, 2684], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc110020721", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the wheel from the wall.", "item": "objects"}, {"step": 2, "edit_type": "add", "instruction": "Add a large orange plastic bin on the gravel at bottom right.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the orange bin to grey.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Give the grey bin a pattern of white dots.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole bin at bottom right.", "item": "objects"}], "people_visible": 5, "face_box": [0.16864, 0.0576, 0.40949, 0.29845], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Michelin_at_IAA_2021_1X7A0161.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Alexander Migl", "attribution_required": "true"}, "source": {"title": "Michelin at IAA 2021 1X7A0161.jpg", "page": "https://commons.wikimedia.org/wiki/File:Michelin_at_IAA_2021_1X7A0161.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/5/58/Michelin_at_IAA_2021_1X7A0161.jpg", "creator": "Alexander Migl", "creator_url": null, "original_width": 3920, "original_height": 3920, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3920, 3920], "crop_box_px": [0, 0, 3920, 3920], "size": [1024, 1024], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc34473676", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the round tent's white fabric to blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the tent's blue fabric to a blue and white checkerboard pattern.", "item": "objects"}, {"step": 3, "edit_type": "add", "instruction": "Add a large red bench on the grass right of the robed man.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the red bench with a large green stone bench.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole stone bench from the grass.", "item": "objects"}], "people_visible": 2, "face_box": [0.15587, 0.42361, 0.4187, 0.59892], "tags": {"edit_target": ["objects"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Mnich_buddyjski_w_klasztorze_Erdene_Dzuu.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Marcin Konsek", "attribution_required": "true"}, "source": {"title": "Mnich buddyjski w klasztorze Erdene Dzuu.jpg", "page": "https://commons.wikimedia.org/wiki/File:Mnich_buddyjski_w_klasztorze_Erdene_Dzuu.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/89/Mnich_buddyjski_w_klasztorze_Erdene_Dzuu.jpg", "creator": "Marcin Konsek", "creator_url": null, "original_width": 2051, "original_height": 3076, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2051, 3076], "crop_box_px": [0, 0, 2051, 3076], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc53784969", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the grey metal shutters to green.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the upturned hat on the wire stand large white dots.", "item": "hair_headwear_glasses"}, {"step": 3, "edit_type": "add", "instruction": "Add a large blue plastic box on the pavement, bottom left.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Give the blue box a pattern of large yellow stars.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole blue box at bottom left.", "item": "objects"}], "people_visible": 2, "face_box": [0.34228, 0.07035, 0.64098, 0.26957], "tags": {"edit_target": ["hair_headwear_glasses", "objects"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Nordest_music_in_Avenida_Paulista,_S%C3%A3o_Paulo,_Brazil.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Wilfredor", "attribution_required": "true"}, "source": {"title": "Nordest music in Avenida Paulista, São Paulo, Brazil.jpg", "page": "https://commons.wikimedia.org/wiki/File:Nordest_music_in_Avenida_Paulista,_S%C3%A3o_Paulo,_Brazil.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/0/03/Nordest_music_in_Avenida_Paulista%2C_S%C3%A3o_Paulo%2C_Brazil.jpg", "creator": "Wilfredor", "creator_url": null, "original_width": 2848, "original_height": 3543, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2848, 3543], "crop_box_px": [203, 0, 2565, 3543], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc4695242", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the gold figure on the far left to blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue figure on the far left white stars.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the figure on the far left to glass.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the glass figure on the far left to green.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole figure on the far left.", "item": "objects"}], "people_visible": 1, "face_box": [0.43371, 0.3869, 0.57096, 0.59268], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:NRWTag_W_Sonnborn_40_ies.jpg", "licence": "CC BY-SA 3.0", "licence_url": "http://creativecommons.org/licenses/by-sa/3.0/", "author": "Frank Vincentz", "attribution_required": "true"}, "source": {"title": "NRWTag W Sonnborn 40 ies.jpg", "page": "https://commons.wikimedia.org/wiki/File:NRWTag_W_Sonnborn_40_ies.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/99/NRWTag_W_Sonnborn_40_ies.jpg", "creator": "Frank Vincentz", "creator_url": null, "original_width": 3888, "original_height": 2592, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3888, 2592], "crop_box_px": [0, 0, 3888, 2592], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 42.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc69984498", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the grey stone counter to white marble.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the yellow backpack to red.", "item": "bags"}, {"step": 3, "edit_type": "remove", "instruction": "Remove the two hanging moss plants at the top left.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a white coffee mug on the counter's right end.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Give the red backpack large white dots.", "item": "bags"}], "people_visible": 4, "face_box": [0.45244, 0.08513, 0.63133, 0.35333], "tags": {"edit_target": ["bags", "objects"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:OutDoor_2018,_Friedrichshafen_(1X7A9907).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Matti Blume", "attribution_required": "true"}, "source": {"title": "OutDoor 2018, Friedrichshafen (1X7A9907).jpg", "page": "https://commons.wikimedia.org/wiki/File:OutDoor_2018,_Friedrichshafen_(1X7A9907).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/ab/OutDoor_2018%2C_Friedrichshafen_%281X7A9907%29.jpg", "creator": "Matti Blume", "creator_url": null, "original_width": 6720, "original_height": 4480, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [6720, 4480], "crop_box_px": [0, 0, 6720, 4480], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc37097845", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the white umbrella behind the men to orange.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the orange umbrella a pattern of large purple triangles.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the triangle-patterned umbrella with a large plain green umbrella.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a large yellow flag on the red roof on the right.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole umbrella behind the men.", "item": "objects"}], "people_visible": 18, "face_box": [0.77966, 0.19379, 1.0, 0.52414], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Penampang_Sabah_Dignitaries-at-_Kaamatan-Celebrations-2014-01.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Penampang Sabah Dignitaries-at- Kaamatan-Celebrations-2014-01.jpg", "page": "https://commons.wikimedia.org/wiki/File:Penampang_Sabah_Dignitaries-at-_Kaamatan-Celebrations-2014-01.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a4/Penampang_Sabah_Dignitaries-at-_Kaamatan-Celebrations-2014-01.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 4228, "original_height": 2054, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4228, 2054], "crop_box_px": [1035, 1, 4113, 2053], "size": [1248, 832], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 27.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc40165063", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the white globe lamp with a square glass lantern.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Make the thatched roof on the right bright purple.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the white ALTEL banner below the lamp to yellow.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the letters on the yellow ALTEL banner to red.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Give the purple thatched roof large white stars.", "item": "objects"}], "people_visible": 13, "face_box": [0.63962, 0.36205, 0.87338, 0.71252], "tags": {"edit_target": ["objects", "text_signs"], "people": ["three_or_more"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Penampang_Sabah_Dignitaries-at-_Kaamatan-Celebrations-2014-03.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Penampang Sabah Dignitaries-at- Kaamatan-Celebrations-2014-03.jpg", "page": "https://commons.wikimedia.org/wiki/File:Penampang_Sabah_Dignitaries-at-_Kaamatan-Celebrations-2014-03.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/cd/Penampang_Sabah_Dignitaries-at-_Kaamatan-Celebrations-2014-03.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 4872, "original_height": 3765, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4872, 3765], "crop_box_px": [1, 0, 4871, 3247], "size": [1248, 832], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 28.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc42363328", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the patterned handbag at bottom right to plain red.", "item": "bags"}, {"step": 2, "edit_type": "change", "instruction": "Give the red handbag large white dots.", "item": "bags"}, {"step": 3, "edit_type": "remove", "instruction": "Remove the man's whole wristwatch.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "change", "instruction": "Change the white rope at the bottom to blue.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a large yellow balloon above the man's cap.", "item": "objects"}], "people_visible": 4, "face_box": [0.36576, 0.20286, 0.63376, 0.38161], "tags": {"edit_target": ["bags", "jewellery_watches", "objects"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Regatta-Lepa-2015-06.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Semporna Sabah Regatta-Lepa-2015-06.jpg", "page": "https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Regatta-Lepa-2015-06.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/8/8a/Semporna_Sabah_Regatta-Lepa-2015-06.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 3840, "original_height": 5760, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3840, 5760], "crop_box_px": [0, 0, 3840, 5760], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 50.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc37669146", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the yellow phone to red.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the wooden phone shelter to blue.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the blue shelter large white stars.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the shelter's roof to green.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the silver panel on the red phone to gold.", "item": "objects"}], "people_visible": 1, "face_box": [0.10842, 0.29604, 0.40158, 0.5892], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Shilin_Yunnan_China_Shilin-Stone-Forest-09.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Shilin Yunnan China Shilin-Stone-Forest-09.jpg", "page": "https://commons.wikimedia.org/wiki/File:Shilin_Yunnan_China_Shilin-Stone-Forest-09.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/64/Shilin_Yunnan_China_Shilin-Stone-Forest-09.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 2149, "original_height": 2149, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2149, 2149], "crop_box_px": [0, 0, 2149, 2149], "size": [1024, 1024], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 33.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc38863393", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the bright red bag with a brown pocket to blue.", "item": "bags"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue handbag on the middle shelf large white dots.", "item": "bags"}, {"step": 3, "edit_type": "change", "instruction": "Change the lime green handbag at the top right to purple.", "item": "bags"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the black top-shelf bag with a woven straw bag.", "item": "bags"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the black clutch bag on the right shelf.", "item": "bags"}], "people_visible": 2, "face_box": [0.10139, 0.24512, 0.25176, 0.47056], "tags": {"edit_target": ["bags"], "people": ["two"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Yogyakarta_Indonesia_Gamelan-players-with-gend%C3%A8r-01.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Yogyakarta Indonesia Gamelan-players-with-gendèr-01.jpg", "page": "https://commons.wikimedia.org/wiki/File:Yogyakarta_Indonesia_Gamelan-players-with-gend%C3%A8r-01.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e0/Yogyakarta_Indonesia_Gamelan-players-with-gend%C3%A8r-01.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 4408, "original_height": 2711, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4408, 2711], "crop_box_px": [345, 1, 4408, 2710], "size": [1248, 832], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 30.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc29965788", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the brown wall to blue.", "item": "objects"}, {"step": 2, "edit_type": "add", "instruction": "Add a large blank yellow sign high on the left wall.", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Give the yellow sign large black zigzags.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the zigzag sign's material to white marble.", "item": "text_signs"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the zigzag sign from the wall.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.14202, 0.30047, 0.8823, 0.79423], "tags": {"edit_target": ["objects", "text_signs"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Jaisalmer-Citadel-06-Peacock_fan_merchant-20131010.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Daniel VILLAFRUELA.", "attribution_required": "true"}, "source": {"title": "Jaisalmer-Citadel-06-Peacock fan merchant-20131010.jpg", "page": "https://commons.wikimedia.org/wiki/File:Jaisalmer-Citadel-06-Peacock_fan_merchant-20131010.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/98/Jaisalmer-Citadel-06-Peacock_fan_merchant-20131010.jpg", "creator": "Daniel VILLAFRUELA.", "creator_url": null, "original_width": 3247, "original_height": 4871, "found_via": "Openverse search: vendor"}, "reference_made_by": {"original_size": [3247, 4871], "crop_box_px": [0, 0, 3247, 4871], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc85705501", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the striped cloth bundle on the left to plain blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the yellow flower garland on the blue cloth to white.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the metal milk can on the right ledge to red.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Give the red milk can small white stars.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a white teapot on the ledge beside the red can.", "item": "objects"}], "people_visible": 1, "face_box": [0.49367, 0.20853, 0.66449, 0.46465], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:20191206_Uliczny_grajek_w_Udajpurze_1215_6822_DxO.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Jakub Hałun", "attribution_required": "true"}, "source": {"title": "20191206 Uliczny grajek w Udajpurze 1215 6822 DxO.jpg", "page": "https://commons.wikimedia.org/wiki/File:20191206_Uliczny_grajek_w_Udajpurze_1215_6822_DxO.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/92/20191206_Uliczny_grajek_w_Udajpurze_1215_6822_DxO.jpg", "creator": "Jakub Hałun", "creator_url": null, "original_width": 5420, "original_height": 3604, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [5420, 3604], "crop_box_px": [7, 0, 5413, 3604], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc91421474", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the whole white \"sing for hope\" sign from the piano.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the colourful piano to plain purple.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the purple piano large white stars.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the silver post on the right to red.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a large plant in a white pot by the red post.", "item": "objects"}], "people_visible": 3, "face_box": [0.51532, 0.19294, 0.82001, 0.39617], "tags": {"edit_target": ["objects", "text_signs"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Jon_Batiste_in_Brooklyn_Juneteenth_2020_(94060).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Rhododendrites", "attribution_required": "true"}, "source": {"title": "Jon Batiste in Brooklyn Juneteenth 2020 (94060).jpg", "page": "https://commons.wikimedia.org/wiki/File:Jon_Batiste_in_Brooklyn_Juneteenth_2020_(94060).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/d/d7/Jon_Batiste_in_Brooklyn_Juneteenth_2020_%2894060%29.jpg", "creator": "Rhododendrites", "creator_url": null, "original_width": 2775, "original_height": 3456, "found_via": "Openverse search: street musician"}, "reference_made_by": {"original_size": [2775, 3456], "crop_box_px": [295, 0, 2599, 3456], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc164201681", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large blue plastic box on the grass at bottom left.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue box a pattern of large white dots.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the dotted box from blue to yellow.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the yellow box with a large woven straw basket.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole straw basket at bottom left.", "item": "objects"}], "people_visible": 2, "face_box": [0.51576, 0.19036, 0.72178, 0.49924], "tags": {"edit_target": ["objects"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Farmer_at_harvest.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Photobyamin", "attribution_required": "true"}, "source": {"title": "Farmer at harvest.jpg", "page": "https://commons.wikimedia.org/wiki/File:Farmer_at_harvest.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/0/0b/Farmer_at_harvest.jpg", "creator": "Photobyamin", "creator_url": null, "original_width": 2646, "original_height": 1764, "found_via": "Openverse search: farmer"}, "reference_made_by": {"original_size": [2646, 1764], "crop_box_px": [0, 0, 2646, 1764], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc77740619", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large woven straw basket on the plants at bottom right.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the straw basket to blue.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the blue basket a pattern of white zigzags.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the thick tree trunk beside the woman to white.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole basket at bottom right.", "item": "objects"}], "people_visible": 1, "face_box": [0.38228, 0.17738, 0.76196, 0.43062], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Woman_harvesting_tea,_West_Bengal.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Bernard Gagnon", "attribution_required": "true"}, "source": {"title": "Woman harvesting tea, West Bengal.jpg", "page": "https://commons.wikimedia.org/wiki/File:Woman_harvesting_tea,_West_Bengal.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/f/f0/Woman_harvesting_tea%2C_West_Bengal.jpg", "creator": "Bernard Gagnon", "creator_url": null, "original_width": 1889, "original_height": 2838, "found_via": "Openverse search: woman street"}, "reference_made_by": {"original_size": [1889, 2838], "crop_box_px": [0, 2, 1889, 2836], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 41.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc87211151", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the dark wooden bucket on the left to red.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the light wooden bucket on the right large green dots.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the wooden carrying pole to bright blue.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a large woven straw basket on the path at bottom right.", "item": "objects"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the red bucket with a metal bucket.", "item": "objects"}], "people_visible": 1, "face_box": [0.45001, 0.22209, 0.57576, 0.41063], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:The_water_transfer.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Mikhail Kapychka", "attribution_required": "true"}, "source": {"title": "The water transfer.jpg", "page": "https://commons.wikimedia.org/wiki/File:The_water_transfer.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/aa/The_water_transfer.jpg", "creator": "Mikhail Kapychka", "creator_url": null, "original_width": 5214, "original_height": 3476, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [5214, 3476], "crop_box_px": [0, 0, 5214, 3476], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 38.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc36791367", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the left bookshelf to green.", "item": "objects"}, {"step": 2, "edit_type": "add", "instruction": "Add a large round clock on the wall above the woman.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the clock face a pattern of large blue dots.", "item": "objects"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the clock from the wall.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the right bookshelf's material to white plastic.", "item": "objects"}], "people_visible": 1, "face_box": [0.39239, 0.23626, 0.54367, 0.46307], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:PersonaMardel.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Ezarate", "attribution_required": "true"}, "source": {"title": "PersonaMardel.jpg", "page": "https://commons.wikimedia.org/wiki/File:PersonaMardel.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/3/3c/PersonaMardel.jpg", "creator": "Ezarate", "creator_url": null, "original_width": 4608, "original_height": 3456, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [4608, 3456], "crop_box_px": [0, 0, 4608, 3072], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 43.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc45077428", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the large round flask at the front to blue glass.", "item": "objects"}, {"step": 2, "edit_type": "remove", "instruction": "Remove the wall screen on the left.", "item": "objects"}, {"step": 3, "edit_type": "add", "instruction": "Add a large closed grey bin on the floor at right.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Give the grey bin a pattern of white dots.", "item": "objects"}, {"step": 5, "edit_type": "replace", "instruction": "Replace the blue flask with a large blue glass bottle.", "item": "objects"}], "people_visible": 1, "face_box": [0.6541, 0.29286, 0.81244, 0.53026], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:D%C3%B6n%C3%BC%C5%9F_Tuncel_(Donus_Tuncel)_-_In_the_Lab.JPG", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Yigit Altay", "attribution_required": "true"}, "source": {"title": "Dönüş Tuncel (Donus Tuncel) - In the Lab.JPG", "page": "https://commons.wikimedia.org/wiki/File:D%C3%B6n%C3%BC%C5%9F_Tuncel_(Donus_Tuncel)_-_In_the_Lab.JPG", "image_url": "https://upload.wikimedia.org/wikipedia/commons/b/b4/D%C3%B6n%C3%BC%C5%9F_Tuncel_%28Donus_Tuncel%29_-_In_the_Lab.JPG", "creator": "Yigit Altay", "creator_url": null, "original_width": 2851, "original_height": 1901, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [2851, 1901], "crop_box_px": [0, 0, 2851, 1901], "size": [1248, 832], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 33.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc34178099", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the large speaker at the bottom right to blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue speaker at the bottom right large white dots.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the large bass drum at the front to red.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the drummer's brown vest with a plain grey wool vest.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Give the red bass drum at the front large yellow stars.", "item": "objects"}], "people_visible": 1, "face_box": [0.52221, 0.15856, 0.64881, 0.34837], "tags": {"edit_target": ["objects", "tops_dresses"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:EmanuelHarrold.JPG", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Eric Magnan", "attribution_required": "true"}, "source": {"title": "EmanuelHarrold.JPG", "page": "https://commons.wikimedia.org/wiki/File:EmanuelHarrold.JPG", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a3/EmanuelHarrold.JPG", "creator": "Eric Magnan", "creator_url": null, "original_width": 3308, "original_height": 2304, "found_via": "Openverse search: drummer"}, "reference_made_by": {"original_size": [3308, 2304], "crop_box_px": [1, 0, 3307, 2204], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 49.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc171925289", "steps": [{"step": 1, "edit_type": "remove", "instruction": "Remove the whole cymbal on the left.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the black speaker a large purple and green checkerboard pattern.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the checkerboard speaker with a large round speaker.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the microphone on the right to red.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the yellow \"NMTB\" letters on the drum to green.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.24224, 0.13622, 0.76382, 0.48411], "tags": {"edit_target": ["objects", "text_signs"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Paul_Cook_-_Sex_Pistols_2025-2.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Birgit Fostervold", "attribution_required": "true"}, "source": {"title": "Paul Cook - Sex Pistols 2025-2.jpg", "page": "https://commons.wikimedia.org/wiki/File:Paul_Cook_-_Sex_Pistols_2025-2.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e3/Paul_Cook_-_Sex_Pistols_2025-2.jpg", "creator": "Birgit Fostervold", "creator_url": null, "original_width": 2176, "original_height": 2720, "found_via": "Openverse search: drummer"}, "reference_made_by": {"original_size": [2176, 2720], "crop_box_px": [295, 0, 2108, 2720], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc50359073", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the black speaker at front right to red.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the red speaker a pattern of white stars.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the front-right speaker with a large white speaker.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a large green plastic bottle on the front-left speaker.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the bottle on the front-left speaker.", "item": "objects"}], "people_visible": 9, "face_box": [0.4679, 0.08709, 0.59326, 0.27502], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:20160607_Berlin_Volbeat_Volbeat_0393.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "© Markus Felix | PushingPixels (contact me)", "attribution_required": "true"}, "source": {"title": "20160607 Berlin Volbeat Volbeat 0393.jpg", "page": "https://commons.wikimedia.org/wiki/File:20160607_Berlin_Volbeat_Volbeat_0393.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/c5/20160607_Berlin_Volbeat_Volbeat_0393.jpg", "creator": "© Markus Felix | PushingPixels (contact me)", "creator_url": null, "original_width": 3454, "original_height": 2299, "found_via": "Openverse search: woman musician"}, "reference_made_by": {"original_size": [3454, 2299], "crop_box_px": [3, 0, 3451, 2299], "size": [1248, 832], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 27.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc15690652", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the blue banner at the top left to orange.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the orange banner large white stars.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the blue drums behind the keyboard to green.", "item": "objects"}, {"step": 4, "edit_type": "remove", "instruction": "Remove the whole black guitar bag on the right.", "item": "bags"}, {"step": 5, "edit_type": "add", "instruction": "Add a white water bottle on the keyboard's right end.", "item": "objects"}], "people_visible": 1, "face_box": [0.4009, 0.11477, 0.56157, 0.35567], "tags": {"edit_target": ["bags", "objects"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Valdi_Totev.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "MrPanyGoff", "attribution_required": "true"}, "source": {"title": "Valdi Totev.jpg", "page": "https://commons.wikimedia.org/wiki/File:Valdi_Totev.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/77/Valdi_Totev.jpg", "creator": "MrPanyGoff", "creator_url": null, "original_width": 2548, "original_height": 1696, "found_via": "Openverse search: woman musician"}, "reference_made_by": {"original_size": [2548, 1696], "crop_box_px": [2, 0, 2546, 1696], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.9, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc87403339", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the dark brown shelves to green.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the pale green jar on the far left to blue.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the blue jar a pattern of large white dots.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the clear bowl on the counter with a large red bowl.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the white plastic bag on the far left.", "item": "bags"}], "people_visible": 2, "face_box": [0.53837, 0.25155, 0.71883, 0.52211], "tags": {"edit_target": ["bags", "objects"], "people": ["two"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Yuyuan_Garden_3.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "kallerna", "attribution_required": "true"}, "source": {"title": "Yuyuan Garden 3.jpg", "page": "https://commons.wikimedia.org/wiki/File:Yuyuan_Garden_3.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/6e/Yuyuan_Garden_3.jpg", "creator": "kallerna", "creator_url": null, "original_width": 3645, "original_height": 2650, "found_via": "Openverse search: street food"}, "reference_made_by": {"original_size": [3645, 2650], "crop_box_px": [0, 110, 3645, 2540], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 51.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc118282429", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the centre rib slab on the grill with a large steak.", "item": "objects"}, {"step": 2, "edit_type": "add", "instruction": "Add three corn cobs on the bare grill bars at the front.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change both pairs of tongs to red.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the woman's black headband to red.", "item": "hair_headwear_glasses"}, {"step": 5, "edit_type": "change", "instruction": "Change the black grill bars to shiny silver.", "item": "objects"}], "people_visible": 2, "face_box": [0.38815, 0.07269, 0.61014, 0.40551], "tags": {"edit_target": ["hair_headwear_glasses", "objects"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Ribfest_in_Toronto_(Dundas_Square,_May_21,_2022)_(2).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Maksim Sokolov (maxergon.com)", "attribution_required": "true"}, "source": {"title": "Ribfest in Toronto (Dundas Square, May 21, 2022) (2).jpg", "page": "https://commons.wikimedia.org/wiki/File:Ribfest_in_Toronto_(Dundas_Square,_May_21,_2022)_(2).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/f/f8/Ribfest_in_Toronto_%28Dundas_Square%2C_May_21%2C_2022%29_%282%29.jpg", "creator": "Maksim Sokolov (maxergon.com)", "creator_url": null, "original_width": 6604, "original_height": 4183, "found_via": "Openverse search: street food"}, "reference_made_by": {"original_size": [6604, 4183], "crop_box_px": [123, 0, 6398, 4183], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 44.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc149960906", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the hanging earring board to blue.", "item": "objects"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the knitted brown toy dog with a white teddy bear.", "item": "objects"}, {"step": 3, "edit_type": "add", "instruction": "Add a large round clock to the tent wall on the right.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the clock's frame to gold.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the orange bag on the far right to purple.", "item": "bags"}], "people_visible": 2, "face_box": [0.45825, 0.13156, 0.59645, 0.33875], "tags": {"edit_target": ["bags", "objects"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Les_Cuirs_d%27Agathe_(DSC04126).jpg", "licence": "CC BY 4.0", "licence_url": "https://creativecommons.org/licenses/by/4.0", "author": "Trougnouf (Benoit Brummer)", "attribution_required": "true"}, "source": {"title": "Les Cuirs d'Agathe (DSC04126).jpg", "page": "https://commons.wikimedia.org/wiki/File:Les_Cuirs_d%27Agathe_(DSC04126).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a8/Les_Cuirs_d%27Agathe_%28DSC04126%29.jpg", "creator": "Trougnouf (Benoit Brummer)", "creator_url": null, "original_width": 5714, "original_height": 2839, "found_via": "Openverse search: market stall"}, "reference_made_by": {"original_size": [5714, 2839], "crop_box_px": [1454, 0, 5712, 2839], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 38.1, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc89022757", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the bus's white body below the windshield to blue.", "item": "objects"}, {"step": 2, "edit_type": "replace", "instruction": "Replace the left side mirror with a large round mirror.", "item": "objects"}, {"step": 3, "edit_type": "remove", "instruction": "Remove the windshield wipers.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a large yellow light on the bus roof above the windshield.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the white bottle in the engine area to red.", "item": "objects"}], "people_visible": 10, "face_box": [0.18613, 0.38483, 0.31543, 0.57868], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:%D8%AD%D8%A7%D9%81%D9%84%D8%A9_%D9%86%D9%82%D9%84_%D8%AD%D8%B6%D8%B1%D9%8A.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Sofiane mohammed amri", "attribution_required": "true"}, "source": {"title": "حافلة نقل حضري.jpg", "page": "https://commons.wikimedia.org/wiki/File:%D8%AD%D8%A7%D9%81%D9%84%D8%A9_%D9%86%D9%82%D9%84_%D8%AD%D8%B6%D8%B1%D9%8A.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/e8/%D8%AD%D8%A7%D9%81%D9%84%D8%A9_%D9%86%D9%82%D9%84_%D8%AD%D8%B6%D8%B1%D9%8A.jpg", "creator": "Sofiane mohammed amri", "creator_url": null, "original_width": 5343, "original_height": 3562, "found_via": "Openverse search: bus driver"}, "reference_made_by": {"original_size": [5343, 3562], "crop_box_px": [0, 0, 5343, 3562], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 41.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc135875647", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large blue plastic bucket on the flat right-hand rock.", "item": "objects"}, {"step": 2, "edit_type": "remove", "instruction": "Remove the umbrella.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the blue bucket a pattern of white dots.", "item": "objects"}, {"step": 4, "edit_type": "replace", "instruction": "Replace the bucket with a larger red plastic bucket.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the red bucket to yellow.", "item": "objects"}], "people_visible": 1, "face_box": [0.28881, 0.08003, 0.43386, 0.2975], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Sumitra_Devi,_a_Garhwali_shepherd_near_Lansdowne,_Uttarakhand_01.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Satdeep Gill", "attribution_required": "true"}, "source": {"title": "Sumitra Devi, a Garhwali shepherd near Lansdowne, Uttarakhand 01.jpg", "page": "https://commons.wikimedia.org/wiki/File:Sumitra_Devi,_a_Garhwali_shepherd_near_Lansdowne,_Uttarakhand_01.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/7d/Sumitra_Devi%2C_a_Garhwali_shepherd_near_Lansdowne%2C_Uttarakhand_01.jpg", "creator": "Satdeep Gill", "creator_url": null, "original_width": 6878, "original_height": 4588, "found_via": "Openverse search: shepherd"}, "reference_made_by": {"original_size": [6878, 4588], "crop_box_px": [0, 0, 6878, 4586], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 35.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc122361298", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the purple fluffy strip behind the men to green.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the white Snapchat sign at top left to blue.", "item": "text_signs"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the right man's gold wristwatch with a black wristwatch.", "item": "jewellery_watches"}, {"step": 4, "edit_type": "add", "instruction": "Hang a large round clock above the men's heads.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Give the green fluffy strip large white dots.", "item": "objects"}], "people_visible": 2, "face_box": [0.29965, 0.14962, 0.45808, 0.38716], "tags": {"edit_target": ["jewellery_watches", "objects", "text_signs"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Hookah_shop_owners_in_Ramallah,_Palestine_(DSC03509).jpg", "licence": "CC BY 4.0", "licence_url": "https://creativecommons.org/licenses/by/4.0", "author": "Trougnouf (Benoit Brummer)", "attribution_required": "true"}, "source": {"title": "Hookah shop owners in Ramallah, Palestine (DSC03509).jpg", "page": "https://commons.wikimedia.org/wiki/File:Hookah_shop_owners_in_Ramallah,_Palestine_(DSC03509).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/75/Hookah_shop_owners_in_Ramallah%2C_Palestine_%28DSC03509%29.jpg", "creator": "Trougnouf (Benoit Brummer)", "creator_url": null, "original_width": 4426, "original_height": 3400, "found_via": "Openverse search: shop owner"}, "reference_made_by": {"original_size": [4426, 3400], "crop_box_px": [0, 1, 4426, 2952], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 41.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc41090507", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the red stool in front to blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the blue stool a pattern of large white dots.", "item": "objects"}, {"step": 3, "edit_type": "add", "instruction": "Add a yellow plastic box on the ground right of the stool.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the man's red T-shirt to yellow.", "item": "tops_dresses"}, {"step": 5, "edit_type": "change", "instruction": "Change the black sewing machine to white.", "item": "objects"}], "people_visible": 1, "face_box": [0.3537, 0.04416, 0.60276, 0.21029], "tags": {"edit_target": ["objects", "tops_dresses"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Jakarta_Indonesia_Hawkers-in-_Glodok-05.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Jakarta Indonesia Hawkers-in- Glodok-05.jpg", "page": "https://commons.wikimedia.org/wiki/File:Jakarta_Indonesia_Hawkers-in-_Glodok-05.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/a/a9/Jakarta_Indonesia_Hawkers-in-_Glodok-05.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 3073, "original_height": 4610, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3073, 4610], "crop_box_px": [0, 0, 3073, 4610], "size": [832, 1248], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 30.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc62210997", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the cardboard box to green.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Give the green box a pattern of large yellow dots.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the patterned box with a large red plastic box.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the red box's material to clear glass.", "item": "objects"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole clear glass box behind the woman.", "item": "objects"}], "people_visible": 1, "face_box": [0.34838, 0.22333, 0.71031, 0.46473], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:20160807_spice_merchant_Nyaung_Shwe_Myanmar_8916_DxO.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Jakub Hałun", "attribution_required": "true"}, "source": {"title": "20160807 spice merchant Nyaung Shwe Myanmar 8916 DxO.jpg", "page": "https://commons.wikimedia.org/wiki/File:20160807_spice_merchant_Nyaung_Shwe_Myanmar_8916_DxO.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/f/f6/20160807_spice_merchant_Nyaung_Shwe_Myanmar_8916_DxO.jpg", "creator": "Jakub Hałun", "creator_url": null, "original_width": 2641, "original_height": 3987, "found_via": "Openverse search: vendor"}, "reference_made_by": {"original_size": [2641, 3987], "crop_box_px": [0, 13, 2641, 3974], "size": [832, 1248], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "40f1c4c5-b84c-42a0-a81d-ae528001bd7c", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the silver laptop on the table to red.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the small white plant pot on the right to blue.", "item": "objects"}, {"step": 3, "edit_type": "replace", "instruction": "Replace the small plant in the blue pot with a tall cactus.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Give the red laptop a pattern of white dots.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a yellow coffee mug beside the red laptop.", "item": "objects"}], "people_visible": 3, "face_box": [0.45221, 0.11837, 0.62506, 0.3775], "tags": {"edit_target": ["objects"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/diverse-workplace-UJ1P4WLT4N", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Direct Media", "attribution_required": "false"}, "source": {"title": "Diverse Workplace", "page": "https://stocksnap.io/photo/diverse-workplace-UJ1P4WLT4N", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/UJ1P4WLT4N.jpg", "creator": "Direct Media", "creator_url": "https://stocksnap.io/author/145556", "original_width": 6720, "original_height": 4480, "found_via": "Openverse search: woman working laptop office"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 41.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc46729207", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the yellow stripe on the wall to blue.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the red tub of filling on the left to white.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Give the white tub a pattern of large blue dots.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Change the black chopstick box on the nearer table to red.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a large round white clock on the wall, top left.", "item": "objects"}], "people_visible": 1, "face_box": [0.52159, 0.21015, 0.8651, 0.43927], "tags": {"edit_target": ["objects"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-04.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Taipei Taiwan Jiaozi-Restaurant-14th-avenue-04.jpg", "page": "https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-04.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/1/19/Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-04.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 3653, "original_height": 5114, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [3653, 5114], "crop_box_px": [216, 0, 3625, 5114], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 50.6, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc24879813", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large round green plastic bin on the street, bottom right.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the green bin to grey.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the grey bin's material to gold metal.", "item": "objects"}, {"step": 4, "edit_type": "change", "instruction": "Give the gold bin a pattern of white dots.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the white \"MUHAMETI\" sign at top right to yellow.", "item": "text_signs"}], "people_visible": 3, "face_box": [0.15497, 0.0, 0.31978, 0.2471], "tags": {"edit_target": ["objects", "text_signs"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Pristina_Bazaar_February_2013_02.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Arild Vågen", "attribution_required": "true"}, "source": {"title": "Pristina Bazaar February 2013 02.jpg", "page": "https://commons.wikimedia.org/wiki/File:Pristina_Bazaar_February_2013_02.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/ce/Pristina_Bazaar_February_2013_02.jpg", "creator": "Arild Vågen", "creator_url": null, "original_width": 5681, "original_height": 3792, "found_via": "Openverse search: street vendor"}, "reference_made_by": {"original_size": [5681, 3792], "crop_box_px": [0, 3, 5681, 3790], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 41.7, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc83827597", "steps": [{"step": 1, "edit_type": "replace", "instruction": "Replace the round fan behind the man with a square red fan.", "item": "objects"}, {"step": 2, "edit_type": "change", "instruction": "Change the wooden pen holder on the counter to clear glass.", "item": "objects"}, {"step": 3, "edit_type": "change", "instruction": "Change the man's black hair to blonde.", "item": "hair_headwear_glasses"}, {"step": 4, "edit_type": "change", "instruction": "Give the square red fan large white dots.", "item": "objects"}, {"step": 5, "edit_type": "add", "instruction": "Add a green potted plant beside the glass pen holder.", "item": "objects"}], "people_visible": 3, "face_box": [0.33086, 0.32203, 0.47464, 0.5376], "tags": {"edit_target": ["hair_headwear_glasses", "objects"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Graveur_de_la_place_du_Peuple.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Touam (Hervé Agnoux)", "attribution_required": "true"}, "source": {"title": "Graveur de la place du Peuple.jpg", "page": "https://commons.wikimedia.org/wiki/File:Graveur_de_la_place_du_Peuple.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/9/99/Graveur_de_la_place_du_Peuple.jpg", "creator": "Touam (Hervé Agnoux)", "creator_url": null, "original_width": 5472, "original_height": 3648, "found_via": "Openverse search: kiosk"}, "reference_made_by": {"original_size": [5472, 3648], "crop_box_px": [0, 0, 5472, 3648], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 42.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc33355555", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change \"CONSERVATION\" on the rusty sign to \"RESCUE\".", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change \"BSBCC\" on the rusty sign to \"BEARS\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the rusty brown sign to dark blue.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Make all the words on the blue sign solid yellow.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Give the yellow words on the blue sign a black outline.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.75125, 0.27467, 0.90902, 0.5112], "tags": {"edit_target": ["text_signs"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:BSBCC_Sabah_Wong-Siew-Te-02.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "BSBCC Sabah Wong-Siew-Te-02.jpg", "page": "https://commons.wikimedia.org/wiki/File:BSBCC_Sabah_Wong-Siew-Te-02.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/1/1c/BSBCC_Sabah_Wong-Siew-Te-02.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 4969, "original_height": 3840, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4969, 3840], "crop_box_px": [0, 129, 4969, 3442], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 38.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc24642095", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change \"10 SAVEL\" on the small metal plate to \"COLD ICE\".", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the white letters on the small metal plate to red.", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the small metal plate's grey colour to yellow.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change \"COLD ICE\" on the yellow plate to \"FRESH DRINKS\".", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Give the yellow plate a thick black border.", "item": "text_signs"}], "people_visible": 2, "face_box": [0.49049, 0.28312, 0.80164, 0.59427], "tags": {"edit_target": ["text_signs"], "people": ["two"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Cepillao_ice_cream_vendor.jpg", "licence": "CC0", "licence_url": "http://creativecommons.org/publicdomain/zero/1.0/deed.en", "author": "Wilfredor", "attribution_required": "false"}, "source": {"title": "Cepillao ice cream vendor.jpg", "page": "https://commons.wikimedia.org/wiki/File:Cepillao_ice_cream_vendor.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Cepillao_ice_cream_vendor.jpg", "creator": "Wilfredor", "creator_url": null, "original_width": 2831, "original_height": 2731, "found_via": "Openverse search: vendor"}, "reference_made_by": {"original_size": [2831, 2731], "crop_box_px": [50, 0, 2781, 2731], "size": [1024, 1024], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 48.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc81006780", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change \"Les Glaces\" on the left menu stand to white \"ICE CREAM\".", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the \"ICE CREAM\" letters to yellow.", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the \"ICE CREAM\" menu stand's blue board to red.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Give the \"ICE CREAM\" letters a thick black outline.", "item": "text_signs"}, {"step": 5, "edit_type": "add", "instruction": "Outline the \"ICE CREAM\" letters with small light bulbs.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.42605, 0.18718, 0.64656, 0.51779], "tags": {"edit_target": ["text_signs"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Glaces_Jeff_de_Bruges_%C3%A0_Saint-%C3%89tienne.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Touam (Herve Agnoux)", "attribution_required": "true"}, "source": {"title": "Glaces Jeff de Bruges à Saint-Étienne.jpg", "page": "https://commons.wikimedia.org/wiki/File:Glaces_Jeff_de_Bruges_%C3%A0_Saint-%C3%89tienne.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/d/d7/Glaces_Jeff_de_Bruges_%C3%A0_Saint-%C3%89tienne.jpg", "creator": "Touam (Herve Agnoux)", "creator_url": null, "original_width": 5472, "original_height": 3648, "found_via": "Openverse search: seller"}, "reference_made_by": {"original_size": [5472, 3648], "crop_box_px": [0, 0, 5472, 3648], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 42.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc28942287", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a brown \"DANCE SHOW\" sign with black letters, right of her.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the sign's words to \"DANCE NIGHT\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Give the sign's letters thick white outlines.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the sign's black letters to purple.", "item": "text_signs"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the whole sign.", "item": "text_signs"}], "people_visible": 3, "face_box": [0.40345, 0.115, 0.55235, 0.33824], "tags": {"edit_target": ["text_signs"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:13-06_Budapest_Dancing_Show.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Achim Raschka (talk)", "attribution_required": "true"}, "source": {"title": "13-06 Budapest Dancing Show.jpg", "page": "https://commons.wikimedia.org/wiki/File:13-06_Budapest_Dancing_Show.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/c/cd/13-06_Budapest_Dancing_Show.jpg", "creator": "Achim Raschka (talk)", "creator_url": null, "original_width": 3057, "original_height": 1887, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3057, 1887], "crop_box_px": [2, 0, 2832, 1887], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 46.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc54735536", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a white sign with black \"TEA HOUSE\" letters on the orange wall.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the sign's words to \"MUSIC CAFE\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the white sign to a yellow sign.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the sign's black letters to blue.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Give the yellow sign a thick red border.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.3289, 0.15701, 0.80386, 0.4738], "tags": {"edit_target": ["text_signs"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Nubian_Flute_player_%D8%B9%D8%A7%D8%B2%D9%81_%D8%A7%D9%84%D9%86%D8%A7%D9%8A.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Ahmed Emad H", "attribution_required": "true"}, "source": {"title": "Nubian Flute player عازف الناي.jpg", "page": "https://commons.wikimedia.org/wiki/File:Nubian_Flute_player_%D8%B9%D8%A7%D8%B2%D9%81_%D8%A7%D9%84%D9%86%D8%A7%D9%8A.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/65/Nubian_Flute_player_%D8%B9%D8%A7%D8%B2%D9%81_%D8%A7%D9%84%D9%86%D8%A7%D9%8A.jpg", "creator": "Ahmed Emad H", "creator_url": null, "original_width": 3632, "original_height": 4847, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [3632, 4847], "crop_box_px": [200, 0, 3432, 4847], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc39110702", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a white \"ENTRY\" sign with black letters high on the brick wall.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the sign's words from \"ENTRY\" to \"TEMPLE\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the black letters on the brick-wall sign to red.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the white sign to a yellow sign.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Give the red \"TEMPLE\" letters thick black outlines.", "item": "text_signs"}], "people_visible": 2, "face_box": [0.41226, 0.22929, 0.64527, 0.4623], "tags": {"edit_target": ["text_signs"], "people": ["two"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Ubud_Bali_Girl-with-selfie-stick-01.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "CEphoto, Uwe Aranas", "attribution_required": "true"}, "source": {"title": "Ubud Bali Girl-with-selfie-stick-01.jpg", "page": "https://commons.wikimedia.org/wiki/File:Ubud_Bali_Girl-with-selfie-stick-01.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/b/b1/Ubud_Bali_Girl-with-selfie-stick-01.jpg", "creator": "CEphoto, Uwe Aranas", "creator_url": null, "original_width": 3840, "original_height": 4299, "found_via": "Openverse search: women"}, "reference_made_by": {"original_size": [3840, 4299], "crop_box_px": [6, 0, 3834, 3829], "size": [1024, 1024], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 29.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "10494e50-fd2e-47f6-9295-0248b1eeed09", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a yellow \"READING ROOM\" sign with black letters above the sofa.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the sign's words to \"BOOK CLUB\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the yellow sign to a green sign.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the \"BOOK CLUB\" letters to white.", "item": "text_signs"}, {"step": 5, "edit_type": "add", "instruction": "Add \"QUIET PLEASE\" under \"BOOK CLUB\" in white letters.", "item": "text_signs"}], "people_visible": 2, "face_box": [0.54071, 0.30136, 0.71286, 0.55946], "tags": {"edit_target": ["text_signs"], "people": ["two"], "face_size": ["medium"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/happy-couple-VXFRCXXFG6", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Senior Living", "attribution_required": "false"}, "source": {"title": "Happy Couple", "page": "https://stocksnap.io/photo/happy-couple-VXFRCXXFG6", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/VXFRCXXFG6.jpg", "creator": "Senior Living", "creator_url": "https://stocksnap.io/author/148922", "original_width": 5760, "original_height": 3840, "found_via": "Openverse search: woman reading book"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "sRGB", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 40.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc118282450", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the \"CASH ONLY!\" sign's words to \"HOT RIBS\".", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the sign's words to \"FRESH RIBS\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the \"FRESH RIBS\" letters to red.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the white sign to a yellow sign.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Give the sign's red letters thick black outlines.", "item": "text_signs"}], "people_visible": 4, "face_box": [0.51086, 0.18865, 0.66303, 0.4168], "tags": {"edit_target": ["text_signs"], "people": ["three_or_more"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Ribfest_in_Toronto_(Dundas_Square,_May_21,_2022).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Maksim Sokolov (maxergon.com)", "attribution_required": "true"}, "source": {"title": "Ribfest in Toronto (Dundas Square, May 21, 2022).jpg", "page": "https://commons.wikimedia.org/wiki/File:Ribfest_in_Toronto_(Dundas_Square,_May_21,_2022).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/d/db/Ribfest_in_Toronto_%28Dundas_Square%2C_May_21%2C_2022%29.jpg", "creator": "Maksim Sokolov (maxergon.com)", "creator_url": null, "original_width": 8635, "original_height": 6007, "found_via": "Openverse search: street food"}, "reference_made_by": {"original_size": [8635, 6007], "crop_box_px": [1, 0, 8634, 5755], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 39.5, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc21375193", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the window words \"VENTE A EMPORTER\" to \"TAKE AWAY FOOD\".", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the window words \"TAKE AWAY FOOD\" to \"HOT FOOD TO GO\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the yellow \"HOT FOOD TO GO\" letters to red.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Give the red \"HOT FOOD TO GO\" letters a thick white outline.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Underline \"HOT FOOD TO GO\" with a thick red line.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.18501, 0.18363, 0.31368, 0.37654], "tags": {"edit_target": ["text_signs"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Paris_-_Crepe_seller,_Rue_Mouffetard_-_2008.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Jorge Royan", "attribution_required": "true"}, "source": {"title": "Paris - Crepe seller, Rue Mouffetard - 2008.jpg", "page": "https://commons.wikimedia.org/wiki/File:Paris_-_Crepe_seller,_Rue_Mouffetard_-_2008.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/e/ed/Paris_-_Crepe_seller%2C_Rue_Mouffetard_-_2008.jpg", "creator": "Jorge Royan", "creator_url": null, "original_width": 4171, "original_height": 2821, "found_via": "Openverse search: seller"}, "reference_made_by": {"original_size": [4171, 2821], "crop_box_px": [0, 20, 4171, 2800], "size": [1248, 832], "icc_profile": "Adobe RGB (1998)", "converted_to_srgb": true, "upscaled": false, "psnr_vs_v1": 31.2, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc42782992", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a yellow \"ROAST PORK\" sign with black letters on the pink wall.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the sign's words to \"HOT PORK\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the sign's words to \"FRESH PORK\".", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the sign's black letters to red.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Give the sign's letters thick white outlines.", "item": "text_signs"}], "people_visible": 2, "face_box": [0.34333, 0.16743, 0.52473, 0.4394], "tags": {"edit_target": ["text_signs"], "people": ["two"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Puesto_de_comida,_calle_Jir%C3%B3n_Ancash,_Lima,_Per%C3%BA,_2015-07-28,_DD_80.JPG", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Diego Delso", "attribution_required": "true"}, "source": {"title": "Puesto de comida, calle Jirón Ancash, Lima, Perú, 2015-07-28, DD 80.JPG", "page": "https://commons.wikimedia.org/wiki/File:Puesto_de_comida,_calle_Jir%C3%B3n_Ancash,_Lima,_Per%C3%BA,_2015-07-28,_DD_80.JPG", "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/6a/Puesto_de_comida%2C_calle_Jir%C3%B3n_Ancash%2C_Lima%2C_Per%C3%BA%2C_2015-07-28%2C_DD_80.JPG", "creator": "Diego Delso", "creator_url": null, "original_width": 4405, "original_height": 3399, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4405, 3399], "crop_box_px": [1, 0, 4404, 2936], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 41.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc37667675", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the man's grey sweater to dark green.", "item": "tops_dresses"}, {"step": 2, "edit_type": "change", "instruction": "Give the green sweater large white stars.", "item": "tops_dresses"}, {"step": 3, "edit_type": "change", "instruction": "Change both flags on the building to red.", "item": "objects"}, {"step": 4, "edit_type": "add", "instruction": "Add a large potted palm on the steps at left.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Change the man's white hair to black.", "item": "hair_headwear_glasses"}], "people_visible": 3, "face_box": [0.56929, 0.2394, 0.76749, 0.53655], "tags": {"edit_target": ["hair_headwear_glasses", "objects", "tops_dresses"], "people": ["three_or_more"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Yair_Aharoni.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Arielinson", "attribution_required": "true"}, "source": {"title": "Yair Aharoni.jpg", "page": "https://commons.wikimedia.org/wiki/File:Yair_Aharoni.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/21/Yair_Aharoni.jpg", "creator": "Arielinson", "creator_url": null, "original_width": 4769, "original_height": 3577, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [4769, 3577], "crop_box_px": [0, 258, 4769, 3438], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 47.3, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc45734944", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the slide's title to \"PHOTO AWARDS 2015\".", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the year in the title from 2015 to 2016.", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the caption under the photos to \"BEST NEW MONUMENT\".", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the slide's title letters to red.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Underline the \"PHOTO AWARDS 2016\" title with a thick red line.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.17601, 0.36862, 0.29079, 0.54072], "tags": {"edit_target": ["text_signs"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Entrega_de_Premios_Wiki_Loves,_Sevilla,_Espa%C3%B1a,_2015-12-05,_DD_03.JPG", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Diego Delso", "attribution_required": "true"}, "source": {"title": "Entrega de Premios Wiki Loves, Sevilla, España, 2015-12-05, DD 03.JPG", "page": "https://commons.wikimedia.org/wiki/File:Entrega_de_Premios_Wiki_Loves,_Sevilla,_Espa%C3%B1a,_2015-12-05,_DD_03.JPG", "image_url": "https://upload.wikimedia.org/wikipedia/commons/f/f8/Entrega_de_Premios_Wiki_Loves%2C_Sevilla%2C_Espa%C3%B1a%2C_2015-12-05%2C_DD_03.JPG", "creator": "Diego Delso", "creator_url": null, "original_width": 5753, "original_height": 3835, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [5753, 3835], "crop_box_px": [0, 0, 5753, 3835], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 42.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "4cc5938a-c9bd-4377-a4c6-d57192056040", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large yellow \"QUIET WORK AREA\" sign with black letters below the window.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Move the sign from below the window to above the chair.", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the yellow sign to green, keeping its black letters.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the sign's letters to thick handwritten letters.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Change the sign's words to \"WORK LOUNGE\".", "item": "text_signs"}], "people_visible": 1, "face_box": [0.58142, 0.2513, 0.78759, 0.5604], "tags": {"edit_target": ["text_signs"], "people": ["one"], "face_size": ["large"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/man-desk-QPJWWR3W2E", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "LinkedIn Sales Navigator", "attribution_required": "false"}, "source": {"title": "Man Desk", "page": "https://stocksnap.io/photo/man-desk-QPJWWR3W2E", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/QPJWWR3W2E.jpg", "creator": "LinkedIn Sales Navigator", "creator_url": "https://business.linkedin.com/sales-solutions/real-face-of-sales", "original_width": 5184, "original_height": 3456, "found_via": "Openverse search: office people desk"}, "reference_made_by": {"original_size": [960, 640], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 41.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc47572063", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the white poster's large red heading to \"HOT TEA\".", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the poster heading \"HOT TEA\" to \"FRESH TEA\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the white poster to a yellow poster.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the \"FRESH TEA\" letters to blue.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Give the blue \"FRESH TEA\" letters thick black outlines.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.59992, 0.04574, 0.73922, 0.25459], "tags": {"edit_target": ["text_signs"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Suzhou_woman_burning_waste_20090926_5964.jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Jakub Hałun", "attribution_required": "true"}, "source": {"title": "Suzhou woman burning waste 20090926 5964.jpg", "page": "https://commons.wikimedia.org/wiki/File:Suzhou_woman_burning_waste_20090926_5964.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/2/2a/Suzhou_woman_burning_waste_20090926_5964.jpg", "creator": "Jakub Hałun", "creator_url": null, "original_width": 2644, "original_height": 1983, "found_via": "Openverse search: Quality_images_of_people"}, "reference_made_by": {"original_size": [2644, 1983], "crop_box_px": [0, 0, 2644, 1763], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 44.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc87185005", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large grey \"PHOTO STUDIO\" sign with black letters left of the woman.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the sign's words to \"PORTRAIT STUDIO\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the sign's black letters to purple.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the grey sign to a black sign, keeping its letters.", "item": "text_signs"}, {"step": 5, "edit_type": "change", "instruction": "Outline the sign's purple letters with small glowing light bulbs.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.48849, 0.02311, 0.76655, 0.20858], "tags": {"edit_target": ["text_signs"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:Slightly_Business_casual_Informal_wear_-_pose_2.jpg", "licence": "CC BY-SA 3.0", "licence_url": "https://creativecommons.org/licenses/by-sa/3.0", "author": "Tobias ToMar Maier", "attribution_required": "true"}, "source": {"title": "Slightly Business casual Informal wear - pose 2.jpg", "page": "https://commons.wikimedia.org/wiki/File:Slightly_Business_casual_Informal_wear_-_pose_2.jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/7/7d/Slightly_Business_casual_Informal_wear_-_pose_2.jpg", "creator": "Tobias ToMar Maier", "creator_url": null, "original_width": 3705, "original_height": 5557, "found_via": "Openverse search: fashion model"}, "reference_made_by": {"original_size": [3705, 5557], "crop_box_px": [0, 0, 3705, 5557], "size": [832, 1248], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 54.0, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "5f2648aa-cf39-42f7-b53a-e5fa703a296f", "steps": [{"step": 1, "edit_type": "add", "instruction": "Add a large \"CITY EXPRESS\" sign on the train's white stripe.", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the sign's letters to orange.", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the sign's words to \"COAST EXPRESS\".", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Give the sign's orange letters a thick black outline.", "item": "text_signs"}, {"step": 5, "edit_type": "remove", "instruction": "Remove the sign from the train.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.26879, 0.25577, 0.42041, 0.48308], "tags": {"edit_target": ["text_signs"], "people": ["one"], "face_size": ["small"]}, "licence": {"source": "Stocksnap via Openverse", "page": "https://stocksnap.io/photo/man-exiting-1GYKJQOTMM", "licence": "CC0 1.0", "licence_url": "https://creativecommons.org/publicdomain/zero/1.0/", "author": "Bruce Mars", "attribution_required": "false"}, "source": {"title": "Man Exiting", "page": "https://stocksnap.io/photo/man-exiting-1GYKJQOTMM", "image_url": "https://cdn.stocksnap.io/img-thumbs/960w/1GYKJQOTMM.jpg", "creator": "Bruce Mars", "creator_url": "https://stocksnap.io/author/brucemars", "original_width": 5900, "original_height": 4365, "found_via": "Openverse search: train platform people"}, "reference_made_by": {"original_size": [960, 710], "crop_box_px": [0, 0, 960, 640], "size": [1248, 832], "icc_profile": "none", "converted_to_srgb": false, "upscaled": true, "psnr_vs_v1": 41.4, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} +{"photo_id": "wc69428885", "steps": [{"step": 1, "edit_type": "change", "instruction": "Change the poster's title to large black \"FIRST FLIGHT\".", "item": "text_signs"}, {"step": 2, "edit_type": "change", "instruction": "Change the poster's title to \"CLEAN SKY\".", "item": "text_signs"}, {"step": 3, "edit_type": "change", "instruction": "Change the \"CLEAN SKY\" title letters to blue.", "item": "text_signs"}, {"step": 4, "edit_type": "change", "instruction": "Change the white poster to a yellow poster, keeping its text.", "item": "objects"}, {"step": 5, "edit_type": "change", "instruction": "Give the poster's title letters thick white outlines.", "item": "text_signs"}], "people_visible": 1, "face_box": [0.42702, 0.33231, 0.61188, 0.60947], "tags": {"edit_target": ["objects", "text_signs"], "people": ["one"], "face_size": ["medium"]}, "licence": {"source": "Wikimedia Commons", "page": "https://commons.wikimedia.org/wiki/File:ILA_2018,_Sch%C3%B6nefeld_(1X7A5927).jpg", "licence": "CC BY-SA 4.0", "licence_url": "https://creativecommons.org/licenses/by-sa/4.0", "author": "Matti Blume", "attribution_required": "true"}, "source": {"title": "ILA 2018, Schönefeld (1X7A5927).jpg", "page": "https://commons.wikimedia.org/wiki/File:ILA_2018,_Sch%C3%B6nefeld_(1X7A5927).jpg", "image_url": "https://upload.wikimedia.org/wikipedia/commons/b/b4/ILA_2018%2C_Sch%C3%B6nefeld_%281X7A5927%29.jpg", "creator": "Matti Blume", "creator_url": null, "original_width": 6720, "original_height": 4480, "found_via": "Openverse search: laboratory"}, "reference_made_by": {"original_size": [6720, 4480], "crop_box_px": [0, 0, 6720, 4480], "size": [1248, 832], "icc_profile": "sRGB IEC61966-2.1", "converted_to_srgb": false, "upscaled": false, "psnr_vs_v1": 45.8, "resample": "Lanczos", "format": "PNG", "exif_rotation": "applied"}} diff --git a/metadata/standings.json b/metadata/standings.json new file mode 100644 index 0000000000000000000000000000000000000000..a1a5920017497b4545fe8a4f5c42036034d824c0 --- /dev/null +++ b/metadata/standings.json @@ -0,0 +1,292 @@ +{ + "benchmark_id": "bmk_1ZqZJsP7VXHeeH", + "leaderboard_id": "rlb_1Zqch9KooTHLgd", + "pulled": "2026-11-06", + "standings": [ + { + "id": "par_1ZqcliNedxU86d", + "name": "Ideogram 4.5 (High Quality, High Precision)", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 1900.508830775872, + "wins": 5097.5, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 32.87070364737633, + "upperOffset": 32.870703647376104 + }, + "model_id": "ideogram-4.5" + }, + { + "id": "par_1ZqclEHD4AV5Lx", + "name": "FLUX 3 Image", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 1742.165015249256, + "wins": 4820, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 29.348307475253023, + "upperOffset": 29.348307475253023 + }, + "model_id": "flux-3" + }, + { + "id": "par_1ZqckkPfwoUxSz", + "name": "Muse Image", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 1490.2012582207722, + "wins": 4261.5, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 24.2580440715044, + "upperOffset": 24.2580440715044 + }, + "model_id": "muse" + }, + { + "id": "par_1ZqcoB8cEAbf76", + "name": "Qwen-Image-2.1-Pro (Thinking)", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 1373.3031513045878, + "wins": 3956, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 22.959198477293967, + "upperOffset": 22.959198477293967 + }, + "model_id": "qwen-image-2.1-pro" + }, + { + "id": "par_1ZqcjmwxM2fP66", + "name": "Seedream 5.0 Pro", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 1247.276446418592, + "wins": 3599.5, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 22.56749197971635, + "upperOffset": 22.56749197971635 + }, + "model_id": "seedream-5-pro" + }, + { + "id": "par_1ZqcmCtOtXcinz", + "name": "MAI-Image-2.5-Pro", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 1208.9017817764588, + "wins": 3486.5, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 22.257762434175675, + "upperOffset": 22.257762434175902 + }, + "model_id": "mai-image-2.5-pro" + }, + { + "id": "par_1Zqcnfvh0ICqlR", + "name": "Qwen-Image-3.0-Pro (Thinking)", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 1079.0684006653255, + "wins": 3094, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 21.83557507824935, + "upperOffset": 21.83557507824935 + }, + "model_id": "qwen-image-3.0-pro" + }, + { + "id": "par_1a2UkRyJ71D4J8", + "name": "GPT Image 2.6 Sunburst (Max Quality, High Reasoning)", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 1060.811151832436, + "wins": 3038, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 22.12374554887515, + "upperOffset": 22.12374554887515 + }, + "model_id": "gpt-image-2.6-sunburst" + }, + { + "id": "par_1ZqcjI3Jy4BUCH", + "name": "Nano Banana Pro", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 1054.1312276093129, + "wins": 3017.5, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 21.946409994914575, + "upperOffset": 21.946409994914575 + }, + "model_id": "nano-banana-pro" + }, + { + "id": "par_1Zqcin3reEdVrL", + "name": "Nano Banana 2.1 (High Thinking)", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 983.6912077859039, + "wins": 2801, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 21.888347752630466, + "upperOffset": 21.888347752630466 + }, + "model_id": "nano-banana-2.1" + }, + { + "id": "par_1ZrTYu0JqTTp2g", + "name": "Nano Banana 2 (High Thinking)", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 954.6773205021683, + "wins": 2712, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 21.992605503342247, + "upperOffset": 21.992605503342247 + }, + "model_id": "nano-banana-2" + }, + { + "id": "par_1ZrTY2UFNLac98", + "name": "Qwen-Image-Edit-2511", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 953.7017547000086, + "wins": 2709, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 22.288547674657366, + "upperOffset": 22.288547674657366 + }, + "model_id": "qwen-image-edit-2511" + }, + { + "id": "par_1ZqchVbbZcVgKP", + "name": "GPT Image 2.5 Sunburst (Max Quality)", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 944.3849375983875, + "wins": 2680.5, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 22.0009544274767, + "upperOffset": 22.0009544274767 + }, + "model_id": "gpt-image-2.5-sunburst" + }, + { + "id": "par_1ZqcofFmAZr4Yi", + "name": "Grok Imagine Image 2.0 (Medium Quality)", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 887.5219221341567, + "wins": 2507.5, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 22.017645120747716, + "upperOffset": 22.017645120747716 + }, + "model_id": "grok-imagine-2.0" + }, + { + "id": "par_1ZqcnCQjqEzo3J", + "name": "Wan 2.7 Pro", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 716.346281475952, + "wins": 2006, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 22.78033609808756, + "upperOffset": 22.78033609808756 + }, + "model_id": "wan-2.7-pro" + }, + { + "id": "par_1a2UlVdJSE8VFt", + "name": "GPT Image 2.6 Flare (Max Quality, High Reasoning)", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 613.397583080466, + "wins": 1726, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 24.476614215175573, + "upperOffset": 24.476614215175573 + }, + "model_id": "gpt-image-2.6-flare" + }, + { + "id": "par_1ZqciFXwVbmuqF", + "name": "GPT Image 2.5 Flare (Max Quality)", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 593.7879563396974, + "wins": 1675, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 24.26888490878457, + "upperOffset": 24.26888490878457 + }, + "model_id": "gpt-image-2.5-flare" + }, + { + "id": "par_1Zqcme5IPaYe28", + "name": "Kling Image O1", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": 398.9956450366217, + "wins": 1214, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 26.876688974180297, + "upperOffset": 26.876688974180297 + }, + "model_id": "kling-o1" + }, + { + "id": "par_1ZqckGxhfElEwY", + "name": "Seedream 5.0 Lite", + "leaderboardId": "rlb_1Zqch9KooTHLgd", + "status": "Idle", + "score": -202.8718725059748, + "wins": 318.5, + "totalMatches": 5760, + "isDisabled": false, + "confidenceInterval": { + "lowerOffset": 44.143883540798925, + "upperOffset": 44.1438835407987 + }, + "model_id": "seedream-5-lite" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/_fetched.txt b/pipeline/fal_schemas/_fetched.txt new file mode 100644 index 0000000000000000000000000000000000000000..9cb6a17a0f7298e13f7062b824a2db2376e39d77 --- /dev/null +++ b/pipeline/fal_schemas/_fetched.txt @@ -0,0 +1,2 @@ +fetched 2026-10-30T15:39:05.269982+00:00 from https://fal.ai/api/openapi/queue/openapi.json?endpoint_id= +fetched 2026-11-06 (GPT Image 2.6 Sunburst/Flare, Nano Banana 2, Qwen-Image-Edit-2511) from the same URL; the earlier runs used these endpoints since 2026-11-03/05 diff --git a/pipeline/fal_schemas/blackforestlabs__flux-3__edit-image.json b/pipeline/fal_schemas/blackforestlabs__flux-3__edit-image.json new file mode 100644 index 0000000000000000000000000000000000000000..976349a3b48bab63fb96550e3b22b47044c88ace --- /dev/null +++ b/pipeline/fal_schemas/blackforestlabs__flux-3__edit-image.json @@ -0,0 +1,437 @@ +{ + "components": { + "schemas": { + "Flux3EditImageInput": { + "properties": { + "aspect_ratio": { + "default": "auto", + "description": "Output aspect ratio. Auto uses the first reference image when editing.", + "enum": [ + "auto", + "21:9", + "2:1", + "16:9", + "3:2", + "7:5", + "4:3", + "5:4", + "1:1", + "4:5", + "3:4", + "5:7", + "2:3", + "9:16", + "1:2" + ], + "title": "Aspect Ratio", + "type": "string" + }, + "enable_prompt_expansion": { + "default": false, + "description": "Expand the prompt while preserving its intent and reference roles.", + "title": "Enable Prompt Expansion", + "type": "boolean" + }, + "image_urls": { + "description": "Reference image URLs or data URIs, in image 1 through image 10 order. Each must be at least 256 pixels per dimension. Oversized images are automatically downscaled to at most 4 megapixels while preserving aspect ratio. The first controls auto aspect ratio.", + "examples": [ + [ + "https://storage.googleapis.com/falserverless/example_inputs/flux2_pro_edit_input.png" + ] + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "title": "Image Urls", + "type": "array" + }, + "output_format": { + "default": "jpeg", + "description": "The format of the generated image.", + "enum": [ + "jpeg", + "png" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "The prompt to generate an image from.", + "examples": [ + "A red fox leaping over a stream in a pine forest, low-angle wildlife photograph." + ], + "title": "Prompt", + "type": "string" + }, + "resolution": { + "default": "1k", + "description": "Output resolution tier. 4k can take several minutes.", + "enum": [ + "768sq", + "1k", + "1.5k", + "2k", + "4k" + ], + "title": "Resolution", + "type": "string" + }, + "safety_tolerance": { + "default": 2, + "description": "Safety tolerance, from 0 (strictest) to 4.", + "maximum": 4, + "minimum": 0, + "title": "Safety Tolerance", + "type": "integer" + }, + "sync_mode": { + "default": false, + "description": "Return the image as a data URI instead of storing it in request history.", + "title": "Sync Mode", + "type": "boolean" + }, + "version": { + "const": "latest", + "default": "latest", + "description": "The model version.", + "title": "Version", + "type": "string" + } + }, + "required": [ + "prompt", + "image_urls" + ], + "title": "Flux3ImageEditInput", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_urls", + "aspect_ratio", + "resolution", + "enable_prompt_expansion", + "safety_tolerance", + "output_format", + "sync_mode", + "version" + ] + }, + "Flux3EditImageOutput": { + "properties": { + "images": { + "description": "The generated image.", + "items": { + "$ref": "#/components/schemas/ImageFile" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "Flux3ImageOutput", + "type": "object", + "x-fal-order-properties": [ + "images" + ] + }, + "ImageFile": { + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image", + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image", + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "ImageFile", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the blackforestlabs/flux-3/edit-image queue.", + "title": "Queue OpenAPI for blackforestlabs/flux-3/edit-image", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Edit", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/blackforestlabs/flux-3/edit-image/api", + "endpointId": "blackforestlabs/flux-3/edit-image", + "playgroundUrl": "https://fal.ai/models/blackforestlabs/flux-3/edit-image", + "thumbnailUrl": "https://v3b.fal.media/files/b/0aacace0/cuYCs5EDeB5znT34LrInr.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/blackforestlabs/flux-3/edit-image": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Flux3EditImageInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/blackforestlabs/flux-3/edit-image/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Flux3EditImageOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/blackforestlabs/flux-3/edit-image/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/blackforestlabs/flux-3/edit-image/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/bytedance__seedream__v5__lite__edit.json b/pipeline/fal_schemas/bytedance__seedream__v5__lite__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..d629cee33a16a7f9c1dbc74d5a85ab8230415f3c --- /dev/null +++ b/pipeline/fal_schemas/bytedance__seedream__v5__lite__edit.json @@ -0,0 +1,502 @@ +{ + "components": { + "schemas": { + "Image": { + "description": "Represents an image file.", + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image in pixels.", + "examples": [ + 1024 + ], + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image in pixels.", + "examples": [ + 1024 + ], + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "Image", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + }, + "SeedreamLiteImageSize": { + "properties": { + "height": { + "default": 512, + "description": "The height of the generated image.", + "exclusiveMinimum": 0, + "maximum": 16384, + "title": "Height", + "type": "integer" + }, + "width": { + "default": 512, + "description": "The width of the generated image.", + "exclusiveMinimum": 0, + "maximum": 16384, + "title": "Width", + "type": "integer" + } + }, + "title": "SeedreamLiteImageSize", + "type": "object", + "x-fal-order-properties": [ + "width", + "height" + ] + }, + "SeedreamV5LiteEditInput": { + "properties": { + "enable_safety_checker": { + "default": true, + "description": "If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked.", + "examples": [ + true + ], + "title": "Enable Safety Checker", + "type": "boolean" + }, + "image_size": { + "anyOf": [ + { + "$ref": "#/components/schemas/SeedreamLiteImageSize" + }, + { + "enum": [ + "square_hd", + "square", + "portrait_4_3", + "portrait_16_9", + "landscape_4_3", + "landscape_16_9", + "auto_2K", + "auto_3K", + "auto_4K" + ], + "type": "string" + } + ], + "default": "auto_2K", + "description": "The size of the generated image. Custom dimensions within the provider's pixel and aspect limits are sent unchanged. Other sizes use compatible scaling. The provider's native pixel range is 2560x1440 to 4096x4096, with aspect ratio between 1/16 and 16.", + "title": "Image Size" + }, + "image_urls": { + "description": "List of URLs of input images for editing. When more than 10 references are provided, only the last 10 are used.", + "examples": [ + [ + "https://v3b.fal.media/files/b/0a8f9936/KOsb_qPB_W0ZJ0Ee2OsnU_586e2892841d46f09049ee7199b303d3.png", + "https://v3b.fal.media/files/b/0a8f994e/JroWTogO6jOTFk9b6B3XM_591ca38cef2f44bbba2843cbf80fb1b2.png", + "https://v3b.fal.media/files/b/0a8f9960/Q6pzwXAiFaFPOpSScoE-D_0eca5db19e5242739f127efe49b38922.png" + ] + ], + "items": { + "type": "string" + }, + "title": "Image URLs", + "type": "array" + }, + "max_images": { + "default": 1, + "description": "Maximum images per generation in sequential mode. Ignored when sequential generation is disabled. Combined input references and outputs per generation cannot exceed 15.", + "maximum": 15, + "minimum": 1, + "title": "Max Images", + "type": "integer" + }, + "num_images": { + "default": 1, + "description": "Number of separate model generations to be run with the prompt.", + "maximum": 6, + "minimum": 1, + "title": "Num Images", + "type": "integer" + }, + "output_format": { + "default": "jpeg", + "description": "The file format of the generated images.", + "enum": [ + "jpeg", + "png" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "The text prompt used to edit the image", + "examples": [ + "Replace the product in Figure 1 with that in Figure 2. Seamlessly render logo in Figure 3 into the product design, in frosted glass texture. Remove any extra text in Figure 1, and design a catchy tagline for the perfume." + ], + "title": "Prompt", + "type": "string" + }, + "sequential_image_generation": { + "anyOf": [ + { + "enum": [ + "auto", + "disabled" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Generate related images with `auto`, or one image per generation with `disabled`. When omitted, values of `max_images` above one enable `auto`.", + "title": "Sequential Image Generation" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.", + "title": "Sync Mode", + "type": "boolean" + }, + "watermark": { + "default": false, + "description": "Whether to add the provider's visible watermark.", + "title": "Watermark", + "type": "boolean" + } + }, + "required": [ + "prompt", + "image_urls" + ], + "title": "SeedDream50LiteEditInput", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_size", + "num_images", + "max_images", + "sync_mode", + "enable_safety_checker", + "output_format", + "watermark", + "sequential_image_generation", + "image_urls" + ] + }, + "SeedreamV5LiteEditOutput": { + "properties": { + "images": { + "description": "Generated images", + "examples": [ + [ + { + "url": "https://v3b.fal.media/files/b/0a8fbf56/wu9vcxO3xO6lkHv5zdiIs_7aa8564f6e4f4cc795ecb8e923deb2fb.png" + } + ] + ], + "items": { + "$ref": "#/components/schemas/Image" + }, + "title": "Images", + "type": "array" + }, + "seed": { + "description": "Seed used for generation.", + "examples": [ + 42 + ], + "title": "Seed", + "type": "integer" + } + }, + "required": [ + "images", + "seed" + ], + "title": "SeedDream50LiteEditOutput", + "type": "object", + "x-fal-order-properties": [ + "images", + "seed" + ] + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the bytedance/seedream/v5/lite/edit queue.", + "title": "Queue OpenAPI for bytedance/seedream/v5/lite/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Edit images using Bytedance's SeedDream 5.0 Lite model.", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/bytedance/seedream/v5/lite/edit/api", + "endpointId": "bytedance/seedream/v5/lite/edit", + "playgroundUrl": "https://fal.ai/models/bytedance/seedream/v5/lite/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0a9c2fb5/PIUPm_8kBdpdBoSkOebbz_bcfdbe1021324995bf3c36b05ab59c2c.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/bytedance/seedream/v5/lite/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeedreamV5LiteEditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/bytedance/seedream/v5/lite/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeedreamV5LiteEditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/bytedance/seedream/v5/lite/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/bytedance/seedream/v5/lite/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/bytedance__seedream__v5__pro__edit.json b/pipeline/fal_schemas/bytedance__seedream__v5__pro__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..77c1f569a5e89abde294617511b4345b6be599da --- /dev/null +++ b/pipeline/fal_schemas/bytedance__seedream__v5__pro__edit.json @@ -0,0 +1,500 @@ +{ + "components": { + "schemas": { + "Image": { + "description": "Represents an image file.", + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image in pixels.", + "examples": [ + 1024 + ], + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image in pixels.", + "examples": [ + 1024 + ], + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "Image", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "ImageSize": { + "properties": { + "height": { + "default": 512, + "description": "The height of the generated image.", + "exclusiveMinimum": 0, + "maximum": 14142, + "title": "Height", + "type": "integer" + }, + "width": { + "default": 512, + "description": "The width of the generated image.", + "exclusiveMinimum": 0, + "maximum": 14142, + "title": "Width", + "type": "integer" + } + }, + "title": "ImageSize", + "type": "object", + "x-fal-order-properties": [ + "width", + "height" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + }, + "SeedreamV5ProEditInput": { + "properties": { + "background": { + "default": "opaque", + "description": "Use `transparent` with exactly one alpha-channel reference and PNG output to preserve transparency.", + "enum": [ + "opaque", + "transparent" + ], + "title": "Background", + "type": "string" + }, + "enable_safety_checker": { + "default": true, + "description": "If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked.", + "examples": [ + true + ], + "title": "Enable Safety Checker", + "type": "boolean" + }, + "enhance_prompt_mode": { + "default": "standard", + "description": "Prompt optimization mode. `standard` prioritizes image quality; `fast` reduces generation time.", + "enum": [ + "standard", + "fast" + ], + "title": "Enhance Prompt Mode", + "type": "string" + }, + "image_size": { + "anyOf": [ + { + "$ref": "#/components/schemas/ImageSize" + }, + { + "enum": [ + "square_hd", + "square", + "portrait_4_3", + "portrait_16_9", + "landscape_4_3", + "landscape_16_9", + "auto_1K", + "auto_1.5K", + "auto_2K" + ], + "type": "string" + } + ], + "default": "auto_2K", + "description": "The size of the generated image. Total pixels must be between 921600 and 4624220, with aspect ratio between 1/16 and 16.", + "examples": [ + "auto_2K" + ], + "title": "Image Size", + "x-fal": { + "max_area": 4624220, + "max_aspect_ratio": 16, + "min_area": 921600, + "min_aspect_ratio": 0.0625 + } + }, + "image_urls": { + "description": "List of URLs of input reference images. Up to 10 images are supported; if more are sent, only the last 10 are used.", + "examples": [ + [ + "https://storage.googleapis.com/falserverless/example_inputs/seedreamv45/seedream_v45_edit_input_1.png", + "https://storage.googleapis.com/falserverless/example_inputs/seedreamv45/seedream_v45_edit_input_2.png", + "https://storage.googleapis.com/falserverless/example_inputs/seedreamv45/seedream_v45_edit_input_3.png" + ] + ], + "items": { + "type": "string" + }, + "title": "Image URLs", + "type": "array" + }, + "num_images": { + "default": 1, + "description": "Number of separate model generations to run with the prompt.", + "maximum": 6, + "minimum": 1, + "title": "Num Images", + "type": "integer" + }, + "output_format": { + "default": "jpeg", + "description": "The file format of the generated image.", + "enum": [ + "jpeg", + "png" + ], + "examples": [ + "jpeg" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "The text prompt used to edit the image.", + "examples": [ + "Replace the product in Figure 1 with that in Figure 2. Seamlessly render the logo in Figure 3 into the product design, in a frosted glass texture." + ], + "title": "Prompt", + "type": "string" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.", + "title": "Sync Mode", + "type": "boolean" + }, + "watermark": { + "default": false, + "description": "Whether to add the provider's visible watermark.", + "title": "Watermark", + "type": "boolean" + } + }, + "required": [ + "prompt", + "image_urls" + ], + "title": "SeedDream50ProEditInput", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_size", + "num_images", + "output_format", + "watermark", + "sync_mode", + "enable_safety_checker", + "background", + "enhance_prompt_mode", + "image_urls" + ] + }, + "SeedreamV5ProEditOutput": { + "properties": { + "images": { + "description": "Generated images.", + "examples": [ + [ + { + "url": "https://v3b.fal.media/files/b/0aa16df4/L8veDBOTxHhmpO5wQnioS_14c2d9c1736b4803a43796669c6d4fca.png" + } + ] + ], + "items": { + "$ref": "#/components/schemas/Image" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "SeedDream50ProEditOutput", + "type": "object", + "x-fal-order-properties": [ + "images" + ] + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the bytedance/seedream/v5/pro/edit queue.", + "title": "Queue OpenAPI for bytedance/seedream/v5/pro/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Edit images using Bytedance's Seedream 5.0 Pro model.", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/bytedance/seedream/v5/pro/edit/api", + "endpointId": "bytedance/seedream/v5/pro/edit", + "playgroundUrl": "https://fal.ai/models/bytedance/seedream/v5/pro/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0aa15606/l4xYHHjF6aMrdoonScgXK.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/bytedance/seedream/v5/pro/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeedreamV5ProEditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/bytedance/seedream/v5/pro/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeedreamV5ProEditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/bytedance/seedream/v5/pro/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/bytedance/seedream/v5/pro/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/fal-ai__kling-image__o1.json b/pipeline/fal_schemas/fal-ai__kling-image__o1.json new file mode 100644 index 0000000000000000000000000000000000000000..c4cc4405e770b8875e2d79a8075a25087031b5e7 --- /dev/null +++ b/pipeline/fal_schemas/fal-ai__kling-image__o1.json @@ -0,0 +1,539 @@ +{ + "components": { + "schemas": { + "ElementInput": { + "description": "Element input for image generation with face/character control.\n\nCreate an element by providing frontal_image_url (and optionally reference_image_urls).\nAll fields are optional - provide what you have available.", + "properties": { + "frontal_image_url": { + "anyOf": [ + { + "_fal_ui_field": "image", + "limit_description": "Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s", + "type": "string", + "ui": { + "field": "image" + }, + "x-fal": { + "max_aspect_ratio": 2.5, + "max_file_size": 10485760, + "min_aspect_ratio": 0.4, + "min_height": 300, + "min_width": 300, + "timeout": 20 + } + }, + { + "type": "null" + } + ], + "description": "The frontal image of the element (main view). Optional.", + "title": "Frontal Image Url" + }, + "reference_image_urls": { + "anyOf": [ + { + "items": { + "_fal_ui_field": "image", + "limit_description": "Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s", + "type": "string", + "ui": { + "field": "image" + }, + "x-fal": { + "max_aspect_ratio": 2.5, + "max_file_size": 10485760, + "min_aspect_ratio": 0.4, + "min_height": 300, + "min_width": 300, + "timeout": 20 + } + }, + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Additional reference images from different angles. 0-3 images supported. Optional.", + "title": "Reference Image Urls" + } + }, + "title": "ElementInput", + "type": "object", + "x-fal-order-properties": [ + "frontal_image_url", + "reference_image_urls" + ] + }, + "Image": { + "description": "Represents an image file.", + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image in pixels.", + "examples": [ + 1024 + ], + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image in pixels.", + "examples": [ + 1024 + ], + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "Image", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "KlingImageO1Input": { + "description": "Request model for Kling O1 Omni Image (legacy).", + "properties": { + "aspect_ratio": { + "default": "auto", + "description": "Aspect ratio of generated images. 'auto' intelligently determines based on input content.", + "enum": [ + "auto", + "16:9", + "9:16", + "1:1", + "4:3", + "3:4", + "3:2", + "2:3", + "21:9" + ], + "title": "Aspect Ratio", + "type": "string" + }, + "elements": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/ElementInput" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Elements (characters/objects) to include in the image. Reference in prompt as @Element1, @Element2, etc. Maximum 10 total (elements + reference images).", + "examples": [ + [ + { + "frontal_image_url": "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/element-1-front.png", + "reference_image_urls": [ + "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/element-1-reference.png" + ] + } + ] + ], + "title": "Elements" + }, + "enable_safety_checker": { + "default": true, + "description": "Authorized callers may set false to request relaxed screening.", + "title": "Enable Safety Checker", + "type": "boolean" + }, + "image_urls": { + "description": "List of reference images. Reference images in prompt using @Image1, @Image2, etc. (1-indexed). Max 10 images.", + "examples": [ + [ + "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/input.png", + "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/input-2.png" + ] + ], + "items": { + "_fal_ui_field": "image", + "limit_description": "Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s", + "type": "string", + "x-fal": { + "max_aspect_ratio": 2.5, + "max_file_size": 10485760, + "min_aspect_ratio": 0.4, + "min_height": 300, + "min_width": 300, + "timeout": 20 + } + }, + "title": "Image Urls", + "type": "array" + }, + "num_images": { + "default": 1, + "description": "Number of images to generate (1-9).", + "maximum": 9, + "minimum": 1, + "title": "Num Images", + "type": "integer" + }, + "output_format": { + "default": "png", + "description": "The format of the generated image.", + "enum": [ + "jpeg", + "png", + "webp" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "Text prompt for image generation. Reference images using @Image1, @Image2, etc. (or @Image if only one image). Max 2500 characters.", + "examples": [ + "Put @Image1 to the back seat of the car in @Image2, put @Element1 on to the @Image1" + ], + "maxLength": 2500, + "title": "Prompt", + "type": "string" + }, + "resolution": { + "default": "1K", + "description": "Image generation resolution. 1K: standard, 2K: high-res.", + "enum": [ + "1K", + "2K" + ], + "title": "Resolution", + "type": "string" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.", + "title": "Sync Mode", + "type": "boolean" + } + }, + "required": [ + "prompt", + "image_urls" + ], + "title": "OmniImageRequest", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_urls", + "elements", + "resolution", + "num_images", + "aspect_ratio", + "output_format", + "sync_mode", + "enable_safety_checker" + ] + }, + "KlingImageO1Output": { + "properties": { + "images": { + "description": "Generated images", + "examples": [ + [ + { + "content_type": "image/png", + "file_name": "d4eeaeaeae294a41b0321ba6c99f0f9d.png", + "file_size": 1419818, + "url": "https://storage.googleapis.com/falserverless/example_outputs/kling-image-o1/output.png" + } + ] + ], + "items": { + "$ref": "#/components/schemas/Image" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "OmniImageOutput", + "type": "object", + "x-fal-order-properties": [ + "images" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the fal-ai/kling-image/o1 queue.", + "title": "Queue OpenAPI for fal-ai/kling-image/o1", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Generate images using Kling O1 model.", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/fal-ai/kling-image/o1/api", + "endpointId": "fal-ai/kling-image/o1", + "playgroundUrl": "https://fal.ai/models/fal-ai/kling-image/o1", + "thumbnailUrl": "https://v3b.fal.media/files/b/0a8495e0/GVuCh0RsGXpLIlUsJMrNX_f4fe5943ad804aaab441629241777417.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/fal-ai/kling-image/o1": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KlingImageO1Input" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/fal-ai/kling-image/o1/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KlingImageO1Output" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/fal-ai/kling-image/o1/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/fal-ai/kling-image/o1/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} diff --git a/pipeline/fal_schemas/fal-ai__kling-image__o3__image-to-image.json b/pipeline/fal_schemas/fal-ai__kling-image__o3__image-to-image.json new file mode 100644 index 0000000000000000000000000000000000000000..0bdd799df9a1c763a5adb7a97215f15f18388915 --- /dev/null +++ b/pipeline/fal_schemas/fal-ai__kling-image__o3__image-to-image.json @@ -0,0 +1,556 @@ +{ + "components": { + "schemas": { + "ElementInput": { + "description": "Element input for image generation with face/character control.\n\nCreate an element by providing frontal_image_url (and optionally reference_image_urls).\nAll fields are optional - provide what you have available.", + "properties": { + "frontal_image_url": { + "anyOf": [ + { + "_fal_ui_field": "image", + "limit_description": "Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s", + "type": "string", + "ui": { + "field": "image" + }, + "x-fal": { + "max_aspect_ratio": 2.5, + "max_file_size": 10485760, + "min_aspect_ratio": 0.4, + "min_height": 300, + "min_width": 300, + "timeout": 20 + } + }, + { + "type": "null" + } + ], + "description": "The frontal image of the element (main view). Optional.", + "title": "Frontal Image Url" + }, + "reference_image_urls": { + "anyOf": [ + { + "items": { + "_fal_ui_field": "image", + "limit_description": "Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s", + "type": "string", + "ui": { + "field": "image" + }, + "x-fal": { + "max_aspect_ratio": 2.5, + "max_file_size": 10485760, + "min_aspect_ratio": 0.4, + "min_height": 300, + "min_width": 300, + "timeout": 20 + } + }, + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Additional reference images from different angles. 0-3 images supported. Optional.", + "title": "Reference Image Urls" + } + }, + "title": "ElementInput", + "type": "object", + "x-fal-order-properties": [ + "frontal_image_url", + "reference_image_urls" + ] + }, + "Image": { + "description": "Represents an image file.", + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image in pixels.", + "examples": [ + 1024 + ], + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image in pixels.", + "examples": [ + 1024 + ], + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "Image", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "KlingImageO3ImageToImageInput": { + "description": "Request model for Kling O3 Image-to-Image Generation.", + "properties": { + "aspect_ratio": { + "default": "auto", + "description": "Aspect ratio of generated images. 'auto' intelligently determines based on input content.", + "enum": [ + "16:9", + "9:16", + "1:1", + "4:3", + "3:4", + "3:2", + "2:3", + "21:9", + "auto" + ], + "title": "Aspect Ratio", + "type": "string" + }, + "elements": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/ElementInput" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Optional: Elements (characters/objects) for face control. Reference in prompt as @Element1, @Element2, etc.", + "title": "Elements" + }, + "enable_safety_checker": { + "default": true, + "description": "Authorized callers may set false to request relaxed screening.", + "title": "Enable Safety Checker", + "type": "boolean" + }, + "image_urls": { + "description": "List of reference images. Reference images in prompt using @Image1, @Image2, etc. (1-indexed). Max 10 images.", + "examples": [ + [ + "https://v3b.fal.media/files/b/0a8d06d1/FTrwBsV9WI5twqMPkqvRh_19db9852c5ed4a109d81c52d27c9e433.png" + ] + ], + "items": { + "_fal_ui_field": "image", + "limit_description": "Max file size: 10.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s", + "type": "string", + "x-fal": { + "max_aspect_ratio": 2.5, + "max_file_size": 10485760, + "min_aspect_ratio": 0.4, + "min_height": 300, + "min_width": 300, + "timeout": 20 + } + }, + "title": "Image Urls", + "type": "array" + }, + "num_images": { + "default": 1, + "description": "Number of images to generate (1-9). Only used when result_type is 'single'.", + "maximum": 9, + "minimum": 1, + "title": "Num Images", + "type": "integer" + }, + "output_format": { + "default": "png", + "description": "The format of the generated image.", + "enum": [ + "jpeg", + "png", + "webp" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "Text prompt for image generation. Reference images using @Image1, @Image2, etc. (or @Image if only one image). Max 2500 characters.", + "examples": [ + "Transform into photorealistic 3D render, add proper lighting and shadows, realistic materials and textures, maintain exact proportions and design from sketch, product visualization quality" + ], + "maxLength": 2500, + "title": "Prompt", + "type": "string" + }, + "resolution": { + "default": "1K", + "description": "Image generation resolution. 1K: standard, 2K: high-res, 4K: ultra high-res.", + "enum": [ + "1K", + "2K", + "4K" + ], + "title": "Resolution", + "type": "string" + }, + "result_type": { + "default": "single", + "description": "Result type. 'single' for one image, 'series' for a series of related images.", + "enum": [ + "single", + "series" + ], + "title": "Result Type", + "type": "string" + }, + "series_amount": { + "anyOf": [ + { + "maximum": 9, + "minimum": 2, + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of images in series (2-9). Only used when result_type is 'series'.", + "title": "Series Amount" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the media will be returned as a data URI.", + "title": "Sync Mode", + "type": "boolean" + } + }, + "required": [ + "prompt", + "image_urls" + ], + "title": "O3ImageToImageRequest", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_urls", + "elements", + "resolution", + "result_type", + "num_images", + "series_amount", + "aspect_ratio", + "output_format", + "sync_mode", + "enable_safety_checker" + ] + }, + "KlingImageO3ImageToImageOutput": { + "description": "Output model for Kling O3 Image Generation.", + "properties": { + "images": { + "description": "Generated images", + "examples": [ + [ + { + "content_type": "image/png", + "file_name": "19db9852c5ed4a109d81c52d27c9e433.png", + "file_size": 793847, + "url": "https://v3b.fal.media/files/b/0a8d06d1/FTrwBsV9WI5twqMPkqvRh_19db9852c5ed4a109d81c52d27c9e433.png" + } + ] + ], + "items": { + "$ref": "#/components/schemas/Image" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "I2IO3ImageOutput", + "type": "object", + "x-fal-order-properties": [ + "images" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the fal-ai/kling-image/o3/image-to-image queue.", + "title": "Queue OpenAPI for fal-ai/kling-image/o3/image-to-image", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Generate images from reference images using Kling O3 Omni-Image model.\n\nImage-to-image generation with:\n- Support for 4K resolution\n- Series image generation (2-9 related images)\n- Intelligent aspect ratio detection\n- Reference images using @Image1, @Image2, etc. syntax\n- Optional element control (face)", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/fal-ai/kling-image/o3/image-to-image/api", + "endpointId": "fal-ai/kling-image/o3/image-to-image", + "playgroundUrl": "https://fal.ai/models/fal-ai/kling-image/o3/image-to-image", + "thumbnailUrl": "https://v3b.fal.media/files/b/0a8d24a0/FX4gbFjRsBJPDJ2WkPMFa_9f3aa39f5fd84be395b5ce3dee7e4dd1.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/fal-ai/kling-image/o3/image-to-image": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KlingImageO3ImageToImageInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/fal-ai/kling-image/o3/image-to-image/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KlingImageO3ImageToImageOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/fal-ai/kling-image/o3/image-to-image/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/fal-ai/kling-image/o3/image-to-image/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/fal-ai__nano-banana-2__edit.json b/pipeline/fal_schemas/fal-ai__nano-banana-2__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..740f1ba9fbca56d89261e5390b9006ad9d99dc79 --- /dev/null +++ b/pipeline/fal_schemas/fal-ai__nano-banana-2__edit.json @@ -0,0 +1 @@ +{"openapi":"3.1.0","info":{"title":"Queue OpenAPI for fal-ai/nano-banana-2/edit","version":"1.0.0","description":"The OpenAPI schema for the fal-ai/nano-banana-2/edit queue.","x-fal-metadata":{"endpointId":"fal-ai/nano-banana-2/edit","category":"image-to-image","thumbnailUrl":"https://v3b.fal.media/files/b/0a900b75/DHb_RgXoXsYLdvzQz6mdn_95e87a44239c43448939b4c382dd957c.jpg","playgroundUrl":"https://fal.ai/models/fal-ai/nano-banana-2/edit","documentationUrl":"https://fal.ai/models/fal-ai/nano-banana-2/edit/api","about":"Gemini 3.1 Flash Image is a text-to-image model that generates images from text descriptions."}},"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Fal Key"}},"schemas":{"QueueStatus":{"type":"object","properties":{"status":{"type":"string","enum":["IN_QUEUE","IN_PROGRESS","COMPLETED"]},"request_id":{"type":"string","description":"The request id."},"response_url":{"type":"string","description":"The response url."},"status_url":{"type":"string","description":"The status url."},"cancel_url":{"type":"string","description":"The cancel url."},"logs":{"type":"object","description":"The logs.","additionalProperties":true},"metrics":{"type":"object","description":"The metrics.","additionalProperties":true},"queue_position":{"type":"integer","description":"The queue position."}},"required":["status","request_id"]},"NanoBanana2EditInput":{"properties":{"prompt":{"description":"The prompt for image editing.","maxLength":50000,"type":"string","title":"Prompt","minLength":3,"examples":["make a photo of the man driving the car down the california coastline"]},"seed":{"description":"The seed for the random number generator.","title":"Seed","anyOf":[{"type":"integer"},{"type":"null"}]},"context":{"description":"Ordered text, image, PDF, UTF-8 text-file or video parts appended to the current prompt. Original media bytes are preserved; images count toward the total 14-reference limit.","type":"array","title":"Context","items":{"oneOf":[{"$ref":"#/components/schemas/GeminiTextPart"},{"$ref":"#/components/schemas/GeminiImagePart"},{"$ref":"#/components/schemas/GeminiDocumentPart"},{"$ref":"#/components/schemas/GeminiVideoPart"},{"$ref":"#/components/schemas/GeminiSignaturePart"}],"discriminator":{"propertyName":"type","mapping":{"image":"#/components/schemas/GeminiImagePart","document":"#/components/schemas/GeminiDocumentPart","text":"#/components/schemas/GeminiTextPart","video":"#/components/schemas/GeminiVideoPart","signature":"#/components/schemas/GeminiSignaturePart"}}}},"thinking_level":{"description":"Controls thinking effort ('minimal' or 'high') and requests thought summaries. Omit to use the provider default ('minimal'); thinking cannot be disabled.","title":"Thinking Level","anyOf":[{"enum":["minimal","high"],"type":"string"},{"type":"null"}]},"top_p":{"description":"Nucleus sampling probability. Omit to use the provider default of 0.95. Explicit values use a direct Google or Vertex API.","title":"Top P","anyOf":[{"maximum":1,"type":"number","minimum":0},{"type":"null"}]},"limit_generations":{"description":"Experimental parameter to limit the number of generations from each round of prompting to 1. Set to `True` to to disregard any instructions in the prompt regarding the number of images to generate and ignore any intermediate images generated by the model. This may affect generation quality.","default":true,"type":"boolean","title":"Limit Generations"},"temperature":{"description":"Sampling temperature. Omit to use the provider default of 1. Explicit values use a direct Google or Vertex API.","title":"Temperature","anyOf":[{"maximum":2,"type":"number","minimum":0},{"type":"null"}]},"pdf_url":{"description":"Optional PDF document to use as input context. Accepts an http(s)/data URL (downloaded and sent inline, max 15MB).","title":"PDF URL","anyOf":[{"type":"string"},{"type":"null"}]},"safety_tolerance":{"description":"The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.","enum":["1","2","3","4","5","6"],"type":"string","title":"Safety Tolerance","default":"4"},"output_format":{"description":"The format of the generated image.","enum":["jpeg","png","webp"],"default":"png","type":"string","title":"Output Format"},"enable_image_search":{"description":"Ground image generation with Google Image Search. Can be combined with enable_web_search; source attribution is returned in grounding_metadata. Uses direct Google or Vertex APIs.","default":false,"type":"boolean","title":"Enable Image Search"},"image_urls":{"description":"The URLs of the images to use for image-to-image generation or image editing. Optional when at least one of `video_url`, `audio_url`, or `pdf_url` is provided.","type":"array","title":"Image URLs","examples":[["https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input.png","https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input-2.png"]],"items":{"type":"string"}},"return_history":{"description":"Return reusable native conversations with original image parts and provider thought signatures. Uses a native provider. Each generated conversation is independent; send its messages as history for the next turn.","default":false,"type":"boolean","title":"Return History"},"include_thoughts":{"description":"Whether to include thought summaries. Omit to preserve the existing behavior: an explicit thinking_level requests summaries. Set limit_generations=false to return summary text in description. This does not disable thinking or return intermediate thought images.","title":"Include Thoughts","anyOf":[{"type":"boolean"},{"type":"null"}]},"history":{"description":"Previous native Gemini turns, including original parts and thought signatures from conversations. The current prompt starts a new user turn.","type":"array","title":"History","items":{"$ref":"#/components/schemas/GeminiVideoMessage"}},"sync_mode":{"description":"If `True`, the media will be returned as a data URI and the output data won't be available in the request history.","default":false,"type":"boolean","title":"Sync Mode"},"system_prompt":{"description":"Optional system instruction that steers the model's persona and output style across the request. Leave blank to omit; when provided, it is sent as the system instruction to Gemini (or as a system message on OpenAI-compatible providers).","default":"","maxLength":50000,"type":"string","title":"System Prompt"},"resolution":{"description":"The resolution of the image to generate.","enum":["0.5K","1K","2K","4K"],"type":"string","title":"Resolution","default":"1K"},"audio_url":{"description":"Optional audio file to use as input context. Accepts an http(s)/data URL (downloaded and sent inline, max 15MB).","title":"Audio URL","anyOf":[{"type":"string"},{"type":"null"}]},"enable_web_search":{"description":"Enable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image.","default":false,"type":"boolean","title":"Enable Web Search"},"num_images":{"maximum":4,"description":"The number of images to generate.","default":1,"type":"integer","minimum":1,"title":"Number of Images"},"aspect_ratio":{"description":"The aspect ratio of the generated image. Supports extreme ratios: 4:1, 1:4, 8:1, 1:8.","default":"auto","title":"Aspect Ratio","anyOf":[{"enum":["auto","21:9","16:9","3:2","4:3","5:4","1:1","4:5","3:4","2:3","9:16","4:1","1:4","8:1","1:8"],"type":"string"},{"type":"null"}]},"max_output_tokens":{"description":"Maximum output tokens for the generation. Omit to retain the provider default. Explicit values use a direct Google or Vertex API.","title":"Max Output Tokens","anyOf":[{"maximum":32768,"type":"integer","minimum":1},{"type":"null"}]},"video_url":{"description":"Optional video to use as input context. Accepts an http(s)/data URL to a video file (downloaded and sent inline, max 15MB) or a YouTube URL (passed through to the model without downloading).","title":"Video URL","anyOf":[{"type":"string"},{"type":"null"}]}},"x-fal-order-properties":["prompt","image_urls","history","context","return_history","thinking_level","include_thoughts","temperature","top_p","max_output_tokens","num_images","seed","aspect_ratio","output_format","safety_tolerance","sync_mode","system_prompt","resolution","video_url","audio_url","pdf_url","limit_generations","enable_web_search","enable_image_search"],"type":"object","required":["prompt"],"title":"NanoBanana2ImageToImageInput"},"NanoBanana2EditOutput":{"properties":{"description":{"description":"The description of the generated images.","type":"string","title":"Description"},"grounding_metadata":{"description":"Provider grounding metadata for the generated images, including search queries, source pages and image-source attribution when available.","type":"array","title":"Grounding Metadata","items":{"type":"object"}},"conversations":{"description":"Reusable per-generation conversations, populated only when return_history is true. Retain every part and thought signature when continuing a conversation.","type":"array","title":"Conversations","items":{"$ref":"#/components/schemas/GeminiConversation"}},"images":{"description":"The edited images.","type":"array","title":"Images","examples":[[{"content_type":"image/png","file_name":"nano-banana-2-edit-output.png","url":"https://storage.googleapis.com/falserverless/example_outputs/nano-banana-2-edit-output.png"}]],"items":{"$ref":"#/components/schemas/ImageFile"}}},"x-fal-order-properties":["images","description","conversations","grounding_metadata"],"type":"object","required":["images","description"],"title":"NanoBanana2ImageToImageOutput"},"GeminiTextPart":{"additionalProperties":false,"properties":{"thought_signature":{"description":"Opaque provider-issued thought signature. Replay it unchanged on its original part.","title":"Thought Signature","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"type":{"description":"The text part discriminator.","type":"string","const":"text","title":"Type"},"thought":{"description":"Provider thought marker, preserved when replaying a returned conversation.","title":"Thought","anyOf":[{"type":"boolean"},{"type":"null"}]},"text":{"description":"Text at this position in the conversation.","type":"string","title":"Text"}},"x-fal-order-properties":["thought","thought_signature","type","text"],"type":"object","required":["type","text"],"title":"GeminiTextPart"},"GeminiImagePart":{"additionalProperties":false,"properties":{"thought_signature":{"description":"Opaque provider-issued thought signature. Replay it unchanged on its original part.","title":"Thought Signature","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"type":{"description":"The image part discriminator.","type":"string","const":"image","title":"Type"},"thought":{"description":"Provider thought marker, preserved when replaying a returned conversation.","title":"Thought","anyOf":[{"type":"boolean"},{"type":"null"}]},"image_url":{"description":"Original image URL or data URI. Replayed without resizing or re-encoding.","type":"string","title":"Image Url"}},"x-fal-order-properties":["thought","thought_signature","type","image_url"],"type":"object","required":["type","image_url"],"title":"GeminiImagePart"},"GeminiDocumentPart":{"additionalProperties":false,"properties":{"file_url":{"description":"PDF or UTF-8 plain-text document URL or data URI (up to 15 MB).","type":"string","title":"File Url"},"mime_type":{"description":"The document's media type.","enum":["application/pdf","text/plain"],"type":"string","title":"Mime Type"},"thought_signature":{"description":"Opaque provider-issued thought signature. Replay it unchanged on its original part.","title":"Thought Signature","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"type":{"description":"The document part discriminator.","type":"string","const":"document","title":"Type"},"thought":{"description":"Provider thought marker, preserved when replaying a returned conversation.","title":"Thought","anyOf":[{"type":"boolean"},{"type":"null"}]}},"x-fal-order-properties":["thought","thought_signature","type","file_url","mime_type"],"type":"object","required":["type","file_url","mime_type"],"title":"GeminiDocumentPart"},"GeminiVideoPart":{"additionalProperties":false,"properties":{"thought_signature":{"description":"Opaque provider-issued thought signature. Replay it unchanged on its original part.","title":"Thought Signature","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"type":{"description":"The video part discriminator.","type":"string","const":"video","title":"Type"},"thought":{"description":"Provider thought marker, preserved when replaying a returned conversation.","title":"Thought","anyOf":[{"type":"boolean"},{"type":"null"}]},"video_url":{"description":"Video URL or data URI (up to 15 MB and 120 seconds), or a YouTube URL. Supported by Flash Image only.","type":"string","title":"Video Url"}},"x-fal-order-properties":["thought","thought_signature","type","video_url"],"type":"object","required":["type","video_url"],"title":"GeminiVideoPart"},"GeminiSignaturePart":{"additionalProperties":false,"properties":{"thought_signature":{"description":"Provider-issued signature-only part, replayed unchanged.","type":"string","title":"Thought Signature","minLength":1},"type":{"description":"The signature part discriminator.","type":"string","const":"signature","title":"Type"},"thought":{"description":"Provider thought marker, preserved when replaying a returned conversation.","title":"Thought","anyOf":[{"type":"boolean"},{"type":"null"}]}},"x-fal-order-properties":["thought","thought_signature","type"],"type":"object","required":["thought_signature","type"],"title":"GeminiSignaturePart"},"GeminiVideoMessage":{"additionalProperties":false,"properties":{"parts":{"description":"Ordered text, image, document, video, audio, and signature parts.","minItems":1,"type":"array","title":"Parts","items":{"oneOf":[{"$ref":"#/components/schemas/GeminiTextPart"},{"$ref":"#/components/schemas/GeminiImagePart"},{"$ref":"#/components/schemas/GeminiDocumentPart"},{"$ref":"#/components/schemas/GeminiVideoPart"},{"$ref":"#/components/schemas/GeminiSignaturePart"},{"$ref":"#/components/schemas/GeminiAudioPart"}],"discriminator":{"propertyName":"type","mapping":{"image":"#/components/schemas/GeminiImagePart","document":"#/components/schemas/GeminiDocumentPart","text":"#/components/schemas/GeminiTextPart","video":"#/components/schemas/GeminiVideoPart","audio":"#/components/schemas/GeminiAudioPart","signature":"#/components/schemas/GeminiSignaturePart"}}}},"role":{"description":"Native Gemini conversation role.","enum":["user","model"],"type":"string","title":"Role"}},"x-fal-order-properties":["role","parts"],"type":"object","required":["role","parts"],"title":"GeminiVideoMessage"},"GeminiConversation":{"properties":{"messages":{"description":"One complete provider conversation. Pass messages as history in the next request, retaining every signature and part.","type":"array","title":"Messages","items":{"$ref":"#/components/schemas/GeminiVideoMessage"}}},"x-fal-order-properties":["messages"],"type":"object","required":["messages"],"title":"GeminiConversation"},"ImageFile":{"properties":{"width":{"description":"The width of the image","title":"Width","anyOf":[{"type":"integer"},{"type":"null"}]},"file_size":{"description":"The size of the file in bytes.","title":"File Size","anyOf":[{"type":"integer"},{"type":"null"}],"examples":[4404019]},"height":{"description":"The height of the image","title":"Height","anyOf":[{"type":"integer"},{"type":"null"}]},"content_type":{"description":"The mime type of the file.","title":"Content Type","anyOf":[{"type":"string"},{"type":"null"}],"examples":["image/png"]},"file_name":{"description":"The name of the file. It will be auto-generated if not provided.","title":"File Name","anyOf":[{"type":"string"},{"type":"null"}],"examples":["z9RV14K95DvU.png"]},"url":{"description":"The URL where the file can be downloaded from.","type":"string","title":"Url"}},"x-fal-order-properties":["url","content_type","file_name","file_size","width","height"],"type":"object","required":["url"],"title":"ImageFile"},"GeminiAudioPart":{"additionalProperties":false,"properties":{"thought_signature":{"description":"Opaque provider-issued thought signature. Replay it unchanged on its original part.","title":"Thought Signature","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"type":{"description":"The audio part discriminator.","type":"string","const":"audio","title":"Type"},"thought":{"description":"Provider thought marker, preserved when replaying a returned conversation.","title":"Thought","anyOf":[{"type":"boolean"},{"type":"null"}]},"audio_url":{"description":"Original audio URL or data URI from a previous Flash Image request (up to 15 MB).","type":"string","title":"Audio Url"}},"x-fal-order-properties":["thought","thought_signature","type","audio_url"],"type":"object","required":["type","audio_url"],"title":"GeminiAudioPart"}}},"paths":{"/fal-ai/nano-banana-2/edit/requests/{request_id}/status":{"get":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}},{"name":"logs","in":"query","required":false,"schema":{"type":"number","description":"Whether to include logs (`1`) in the response or not (`0`)."}}],"responses":{"200":{"description":"The request status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatus"}}}}}}},"/fal-ai/nano-banana-2/edit/requests/{request_id}/cancel":{"put":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}}],"responses":{"200":{"description":"The request was cancelled.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was cancelled successfully."}}}}}}}}},"/fal-ai/nano-banana-2/edit":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NanoBanana2EditInput"}}}},"responses":{"200":{"description":"The request status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatus"}}}}}}},"/fal-ai/nano-banana-2/edit/requests/{request_id}":{"get":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}}],"responses":{"200":{"description":"Result of the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NanoBanana2EditOutput"}}}}}}}},"servers":[{"url":"https://queue.fal.run"}],"security":[{"apiKeyAuth":[]}]} \ No newline at end of file diff --git a/pipeline/fal_schemas/fal-ai__nano-banana-pro__edit.json b/pipeline/fal_schemas/fal-ai__nano-banana-pro__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..4aac6f04a6b4e2c86f65cad3cda31f37d9fb117b --- /dev/null +++ b/pipeline/fal_schemas/fal-ai__nano-banana-pro__edit.json @@ -0,0 +1,1085 @@ +{ + "components": { + "schemas": { + "GeminiAudioPart": { + "additionalProperties": false, + "properties": { + "audio_url": { + "description": "Original audio URL or data URI from a previous Flash Image request (up to 15 MB).", + "title": "Audio Url", + "type": "string" + }, + "thought": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Provider thought marker, preserved when replaying a returned conversation.", + "title": "Thought" + }, + "thought_signature": { + "anyOf": [ + { + "minLength": 1, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Opaque provider-issued thought signature. Replay it unchanged on its original part.", + "title": "Thought Signature" + }, + "type": { + "const": "audio", + "description": "The audio part discriminator.", + "title": "Type", + "type": "string" + } + }, + "required": [ + "type", + "audio_url" + ], + "title": "GeminiAudioPart", + "type": "object", + "x-fal-order-properties": [ + "thought", + "thought_signature", + "type", + "audio_url" + ] + }, + "GeminiConversation": { + "properties": { + "messages": { + "description": "One complete provider conversation. Pass messages as history in the next request, retaining every signature and part.", + "items": { + "$ref": "#/components/schemas/GeminiVideoMessage" + }, + "title": "Messages", + "type": "array" + } + }, + "required": [ + "messages" + ], + "title": "GeminiConversation", + "type": "object", + "x-fal-order-properties": [ + "messages" + ] + }, + "GeminiDocumentPart": { + "additionalProperties": false, + "properties": { + "file_url": { + "description": "PDF or UTF-8 plain-text document URL or data URI (up to 15 MB).", + "title": "File Url", + "type": "string" + }, + "mime_type": { + "description": "The document's media type.", + "enum": [ + "application/pdf", + "text/plain" + ], + "title": "Mime Type", + "type": "string" + }, + "thought": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Provider thought marker, preserved when replaying a returned conversation.", + "title": "Thought" + }, + "thought_signature": { + "anyOf": [ + { + "minLength": 1, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Opaque provider-issued thought signature. Replay it unchanged on its original part.", + "title": "Thought Signature" + }, + "type": { + "const": "document", + "description": "The document part discriminator.", + "title": "Type", + "type": "string" + } + }, + "required": [ + "type", + "file_url", + "mime_type" + ], + "title": "GeminiDocumentPart", + "type": "object", + "x-fal-order-properties": [ + "thought", + "thought_signature", + "type", + "file_url", + "mime_type" + ] + }, + "GeminiImagePart": { + "additionalProperties": false, + "properties": { + "image_url": { + "description": "Original image URL or data URI. Replayed without resizing or re-encoding.", + "title": "Image Url", + "type": "string" + }, + "thought": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Provider thought marker, preserved when replaying a returned conversation.", + "title": "Thought" + }, + "thought_signature": { + "anyOf": [ + { + "minLength": 1, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Opaque provider-issued thought signature. Replay it unchanged on its original part.", + "title": "Thought Signature" + }, + "type": { + "const": "image", + "description": "The image part discriminator.", + "title": "Type", + "type": "string" + } + }, + "required": [ + "type", + "image_url" + ], + "title": "GeminiImagePart", + "type": "object", + "x-fal-order-properties": [ + "thought", + "thought_signature", + "type", + "image_url" + ] + }, + "GeminiMessage": { + "additionalProperties": false, + "properties": { + "parts": { + "description": "Ordered text, image, document, and signature parts.", + "items": { + "discriminator": { + "mapping": { + "document": "#/components/schemas/GeminiDocumentPart", + "image": "#/components/schemas/GeminiImagePart", + "signature": "#/components/schemas/GeminiSignaturePart", + "text": "#/components/schemas/GeminiTextPart" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/GeminiTextPart" + }, + { + "$ref": "#/components/schemas/GeminiImagePart" + }, + { + "$ref": "#/components/schemas/GeminiDocumentPart" + }, + { + "$ref": "#/components/schemas/GeminiSignaturePart" + } + ] + }, + "minItems": 1, + "title": "Parts", + "type": "array" + }, + "role": { + "description": "Native Gemini conversation role.", + "enum": [ + "user", + "model" + ], + "title": "Role", + "type": "string" + } + }, + "required": [ + "role", + "parts" + ], + "title": "GeminiMessage", + "type": "object", + "x-fal-order-properties": [ + "role", + "parts" + ] + }, + "GeminiSignaturePart": { + "additionalProperties": false, + "properties": { + "thought": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Provider thought marker, preserved when replaying a returned conversation.", + "title": "Thought" + }, + "thought_signature": { + "description": "Provider-issued signature-only part, replayed unchanged.", + "minLength": 1, + "title": "Thought Signature", + "type": "string" + }, + "type": { + "const": "signature", + "description": "The signature part discriminator.", + "title": "Type", + "type": "string" + } + }, + "required": [ + "thought_signature", + "type" + ], + "title": "GeminiSignaturePart", + "type": "object", + "x-fal-order-properties": [ + "thought", + "thought_signature", + "type" + ] + }, + "GeminiTextPart": { + "additionalProperties": false, + "properties": { + "text": { + "description": "Text at this position in the conversation.", + "title": "Text", + "type": "string" + }, + "thought": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Provider thought marker, preserved when replaying a returned conversation.", + "title": "Thought" + }, + "thought_signature": { + "anyOf": [ + { + "minLength": 1, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Opaque provider-issued thought signature. Replay it unchanged on its original part.", + "title": "Thought Signature" + }, + "type": { + "const": "text", + "description": "The text part discriminator.", + "title": "Type", + "type": "string" + } + }, + "required": [ + "type", + "text" + ], + "title": "GeminiTextPart", + "type": "object", + "x-fal-order-properties": [ + "thought", + "thought_signature", + "type", + "text" + ] + }, + "GeminiVideoMessage": { + "additionalProperties": false, + "properties": { + "parts": { + "description": "Ordered text, image, document, video, audio, and signature parts.", + "items": { + "discriminator": { + "mapping": { + "audio": "#/components/schemas/GeminiAudioPart", + "document": "#/components/schemas/GeminiDocumentPart", + "image": "#/components/schemas/GeminiImagePart", + "signature": "#/components/schemas/GeminiSignaturePart", + "text": "#/components/schemas/GeminiTextPart", + "video": "#/components/schemas/GeminiVideoPart" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/GeminiTextPart" + }, + { + "$ref": "#/components/schemas/GeminiImagePart" + }, + { + "$ref": "#/components/schemas/GeminiDocumentPart" + }, + { + "$ref": "#/components/schemas/GeminiVideoPart" + }, + { + "$ref": "#/components/schemas/GeminiSignaturePart" + }, + { + "$ref": "#/components/schemas/GeminiAudioPart" + } + ] + }, + "minItems": 1, + "title": "Parts", + "type": "array" + }, + "role": { + "description": "Native Gemini conversation role.", + "enum": [ + "user", + "model" + ], + "title": "Role", + "type": "string" + } + }, + "required": [ + "role", + "parts" + ], + "title": "GeminiVideoMessage", + "type": "object", + "x-fal-order-properties": [ + "role", + "parts" + ] + }, + "GeminiVideoPart": { + "additionalProperties": false, + "properties": { + "thought": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Provider thought marker, preserved when replaying a returned conversation.", + "title": "Thought" + }, + "thought_signature": { + "anyOf": [ + { + "minLength": 1, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Opaque provider-issued thought signature. Replay it unchanged on its original part.", + "title": "Thought Signature" + }, + "type": { + "const": "video", + "description": "The video part discriminator.", + "title": "Type", + "type": "string" + }, + "video_url": { + "description": "Video URL or data URI (up to 15 MB and 120 seconds), or a YouTube URL. Supported by Flash Image only.", + "title": "Video Url", + "type": "string" + } + }, + "required": [ + "type", + "video_url" + ], + "title": "GeminiVideoPart", + "type": "object", + "x-fal-order-properties": [ + "thought", + "thought_signature", + "type", + "video_url" + ] + }, + "ImageFile": { + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image", + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image", + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "ImageFile", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "NanoBananaProEditInput": { + "properties": { + "aspect_ratio": { + "anyOf": [ + { + "enum": [ + "auto", + "21:9", + "16:9", + "3:2", + "4:3", + "5:4", + "1:1", + "4:5", + "3:4", + "2:3", + "9:16", + "4:1", + "1:4", + "8:1", + "1:8" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "default": "auto", + "description": "The aspect ratio of the generated image, including 1:4, 4:1, 1:8 and 8:1.", + "title": "Aspect Ratio" + }, + "context": { + "description": "Ordered text, original images, PDF or UTF-8 text documents appended to the current prompt. Uses a native provider. Images count toward the total 14-reference limit.", + "items": { + "discriminator": { + "mapping": { + "document": "#/components/schemas/GeminiDocumentPart", + "image": "#/components/schemas/GeminiImagePart", + "signature": "#/components/schemas/GeminiSignaturePart", + "text": "#/components/schemas/GeminiTextPart" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/GeminiTextPart" + }, + { + "$ref": "#/components/schemas/GeminiImagePart" + }, + { + "$ref": "#/components/schemas/GeminiDocumentPart" + }, + { + "$ref": "#/components/schemas/GeminiSignaturePart" + } + ] + }, + "title": "Context", + "type": "array" + }, + "enable_web_search": { + "default": false, + "description": "Enable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image.", + "title": "Enable Web Search", + "type": "boolean" + }, + "history": { + "description": "Previous native user/model turns. Replay a returned conversation's messages unchanged, including thought signatures; the current prompt is appended as a new user turn.", + "items": { + "$ref": "#/components/schemas/GeminiMessage" + }, + "title": "History", + "type": "array" + }, + "image_urls": { + "description": "The URLs of the images to use for image-to-image generation or image editing.", + "examples": [ + [ + "https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input.png", + "https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input-2.png" + ] + ], + "items": { + "type": "string" + }, + "title": "Image URLs", + "type": "array" + }, + "include_thoughts": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Whether to include thought summaries. Omit to preserve the existing behavior: an explicit thinking_level requests summaries. Set limit_generations=false to return summary text in description. This does not disable thinking or return intermediate thought images.", + "title": "Include Thoughts" + }, + "limit_generations": { + "default": true, + "description": "Experimental parameter to limit the number of generations from each round of prompting to 1. Set to `True` to to disregard any instructions in the prompt regarding the number of images to generate.", + "title": "Limit Generations", + "type": "boolean" + }, + "max_output_tokens": { + "anyOf": [ + { + "maximum": 32768, + "minimum": 1, + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum output tokens for the generation. Omit to retain the provider default. Explicit values use a direct Google or Vertex API.", + "title": "Max Output Tokens" + }, + "num_images": { + "default": 1, + "description": "The number of images to generate.", + "maximum": 4, + "minimum": 1, + "title": "Number of Images", + "type": "integer" + }, + "output_format": { + "default": "png", + "description": "The format of the generated image.", + "enum": [ + "jpeg", + "png", + "webp" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "The prompt for image editing.", + "examples": [ + "make a photo of the man driving the car down the california coastline" + ], + "maxLength": 50000, + "minLength": 3, + "title": "Prompt", + "type": "string" + }, + "resolution": { + "default": "1K", + "description": "The resolution of the image to generate.", + "enum": [ + "1K", + "2K", + "4K" + ], + "title": "Resolution", + "type": "string" + }, + "return_history": { + "default": false, + "description": "Return reusable native conversations with original image parts and provider thought signatures. Uses a native provider. Each generated conversation is independent; send its messages as history for the next turn.", + "title": "Return History", + "type": "boolean" + }, + "safety_tolerance": { + "default": "4", + "description": "The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.", + "enum": [ + "1", + "2", + "3", + "4", + "5", + "6" + ], + "title": "Safety Tolerance", + "type": "string" + }, + "seed": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The seed for the random number generator.", + "title": "Seed" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.", + "title": "Sync Mode", + "type": "boolean" + }, + "system_prompt": { + "default": "", + "description": "Optional system instruction that steers the model's persona and output style across the request. Leave blank to omit; when provided, it is sent as the system instruction to Gemini (or as a system message on OpenAI-compatible providers).", + "maxLength": 50000, + "title": "System Prompt", + "type": "string" + }, + "temperature": { + "anyOf": [ + { + "maximum": 2, + "minimum": 0, + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Sampling temperature. Omit to use the provider default of 1. Explicit values use a direct Google or Vertex API.", + "title": "Temperature" + }, + "thinking_level": { + "anyOf": [ + { + "const": "high", + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Thinking effort. Pro Image supports only high; omit to retain its provider default. An explicit level requests summaries unless include_thoughts overrides it. Thinking cannot be disabled.", + "title": "Thinking Level" + }, + "top_p": { + "anyOf": [ + { + "maximum": 1, + "minimum": 0, + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Nucleus sampling probability. Omit to use the provider default of 0.95. Explicit values use a direct Google or Vertex API.", + "title": "Top P" + } + }, + "required": [ + "prompt" + ], + "title": "NanoBananaImageToImageInput", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_urls", + "history", + "context", + "return_history", + "thinking_level", + "include_thoughts", + "temperature", + "top_p", + "max_output_tokens", + "num_images", + "seed", + "aspect_ratio", + "output_format", + "safety_tolerance", + "sync_mode", + "system_prompt", + "resolution", + "limit_generations", + "enable_web_search" + ] + }, + "NanoBananaProEditOutput": { + "properties": { + "conversations": { + "description": "Reusable per-generation conversations, populated only when return_history is true. Retain every part and thought signature when continuing a conversation.", + "items": { + "$ref": "#/components/schemas/GeminiConversation" + }, + "title": "Conversations", + "type": "array" + }, + "description": { + "description": "The description of the generated images.", + "title": "Description", + "type": "string" + }, + "grounding_metadata": { + "description": "Provider grounding metadata for the generated images, including search queries, source pages and image-source attribution when available.", + "items": { + "type": "object" + }, + "title": "Grounding Metadata", + "type": "array" + }, + "images": { + "description": "The edited images.", + "examples": [ + [ + { + "content_type": "image/png", + "file_name": "nano-banana-pro-edit-output.png", + "url": "https://storage.googleapis.com/falserverless/example_outputs/nano-banana-pro-edit-output.png" + } + ] + ], + "items": { + "$ref": "#/components/schemas/ImageFile" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images", + "description" + ], + "title": "NanoBananaImageToImageOutput", + "type": "object", + "x-fal-order-properties": [ + "images", + "description", + "conversations", + "grounding_metadata" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the fal-ai/nano-banana-pro/edit queue.", + "title": "Queue OpenAPI for fal-ai/nano-banana-pro/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Gemini 3 Pro Image is a text-to-image model that generates images from text descriptions.\n\nDecompression-bomb inputs to ``image_urls`` are rejected upstream by\n``validate_image_async`` (called from ``GoogleAIClient._format_image``):\nthe validator now enforces a header-only ``max_image_pixels`` cap\n(default 89,478,485 \u2248 PIL's ``MAX_IMAGE_PIXELS``) *before* any pixel\ndecode, so oversized inputs raise a deterministic 422\n``image_too_large`` instead of OOM-killing the runner and taking out\nevery multiplexed request on it (``max_multiplexing=20``).", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/fal-ai/nano-banana-pro/edit/api", + "endpointId": "fal-ai/nano-banana-pro/edit", + "playgroundUrl": "https://fal.ai/models/fal-ai/nano-banana-pro/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0a9c2f0f/p3rXI18zMYTBz1M0qP2h4_b9a2087ce0b64cd788cb5ec067edc26e.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/fal-ai/nano-banana-pro/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NanoBananaProEditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/fal-ai/nano-banana-pro/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NanoBananaProEditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/fal-ai/nano-banana-pro/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/fal-ai/nano-banana-pro/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/fal-ai__qwen-image-edit-2511.json b/pipeline/fal_schemas/fal-ai__qwen-image-edit-2511.json new file mode 100644 index 0000000000000000000000000000000000000000..564450648a7334a9c5dfdd2f920013a723266fa5 --- /dev/null +++ b/pipeline/fal_schemas/fal-ai__qwen-image-edit-2511.json @@ -0,0 +1 @@ +{"openapi":"3.1.0","info":{"title":"Queue OpenAPI for fal-ai/qwen-image-edit-2511","version":"1.0.0","description":"The OpenAPI schema for the fal-ai/qwen-image-edit-2511 queue.","x-fal-metadata":{"endpointId":"fal-ai/qwen-image-edit-2511","category":"image-to-image","thumbnailUrl":"https://v3b.fal.media/files/b/0a875820/o5xKLpZ3or9XkGYggf5wi_7470c2b213204f9eb76589e8958e4e81.jpg","playgroundUrl":"https://fal.ai/models/fal-ai/qwen-image-edit-2511","documentationUrl":"https://fal.ai/models/fal-ai/qwen-image-edit-2511/api","about":"Edit images using Qwen Image Edit 2511"}},"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Fal Key"}},"schemas":{"QueueStatus":{"type":"object","properties":{"status":{"type":"string","enum":["IN_QUEUE","IN_PROGRESS","COMPLETED"]},"request_id":{"type":"string","description":"The request id."},"response_url":{"type":"string","description":"The response url."},"status_url":{"type":"string","description":"The status url."},"cancel_url":{"type":"string","description":"The cancel url."},"logs":{"type":"object","description":"The logs.","additionalProperties":true},"metrics":{"type":"object","description":"The metrics.","additionalProperties":true},"queue_position":{"type":"integer","description":"The queue position."}},"required":["status","request_id"]},"QwenImageEdit2511Input":{"x-fal-order-properties":["prompt","negative_prompt","image_size","image_urls","num_inference_steps","guidance_scale","seed","sync_mode","num_images","enable_safety_checker","output_format","acceleration"],"required":["prompt","image_urls"],"title":"EditImageInput","type":"object","properties":{"prompt":{"type":"string","title":"Prompt","examples":["Change angle to front view"],"description":"The prompt to edit the image with."},"image_urls":{"items":{"type":"string"},"title":"Image URLs","examples":[["https://v3b.fal.media/files/b/0a877afe/karyVuQ62j0V6ErYzyW-w_image_6.png"]],"description":"The URLs of the images to edit.","type":"array"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"The same seed and the same prompt given to the same version of the model will output the same image every time."},"output_format":{"enum":["jpeg","png","webp"],"default":"png","title":"Output Format","description":"The format of the generated image.","type":"string"},"image_size":{"anyOf":[{"$ref":"#/components/schemas/ImageSize"},{"enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9"],"type":"string"},{"type":"null"}],"title":"Image Size","description":"The size of the generated image. If None, uses the input image dimensions."},"num_images":{"minimum":1,"type":"integer","default":1,"title":"Num Images","description":"The number of images to generate.","maximum":4},"enable_safety_checker":{"type":"boolean","default":true,"title":"Enable Safety Checker","description":"If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked."},"num_inference_steps":{"minimum":1,"type":"integer","default":28,"title":"Num Inference Steps","description":"The number of inference steps to perform.","maximum":50},"acceleration":{"enum":["none","regular","high"],"default":"regular","title":"Acceleration","description":"The acceleration level to use.","type":"string"},"negative_prompt":{"type":"string","default":"","title":"Negative Prompt","description":"The negative prompt to generate an image from."},"guidance_scale":{"minimum":1,"type":"number","default":4.5,"title":"Guidance Scale","description":"The guidance scale to use for the image generation.","maximum":20},"sync_mode":{"type":"boolean","default":false,"title":"Sync Mode","description":"If `True`, the media will be returned as a data URI."}}},"QwenImageEdit2511Output":{"x-fal-order-properties":["images","timings","seed","has_nsfw_concepts","prompt"],"required":["images","timings","seed","has_nsfw_concepts","prompt"],"title":"ImageToImageOutput","type":"object","properties":{"timings":{"additionalProperties":{"type":"number"},"type":"object","title":"Timings"},"images":{"items":{"$ref":"#/components/schemas/Image"},"title":"Images","examples":[[{"height":768,"width":1376,"content_type":"image/png","url":"https://v3b.fal.media/files/b/0a877afe/InJJA0Q1gtQnyK1N3wdg5.png"}]],"description":"The generated image files info.","type":"array"},"prompt":{"type":"string","title":"Prompt","description":"The prompt used for generating the image."},"has_nsfw_concepts":{"items":{"type":"boolean"},"title":"Has Nsfw Concepts","description":"Whether the generated images contain NSFW concepts.","type":"array"},"seed":{"type":"integer","title":"Seed","description":"\n Seed of the generated Image. It will be the same value of the one passed in the\n input or the randomly generated that was used in case none was passed.\n "}}},"ImageSize":{"x-fal-order-properties":["width","height"],"type":"object","title":"ImageSize","properties":{"height":{"exclusiveMinimum":0,"type":"integer","default":512,"title":"Height","description":"The height of the generated image.","maximum":14142},"width":{"exclusiveMinimum":0,"type":"integer","default":512,"title":"Width","description":"The width of the generated image.","maximum":14142}}},"Image":{"x-fal-order-properties":["url","width","height","content_type"],"required":["url","width","height"],"title":"Image","type":"object","properties":{"height":{"type":"integer","title":"Height"},"width":{"type":"integer","title":"Width"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"image/jpeg","title":"Content Type"},"url":{"type":"string","title":"Url"}}}}},"paths":{"/fal-ai/qwen-image-edit-2511/requests/{request_id}/status":{"get":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}},{"name":"logs","in":"query","required":false,"schema":{"type":"number","description":"Whether to include logs (`1`) in the response or not (`0`)."}}],"responses":{"200":{"description":"The request status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatus"}}}}}}},"/fal-ai/qwen-image-edit-2511/requests/{request_id}/cancel":{"put":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}}],"responses":{"200":{"description":"The request was cancelled.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was cancelled successfully."}}}}}}}}},"/fal-ai/qwen-image-edit-2511":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QwenImageEdit2511Input"}}}},"responses":{"200":{"description":"The request status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatus"}}}}}}},"/fal-ai/qwen-image-edit-2511/requests/{request_id}":{"get":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}}],"responses":{"200":{"description":"Result of the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QwenImageEdit2511Output"}}}}}}}},"servers":[{"url":"https://queue.fal.run"}],"security":[{"apiKeyAuth":[]}]} \ No newline at end of file diff --git a/pipeline/fal_schemas/fal-ai__wan__v2.7__pro__edit.json b/pipeline/fal_schemas/fal-ai__wan__v2.7__pro__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..2123a2787cebb9dc388c2b0d9d3d037b743f0311 --- /dev/null +++ b/pipeline/fal_schemas/fal-ai__wan__v2.7__pro__edit.json @@ -0,0 +1,449 @@ +{ + "components": { + "schemas": { + "File": { + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + } + }, + "required": [ + "url" + ], + "title": "File", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size" + ] + }, + "ImageSize": { + "properties": { + "height": { + "default": 512, + "description": "The height of the generated image.", + "exclusiveMinimum": 0, + "maximum": 14142, + "title": "Height", + "type": "integer" + }, + "width": { + "default": 512, + "description": "The width of the generated image.", + "exclusiveMinimum": 0, + "maximum": 14142, + "title": "Width", + "type": "integer" + } + }, + "title": "ImageSize", + "type": "object", + "x-fal-order-properties": [ + "width", + "height" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + }, + "WanV27ProEditInput": { + "properties": { + "enable_prompt_expansion": { + "default": true, + "description": "Enable DashScope prompt expansion. Supported only for image edit mode.", + "title": "Enable Prompt Expansion", + "type": "boolean" + }, + "enable_safety_checker": { + "default": true, + "description": "Enable content moderation for input and output. Disabling it requires account authorization; unauthorized requests are always checked.", + "title": "Enable Safety Checker", + "type": "boolean" + }, + "image_size": { + "anyOf": [ + { + "$ref": "#/components/schemas/ImageSize" + }, + { + "enum": [ + "square_hd", + "square", + "portrait_4_3", + "portrait_16_9", + "landscape_4_3", + "landscape_16_9" + ], + "type": "string" + } + ], + "default": "square_hd", + "description": "Output image size. Uses fal image size presets or explicit dimensions and is converted to DashScope size format.", + "title": "Image Size" + }, + "image_urls": { + "description": "Reference images for editing (1-4 images required). Order matters: reference them as image 1, image 2, image 3, image 4 in the prompt.", + "examples": [ + [ + "https://storage.googleapis.com/falserverless/model_tests/wan/dragon-warrior.jpg" + ] + ], + "items": { + "type": "string" + }, + "title": "Image Urls", + "type": "array" + }, + "negative_prompt": { + "anyOf": [ + { + "maxLength": 500, + "type": "string" + }, + { + "type": "null" + } + ], + "default": "", + "description": "Content to avoid in the generated image. Max 500 characters.", + "title": "Negative Prompt" + }, + "num_images": { + "default": 1, + "description": "Number of images to generate (1-4).", + "maximum": 4, + "minimum": 1, + "title": "Num Images", + "type": "integer" + }, + "output_format": { + "default": "jpeg", + "description": "The format of the generated images.", + "enum": [ + "jpeg", + "png", + "webp" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "Text prompt describing the desired image edit. Supports Chinese and English.", + "examples": [ + "Turn image 1 into a watercolor painting." + ], + "maxLength": 2000, + "minLength": 1, + "title": "Prompt", + "type": "string" + }, + "seed": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Random seed for reproducibility (0-2147483647).", + "title": "Seed" + } + }, + "required": [ + "prompt", + "image_urls" + ], + "title": "Wan27ImageEditInput", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_urls", + "negative_prompt", + "image_size", + "num_images", + "enable_prompt_expansion", + "seed", + "enable_safety_checker", + "output_format" + ] + }, + "WanV27ProEditOutput": { + "properties": { + "images": { + "description": "Generated images.", + "items": { + "$ref": "#/components/schemas/File" + }, + "title": "Images", + "type": "array" + }, + "seed": { + "description": "The seed used for generation.", + "title": "Seed", + "type": "integer" + } + }, + "required": [ + "images", + "seed" + ], + "title": "Wan27ImageEditOutput", + "type": "object", + "x-fal-order-properties": [ + "images", + "seed" + ] + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the fal-ai/wan/v2.7/pro/edit queue.", + "title": "Queue OpenAPI for fal-ai/wan/v2.7/pro/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Pro Image Edit", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/fal-ai/wan/v2.7/pro/edit/api", + "endpointId": "fal-ai/wan/v2.7/pro/edit", + "playgroundUrl": "https://fal.ai/models/fal-ai/wan/v2.7/pro/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0a94816f/BhHA2kmKyAQ8vJxw_HPQ4_2b4b35f0fbb0449195d84178ba988112.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/fal-ai/wan/v2.7/pro/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WanV27ProEditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/fal-ai/wan/v2.7/pro/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WanV27ProEditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/fal-ai/wan/v2.7/pro/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/fal-ai/wan/v2.7/pro/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/google__nano-banana-2.1__edit.json b/pipeline/fal_schemas/google__nano-banana-2.1__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..23e753614a0f9ad22a006214e06d6e0399d3cba1 --- /dev/null +++ b/pipeline/fal_schemas/google__nano-banana-2.1__edit.json @@ -0,0 +1,539 @@ +{ + "components": { + "schemas": { + "ImageFile": { + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image", + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image", + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "ImageFile", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "NanoBanana21EditInput": { + "properties": { + "aspect_ratio": { + "anyOf": [ + { + "enum": [ + "auto", + "21:9", + "16:9", + "3:2", + "4:3", + "5:4", + "1:1", + "4:5", + "3:4", + "2:3", + "9:16", + "4:1", + "1:4", + "8:1", + "1:8" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "default": "auto", + "description": "The aspect ratio of the generated image. Supports extreme ratios: 4:1, 1:4, 8:1, 1:8.", + "title": "Aspect Ratio" + }, + "enable_web_search": { + "default": false, + "description": "Enable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image.", + "title": "Enable Web Search", + "type": "boolean" + }, + "image_urls": { + "description": "The URLs of the images to use for image-to-image generation or image editing. Optional when `video_url` or `pdf_url` is provided.", + "examples": [ + [ + "https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input.png", + "https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input-2.png" + ] + ], + "items": { + "type": "string" + }, + "title": "Image URLs", + "type": "array" + }, + "limit_generations": { + "default": true, + "description": "Experimental parameter to limit the number of generations from each round of prompting to 1. Set to `True` to to disregard any instructions in the prompt regarding the number of images to generate and ignore any intermediate images generated by the model. This may affect generation quality.", + "title": "Limit Generations", + "type": "boolean" + }, + "num_images": { + "default": 1, + "description": "The number of images to generate.", + "maximum": 4, + "minimum": 1, + "title": "Number of Images", + "type": "integer" + }, + "output_format": { + "default": "png", + "description": "The format of the generated image.", + "enum": [ + "jpeg", + "png", + "webp" + ], + "title": "Output Format", + "type": "string" + }, + "pdf_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Optional PDF document to use as input context. Accepts an http(s)/data URL (downloaded and sent inline, max 15MB).", + "title": "PDF URL" + }, + "prompt": { + "description": "The prompt for image editing.", + "examples": [ + "make a photo of the man driving the car down the california coastline" + ], + "maxLength": 50000, + "minLength": 3, + "title": "Prompt", + "type": "string" + }, + "resolution": { + "default": "1K", + "description": "The resolution of the image to generate.", + "enum": [ + "1K", + "2K", + "4K" + ], + "title": "Resolution", + "type": "string" + }, + "safety_tolerance": { + "default": "4", + "description": "The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.", + "enum": [ + "1", + "2", + "3", + "4", + "5", + "6" + ], + "title": "Safety Tolerance", + "type": "string" + }, + "seed": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The seed for the random number generator.", + "title": "Seed" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.", + "title": "Sync Mode", + "type": "boolean" + }, + "system_prompt": { + "default": "", + "description": "Optional system instruction that steers the model's persona and output style across the request. Leave blank to omit; when provided, it is sent as the system instruction to Gemini (or as a system message on OpenAI-compatible providers).", + "maxLength": 50000, + "title": "System Prompt", + "type": "string" + }, + "thinking_level": { + "anyOf": [ + { + "enum": [ + "minimal", + "medium", + "high" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "default": "medium", + "description": "How much the model reasons before generating. Higher levels can improve complex compositions and use more thinking tokens.", + "title": "Thinking Level" + }, + "video_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Optional video to use as input context. Accepts an http(s)/data URL to a video file (downloaded and sent inline, max 15MB) or a YouTube URL (passed through to the model without downloading).", + "title": "Video URL" + } + }, + "required": [ + "prompt" + ], + "title": "NanoBanana21ImageToImageInput", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "num_images", + "seed", + "aspect_ratio", + "output_format", + "safety_tolerance", + "sync_mode", + "image_urls", + "system_prompt", + "resolution", + "video_url", + "pdf_url", + "limit_generations", + "enable_web_search", + "thinking_level" + ] + }, + "NanoBanana21EditOutput": { + "properties": { + "description": { + "description": "The description of the generated images.", + "title": "Description", + "type": "string" + }, + "images": { + "description": "The edited images.", + "examples": [ + [ + { + "content_type": "image/png", + "file_name": "nano-banana-multi-edit-output.png", + "url": "https://storage.googleapis.com/falserverless/example_outputs/nano-banana-multi-edit-output.png" + } + ] + ], + "items": { + "$ref": "#/components/schemas/ImageFile" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images", + "description" + ], + "title": "NanoBanana21ImageToImageOutput", + "type": "object", + "x-fal-order-properties": [ + "images", + "description" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the google/nano-banana-2.1/edit queue.", + "title": "Queue OpenAPI for google/nano-banana-2.1/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Nano Banana 2.1 is an image editing model that edits images from text descriptions.", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/google/nano-banana-2.1/edit/api", + "endpointId": "google/nano-banana-2.1/edit", + "playgroundUrl": "https://fal.ai/models/google/nano-banana-2.1/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0aaad14e/urvX9oiQqWKRcaZngAlID.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/google/nano-banana-2.1/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NanoBanana21EditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/google/nano-banana-2.1/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NanoBanana21EditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/google/nano-banana-2.1/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/google/nano-banana-2.1/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/ideogram__v4.5__edit.json b/pipeline/fal_schemas/ideogram__v4.5__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..9e9c3e52e05f5fc72e478f910365bdacb75381bc --- /dev/null +++ b/pipeline/fal_schemas/ideogram__v4.5__edit.json @@ -0,0 +1,537 @@ +{ + "components": { + "schemas": { + "ContextWindowBox": { + "properties": { + "x_max": { + "description": "Right edge in source pixels (exclusive).", + "minimum": 0, + "title": "X Max", + "type": "integer" + }, + "x_min": { + "description": "Left edge in source pixels (inclusive).", + "minimum": 0, + "title": "X Min", + "type": "integer" + }, + "y_max": { + "description": "Bottom edge in source pixels (exclusive).", + "minimum": 0, + "title": "Y Max", + "type": "integer" + }, + "y_min": { + "description": "Top edge in source pixels (inclusive).", + "minimum": 0, + "title": "Y Min", + "type": "integer" + } + }, + "required": [ + "x_min", + "y_min", + "x_max", + "y_max" + ], + "title": "ContextWindowBox", + "type": "object", + "x-fal-order-properties": [ + "x_min", + "y_min", + "x_max", + "y_max" + ] + }, + "File": { + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + } + }, + "required": [ + "url" + ], + "title": "File", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size" + ] + }, + "ImageSize": { + "properties": { + "height": { + "default": 512, + "description": "The height of the generated image.", + "exclusiveMinimum": 0, + "maximum": 14142, + "title": "Height", + "type": "integer" + }, + "width": { + "default": 512, + "description": "The width of the generated image.", + "exclusiveMinimum": 0, + "maximum": 14142, + "title": "Width", + "type": "integer" + } + }, + "title": "ImageSize", + "type": "object", + "x-fal-order-properties": [ + "width", + "height" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + }, + "V45EditInput": { + "additionalProperties": false, + "properties": { + "context_window": { + "default": "none", + "description": "Region to edit with high edit_precision. none edits the whole image, downscaled to at most 4194304 pixels. auto requires mask_url and fits the region around the mask; an oversized mask falls back to whole-image editing. Set context_window_box instead to pick the region yourself. Localized edits preserve the original image resolution and every pixel outside the region.", + "enum": [ + "none", + "auto" + ], + "title": "Context Window", + "type": "string" + }, + "context_window_box": { + "anyOf": [ + { + "$ref": "#/components/schemas/ContextWindowBox" + }, + { + "type": "null" + } + ], + "description": "Explicit region to edit with high edit_precision, in source pixels with exclusive x_max/y_max. Must lie inside the image, measure at least 256 pixels per side, cover at most 4194304 pixels, and have an aspect ratio within 1:6 and 6:1. A mask may select only pixels inside it. Cannot be combined with context_window auto. Leave unset to edit the whole image." + }, + "edit_precision": { + "default": "regular", + "description": "regular uses Generate; high uses Precise Edit with unchanged-pixel restoration. Both always prepare structured edit instructions.", + "enum": [ + "regular", + "high" + ], + "title": "Edit Precision", + "type": "string" + }, + "enable_safety_checker": { + "default": true, + "description": "Authorized callers may set false to request relaxed screening.", + "title": "Enable Safety Checker", + "type": "boolean" + }, + "image_size": { + "anyOf": [ + { + "$ref": "#/components/schemas/ImageSize" + }, + { + "enum": [ + "auto", + "square", + "square_hd", + "portrait_4_3", + "landscape_4_3", + "portrait_16_9", + "landscape_16_9" + ], + "type": "string" + } + ], + "default": "auto", + "description": "auto preserves source geometry, downscaled by the provider if needed. Only unmasked regular edits accept named presets or custom sizes: dimensions >=256, multiples of 32, area <=4194304, ratio <=6:1. Named presets use standard fal dimensions.", + "title": "Image Size" + }, + "image_url": { + "description": "Primary source image to edit.", + "title": "Image URL", + "type": "string" + }, + "mask_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mask matching the source dimensions. Black edits, white preserves. Must contain both regions after rounding.", + "title": "Mask URL" + }, + "num_images": { + "default": 1, + "description": "Number of images to generate.", + "maximum": 8, + "minimum": 1, + "title": "Number of Images", + "type": "integer" + }, + "prompt": { + "description": "The generation or editing prompt.", + "examples": [ + "A colorful storefront with a sign reading hello" + ], + "maxLength": 10000, + "minLength": 1, + "title": "Prompt", + "type": "string" + }, + "quality": { + "default": "medium", + "description": "Quality tier for either edit precision. Defaults to medium.", + "enum": [ + "very_low", + "low", + "medium", + "high" + ], + "title": "Quality", + "type": "string" + }, + "reference_image_urls": { + "description": "Up to four references plus the primary source, or three references plus the primary source and mask.", + "items": { + "type": "string" + }, + "maxItems": 4, + "title": "Reference Image URLs", + "type": "array" + }, + "seed": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Random seed. Omit to choose automatically.", + "title": "Seed" + }, + "sync_mode": { + "default": false, + "description": "Return image data directly in the response.", + "title": "Sync Mode", + "type": "boolean" + } + }, + "required": [ + "prompt", + "image_url" + ], + "title": "EditInputV45", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_url", + "reference_image_urls", + "mask_url", + "edit_precision", + "context_window", + "context_window_box", + "quality", + "image_size", + "num_images", + "seed", + "sync_mode", + "enable_safety_checker" + ] + }, + "V45EditOutput": { + "properties": { + "images": { + "examples": [ + [ + { + "url": "https://v3.fal.media/files/penguin/lHdRabS80guysb8Zw1kul_image.png" + } + ] + ], + "items": { + "$ref": "#/components/schemas/File" + }, + "title": "Images", + "type": "array" + }, + "seed": { + "description": "Seed used for the random number generator", + "examples": [ + 123456 + ], + "title": "Seed", + "type": "integer" + } + }, + "required": [ + "images", + "seed" + ], + "title": "OutputV3", + "type": "object", + "x-fal-order-properties": [ + "images", + "seed" + ] + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "Ideogram 4.5 editing. Provide a source image and a prompt, plus up to 4 reference images (3 when a mask is used). edit_precision: regular (default) or high, which uses Precise Edit and restores unchanged pixels. Quality: very_low to high for regular, low to very_high for high precision. Output keeps the source size by default (image_size auto).", + "title": "Queue OpenAPI for ideogram/v4.5/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Ideogram V45 Edit", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/ideogram/v4.5/edit/api", + "endpointId": "ideogram/v4.5/edit", + "playgroundUrl": "https://fal.ai/models/ideogram/v4.5/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0aac785d/9OnZ_rkZGyh50x2626HB9.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/ideogram/v4.5/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V45EditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/ideogram/v4.5/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V45EditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/ideogram/v4.5/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/ideogram/v4.5/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/luma__agent__uni-1__v1__max__edit.json b/pipeline/fal_schemas/luma__agent__uni-1__v1__max__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..d2ce480c41bca3fee75fbb3b03d8fcc34df59730 --- /dev/null +++ b/pipeline/fal_schemas/luma__agent__uni-1__v1__max__edit.json @@ -0,0 +1,378 @@ +{ + "components": { + "schemas": { + "AgentUni1V1MaxEditInput": { + "properties": { + "enable_safety_checker": { + "default": true, + "description": "Authorized callers may set false to request relaxed screening.", + "title": "Enable Safety Checker", + "type": "boolean" + }, + "image_url": { + "description": "URL of the source image to edit.", + "examples": [ + "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png" + ], + "title": "Image Url", + "type": "string" + }, + "output_format": { + "anyOf": [ + { + "enum": [ + "png", + "jpeg" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Encoding format of the edited image.", + "title": "Output Format" + }, + "prompt": { + "description": "Text prompt describing the edit to apply.", + "examples": [ + "Replace the background with a sunset over the ocean." + ], + "maxLength": 6000, + "minLength": 1, + "title": "Prompt", + "type": "string" + }, + "reference_image_urls": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "maxItems": 8, + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Optional list of reference image URLs used to guide the edit.", + "title": "Reference Image Urls" + }, + "style": { + "default": "auto", + "description": "Visual style of the edited image.", + "enum": [ + "auto", + "manga" + ], + "title": "Style", + "type": "string" + } + }, + "required": [ + "prompt", + "image_url" + ], + "title": "ImageEditRequest", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_url", + "style", + "output_format", + "reference_image_urls", + "enable_safety_checker" + ] + }, + "AgentUni1V1MaxEditOutput": { + "properties": { + "images": { + "description": "The generated image(s).", + "items": { + "$ref": "#/components/schemas/File" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "ImageOutput", + "type": "object", + "x-fal-order-properties": [ + "images" + ] + }, + "File": { + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + } + }, + "required": [ + "url" + ], + "title": "File", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the luma/agent/uni-1/v1/max/edit queue.", + "title": "Queue OpenAPI for luma/agent/uni-1/v1/max/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Edit Image Max", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/luma/agent/uni-1/v1/max/edit/api", + "endpointId": "luma/agent/uni-1/v1/max/edit", + "playgroundUrl": "https://fal.ai/models/luma/agent/uni-1/v1/max/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0a9d98fd/-vUZCkQbk_HxqDUKgcvo6_6b69ed5b53c74a6ba900168b8ad17e71.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/luma/agent/uni-1/v1/max/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentUni1V1MaxEditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/luma/agent/uni-1/v1/max/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgentUni1V1MaxEditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/luma/agent/uni-1/v1/max/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/luma/agent/uni-1/v1/max/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/meta__muse-image__edit.json b/pipeline/fal_schemas/meta__muse-image__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..46a203900d2d0af83195b6f1e3c7cdd3af7ed172 --- /dev/null +++ b/pipeline/fal_schemas/meta__muse-image__edit.json @@ -0,0 +1,410 @@ +{ + "components": { + "schemas": { + "Image": { + "description": "Represents an image file.", + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image in pixels.", + "examples": [ + 1024 + ], + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image in pixels.", + "examples": [ + 1024 + ], + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "Image", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "MuseImageEditInput": { + "properties": { + "aspect_ratio": { + "anyOf": [ + { + "pattern": "^[1-9][0-9]{0,4}:[1-9][0-9]{0,4}$", + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Any custom output aspect ratio as \"width:height\", for example \"16:9\", \"5:4\", or \"1920:1200\". Common presets are \"21:9\", \"16:9\", \"4:3\", \"3:2\", \"1:1\", \"2:3\", \"3:4\", \"9:16\", \"9:21\". The ratio must be between 1:16 and 16:1, the range Muse supports. Only the ratio is used: Muse renders it at its own fixed resolution of roughly 2.5 megapixels, so \"1920:1200\" and \"960:600\" both return the same 1920x1200 image. If omitted, Muse chooses the output dimensions automatically.", + "examples": [ + "16:9" + ], + "title": "Aspect Ratio" + }, + "image_urls": { + "description": "Reference images used for the edit. Provide between 1 and 10 HTTP(S) or data URLs.", + "examples": [ + [ + "https://storage.googleapis.com/falserverless/example_inputs/kontext_example_input.webp" + ] + ], + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "title": "Image URLs", + "type": "array" + }, + "num_images": { + "default": 1, + "description": "The number of edited images to generate.", + "maximum": 10, + "minimum": 1, + "title": "Num Images", + "type": "integer" + }, + "output_format": { + "default": "webp", + "description": "The format of the generated image.", + "enum": [ + "jpeg", + "png", + "webp" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "The text prompt used to generate or edit the image.", + "examples": [ + "A cinematic editorial portrait in soft window light with crisp typography" + ], + "minLength": 1, + "title": "Prompt", + "type": "string" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the image is returned as a data URI and is not persisted in the request history.", + "title": "Sync Mode", + "type": "boolean" + } + }, + "required": [ + "prompt", + "image_urls" + ], + "title": "MuseImageEditInput", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_urls", + "aspect_ratio", + "num_images", + "output_format", + "sync_mode" + ] + }, + "MuseImageEditOutput": { + "properties": { + "images": { + "description": "The generated or edited images.", + "items": { + "$ref": "#/components/schemas/Image" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "MuseImageOutput", + "type": "object", + "x-fal-order-properties": [ + "images" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the meta/muse-image/edit queue.", + "title": "Queue OpenAPI for meta/muse-image/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Edit", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/meta/muse-image/edit/api", + "endpointId": "meta/muse-image/edit", + "playgroundUrl": "https://fal.ai/models/meta/muse-image/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0aa743e9/p2RjYTFPCviexLZ_6oYmv.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/meta/muse-image/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MuseImageEditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/meta/muse-image/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MuseImageEditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/meta/muse-image/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/meta/muse-image/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/microsoft__mai-image-2.5-pro__edit.json b/pipeline/fal_schemas/microsoft__mai-image-2.5-pro__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..4b89a2f50f242375ca4208213fc641c13494b897 --- /dev/null +++ b/pipeline/fal_schemas/microsoft__mai-image-2.5-pro__edit.json @@ -0,0 +1,404 @@ +{ + "components": { + "schemas": { + "ImageFile": { + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image", + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image", + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "ImageFile", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "MaiImage25ProEditInput": { + "properties": { + "aspect_ratio": { + "default": "auto", + "description": "The aspect ratio of the generated image. Use \"auto\" to match the input or let the model decide.", + "enum": [ + "auto", + "1:1", + "4:3", + "3:4", + "16:9", + "9:16", + "3:2", + "2:3" + ], + "title": "Aspect Ratio", + "type": "string" + }, + "image_url": { + "default": "", + "description": "The URL of the image to edit. Provide one http(s) or data: URL.", + "examples": [ + "https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input.png" + ], + "title": "Image URL", + "type": "string" + }, + "num_images": { + "default": 1, + "description": "The number of images to generate.", + "maximum": 4, + "minimum": 1, + "title": "Number of Images", + "type": "integer" + }, + "output_format": { + "default": "png", + "description": "The format of the generated image.", + "enum": [ + "jpeg", + "png", + "webp" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "The instruction describing how to edit the input image(s).", + "examples": [ + "Turn this into a clean, futuristic product shot with soft studio lighting." + ], + "maxLength": 5000, + "minLength": 3, + "title": "Prompt", + "type": "string" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.", + "title": "Sync Mode", + "type": "boolean" + } + }, + "required": [ + "prompt" + ], + "title": "MaiImage25ProImageToImageInput", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "num_images", + "aspect_ratio", + "output_format", + "sync_mode", + "image_url" + ] + }, + "MaiImage25ProEditOutput": { + "properties": { + "description": { + "description": "The description of the generated images.", + "title": "Description", + "type": "string" + }, + "images": { + "description": "The edited images.", + "items": { + "$ref": "#/components/schemas/ImageFile" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images", + "description" + ], + "title": "MaiImage25ProImageToImageOutput", + "type": "object", + "x-fal-order-properties": [ + "images", + "description" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "MAI Image 2.5 Pro Edit performs instruction-guided image editing with Microsoft's highest-fidelity MAI model. Use one reference image to change objects, materials, lighting, backgrounds, layout, or text while preserving important visual structure. It is designed for hero assets, high-detail refinements, typography fixes, art direction, and production design.", + "title": "Queue OpenAPI for microsoft/mai-image-2.5-pro/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Edit one or more images with MAI-Image-2.5 Pro.", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/microsoft/mai-image-2.5-pro/edit/api", + "endpointId": "microsoft/mai-image-2.5-pro/edit", + "playgroundUrl": "https://fal.ai/models/microsoft/mai-image-2.5-pro/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0aa41899/nk1T8qzlhZ1edxsb1N9YO.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/microsoft/mai-image-2.5-pro/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MaiImage25ProEditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/microsoft/mai-image-2.5-pro/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MaiImage25ProEditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/microsoft/mai-image-2.5-pro/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/microsoft/mai-image-2.5-pro/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/openai__gpt-image-2.5__flare__edit.json b/pipeline/fal_schemas/openai__gpt-image-2.5__flare__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..cc09b19f69e5202f9bd19608aecfd9ca36e9edba --- /dev/null +++ b/pipeline/fal_schemas/openai__gpt-image-2.5__flare__edit.json @@ -0,0 +1,512 @@ +{ + "components": { + "schemas": { + "GptImage25FlareEditInput": { + "description": "GPT Image 2.5 edit inputs with model-specific quality and compression.", + "properties": { + "background": { + "default": "auto", + "description": "Background for the generated image", + "enum": [ + "auto", + "transparent", + "opaque" + ], + "title": "Background", + "type": "string" + }, + "enable_safety_checker": { + "default": true, + "description": "Authorized callers may set false to request relaxed screening.", + "title": "Enable Safety Checker", + "type": "boolean" + }, + "image_size": { + "anyOf": [ + { + "$ref": "#/components/schemas/ImageSize" + }, + { + "enum": [ + "square_hd", + "square", + "portrait_4_3", + "portrait_16_9", + "landscape_4_3", + "landscape_16_9", + "auto" + ], + "type": "string" + } + ], + "default": "auto", + "description": "The size of the generated image. Use 'auto' to infer from input images.", + "title": "Image Size" + }, + "image_urls": { + "description": "The URLs of the images to use as a reference for the generation. A maximum of 16 images are allowed.", + "examples": [ + [ + "https://v3b.fal.media/files/b/0a8691af/9Se_1_VX1wzTjjTOpWbs9_bb39c2eb-1a41-4749-b1d0-cf134abc8bbf.png" + ] + ], + "items": { + "type": "string" + }, + "maxItems": 16, + "title": "Image URLs", + "type": "array" + }, + "mask_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mask image URL. White marks regions to edit and black marks regions to keep.", + "title": "Mask URL" + }, + "num_images": { + "default": 1, + "description": "Number of images to generate", + "examples": [ + 1 + ], + "maximum": 10, + "minimum": 1, + "title": "Number of Images", + "type": "integer" + }, + "output_compression": { + "anyOf": [ + { + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Compression level from 0 to 100. Only supported when output_format is 'jpeg' or 'webp'.", + "title": "Output Compression" + }, + "output_format": { + "default": "png", + "description": "Output format for the images", + "enum": [ + "jpeg", + "png", + "webp" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "The prompt for image generation", + "examples": [ + "Same workers, same beam, same lunch boxes - but they're all on their phones now. One is taking a selfie. One is on a call looking annoyed. Same danger, new priorities. A hard hat has AirPods." + ], + "maxLength": 32000, + "minLength": 1, + "title": "Prompt", + "type": "string" + }, + "quality": { + "default": "high", + "description": "Quality for the generated image. Higher settings increase detail, latency, and token usage. Use 'auto' to let the model choose.", + "enum": [ + "auto", + "low", + "medium", + "high", + "xhigh", + "max" + ], + "title": "Quality", + "type": "string" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.", + "title": "Sync Mode", + "type": "boolean" + } + }, + "required": [ + "prompt", + "image_urls" + ], + "title": "GPTImage25EditImageRequest", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_urls", + "mask_url", + "image_size", + "background", + "quality", + "num_images", + "output_format", + "output_compression", + "sync_mode", + "enable_safety_checker" + ] + }, + "GptImage25FlareEditOutput": { + "properties": { + "images": { + "description": "The generated images.", + "examples": [ + [ + { + "content_type": "image/png", + "file_name": "yUt7tifLSbg1WzWWgfj2o.png", + "height": 1024, + "url": "https://v3b.fal.media/files/b/0a8691b0/yUt7tifLSbg1WzWWgfj2o.png", + "width": 1024 + } + ] + ], + "items": { + "$ref": "#/components/schemas/ImageFile" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "EditImageResponse", + "type": "object", + "x-fal-order-properties": [ + "images" + ] + }, + "ImageFile": { + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image", + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image", + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "ImageFile", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "ImageSize": { + "properties": { + "height": { + "default": 512, + "description": "The height of the generated image.", + "exclusiveMinimum": 0, + "maximum": 14142, + "title": "Height", + "type": "integer" + }, + "width": { + "default": 512, + "description": "The width of the generated image.", + "exclusiveMinimum": 0, + "maximum": 14142, + "title": "Width", + "type": "integer" + } + }, + "title": "ImageSize", + "type": "object", + "x-fal-order-properties": [ + "width", + "height" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the openai/gpt-image-2.5/flare/edit queue.", + "title": "Queue OpenAPI for openai/gpt-image-2.5/flare/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Edit images with the selected GPT Image 2.5 model.", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/openai/gpt-image-2.5/flare/edit/api", + "endpointId": "openai/gpt-image-2.5/flare/edit", + "playgroundUrl": "https://fal.ai/models/openai/gpt-image-2.5/flare/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0aa9a3a4/LkWSlm_4F_SXsNlc4limv.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/openai/gpt-image-2.5/flare/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GptImage25FlareEditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/openai/gpt-image-2.5/flare/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GptImage25FlareEditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/openai/gpt-image-2.5/flare/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/openai/gpt-image-2.5/flare/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/openai__gpt-image-2.5__sunburst__edit.json b/pipeline/fal_schemas/openai__gpt-image-2.5__sunburst__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..5834d1bd172934b17eedf9ae51a9a67409583ec8 --- /dev/null +++ b/pipeline/fal_schemas/openai__gpt-image-2.5__sunburst__edit.json @@ -0,0 +1,512 @@ +{ + "components": { + "schemas": { + "GptImage25SunburstEditInput": { + "description": "GPT Image 2.5 edit inputs with model-specific quality and compression.", + "properties": { + "background": { + "default": "auto", + "description": "Background for the generated image", + "enum": [ + "auto", + "transparent", + "opaque" + ], + "title": "Background", + "type": "string" + }, + "enable_safety_checker": { + "default": true, + "description": "Authorized callers may set false to request relaxed screening.", + "title": "Enable Safety Checker", + "type": "boolean" + }, + "image_size": { + "anyOf": [ + { + "$ref": "#/components/schemas/ImageSize" + }, + { + "enum": [ + "square_hd", + "square", + "portrait_4_3", + "portrait_16_9", + "landscape_4_3", + "landscape_16_9", + "auto" + ], + "type": "string" + } + ], + "default": "auto", + "description": "The size of the generated image. Use 'auto' to infer from input images.", + "title": "Image Size" + }, + "image_urls": { + "description": "The URLs of the images to use as a reference for the generation. A maximum of 16 images are allowed.", + "examples": [ + [ + "https://v3b.fal.media/files/b/0a8691af/9Se_1_VX1wzTjjTOpWbs9_bb39c2eb-1a41-4749-b1d0-cf134abc8bbf.png" + ] + ], + "items": { + "type": "string" + }, + "maxItems": 16, + "title": "Image URLs", + "type": "array" + }, + "mask_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mask image URL. White marks regions to edit and black marks regions to keep.", + "title": "Mask URL" + }, + "num_images": { + "default": 1, + "description": "Number of images to generate", + "examples": [ + 1 + ], + "maximum": 10, + "minimum": 1, + "title": "Number of Images", + "type": "integer" + }, + "output_compression": { + "anyOf": [ + { + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Compression level from 0 to 100. Only supported when output_format is 'jpeg' or 'webp'.", + "title": "Output Compression" + }, + "output_format": { + "default": "png", + "description": "Output format for the images", + "enum": [ + "jpeg", + "png", + "webp" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "The prompt for image generation", + "examples": [ + "Same workers, same beam, same lunch boxes - but they're all on their phones now. One is taking a selfie. One is on a call looking annoyed. Same danger, new priorities. A hard hat has AirPods." + ], + "maxLength": 32000, + "minLength": 1, + "title": "Prompt", + "type": "string" + }, + "quality": { + "default": "high", + "description": "Quality for the generated image. Higher settings increase detail, latency, and token usage. Use 'auto' to let the model choose.", + "enum": [ + "auto", + "low", + "medium", + "high", + "xhigh", + "max" + ], + "title": "Quality", + "type": "string" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.", + "title": "Sync Mode", + "type": "boolean" + } + }, + "required": [ + "prompt", + "image_urls" + ], + "title": "GPTImage25EditImageRequest", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_urls", + "mask_url", + "image_size", + "background", + "quality", + "num_images", + "output_format", + "output_compression", + "sync_mode", + "enable_safety_checker" + ] + }, + "GptImage25SunburstEditOutput": { + "properties": { + "images": { + "description": "The generated images.", + "examples": [ + [ + { + "content_type": "image/png", + "file_name": "yUt7tifLSbg1WzWWgfj2o.png", + "height": 1024, + "url": "https://v3b.fal.media/files/b/0a8691b0/yUt7tifLSbg1WzWWgfj2o.png", + "width": 1024 + } + ] + ], + "items": { + "$ref": "#/components/schemas/ImageFile" + }, + "title": "Images", + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "EditImageResponse", + "type": "object", + "x-fal-order-properties": [ + "images" + ] + }, + "ImageFile": { + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image", + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image", + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "ImageFile", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "ImageSize": { + "properties": { + "height": { + "default": 512, + "description": "The height of the generated image.", + "exclusiveMinimum": 0, + "maximum": 14142, + "title": "Height", + "type": "integer" + }, + "width": { + "default": 512, + "description": "The width of the generated image.", + "exclusiveMinimum": 0, + "maximum": 14142, + "title": "Width", + "type": "integer" + } + }, + "title": "ImageSize", + "type": "object", + "x-fal-order-properties": [ + "width", + "height" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the openai/gpt-image-2.5/sunburst/edit queue.", + "title": "Queue OpenAPI for openai/gpt-image-2.5/sunburst/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Edit images with the selected GPT Image 2.5 model.", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/openai/gpt-image-2.5/sunburst/edit/api", + "endpointId": "openai/gpt-image-2.5/sunburst/edit", + "playgroundUrl": "https://fal.ai/models/openai/gpt-image-2.5/sunburst/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0aa9a3b8/cSrDjg-ke-PcqgHiY_gxn.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/openai/gpt-image-2.5/sunburst/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GptImage25SunburstEditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/openai/gpt-image-2.5/sunburst/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GptImage25SunburstEditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/openai/gpt-image-2.5/sunburst/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/openai/gpt-image-2.5/sunburst/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/fal_schemas/openai__gpt-image-2.6__flare__edit.json b/pipeline/fal_schemas/openai__gpt-image-2.6__flare__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..33a1af31f69ebba48609817c35703c5809d41e5b --- /dev/null +++ b/pipeline/fal_schemas/openai__gpt-image-2.6__flare__edit.json @@ -0,0 +1 @@ +{"openapi":"3.1.0","info":{"title":"Queue OpenAPI for openai/gpt-image-2.6/flare/edit","version":"1.0.0","description":"The OpenAPI schema for the openai/gpt-image-2.6/flare/edit queue.","x-fal-metadata":{"endpointId":"openai/gpt-image-2.6/flare/edit","category":"image-to-image","thumbnailUrl":"https://v3b.fal.media/files/b/0ab12545/nBSD1qllETGJZIIT84YeH.jpg","playgroundUrl":"https://fal.ai/models/openai/gpt-image-2.6/flare/edit","documentationUrl":"https://fal.ai/models/openai/gpt-image-2.6/flare/edit/api","about":"Edit images with the selected GPT Image 2.6 model."}},"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Fal Key"}},"schemas":{"QueueStatus":{"type":"object","properties":{"status":{"type":"string","enum":["IN_QUEUE","IN_PROGRESS","COMPLETED"]},"request_id":{"type":"string","description":"The request id."},"response_url":{"type":"string","description":"The response url."},"status_url":{"type":"string","description":"The status url."},"cancel_url":{"type":"string","description":"The cancel url."},"logs":{"type":"object","description":"The logs.","additionalProperties":true},"metrics":{"type":"object","description":"The metrics.","additionalProperties":true},"queue_position":{"type":"integer","description":"The queue position."}},"required":["status","request_id"]},"GptImage26FlareEditInput":{"description":"GPT Image 2.6 edit inputs with model-specific quality and compression.","properties":{"prompt":{"description":"The prompt for image generation","maxLength":32000,"title":"Prompt","type":"string","examples":["Same workers, same beam, same lunch boxes - but they're all on their phones now. One is taking a selfie. One is on a call looking annoyed. Same danger, new priorities. A hard hat has AirPods."],"minLength":1},"output_compression":{"description":"Compression level from 0 to 100. Only supported when output_format is 'jpeg' or 'webp'.","title":"Output Compression","anyOf":[{"maximum":100,"type":"integer","minimum":0},{"type":"null"}]},"frame_count":{"default":9,"maximum":16,"description":"GIF only: number of frames. image_size applies to each frame; reduce size or count if the request exceeds the pixel budget.","title":"Frame Count","type":"integer","minimum":2},"reasoning_effort":{"default":"high","enum":["low","medium","high"],"title":"Reasoning Effort","type":"string","description":"How much the model plans before rendering, independently of quality (OpenAI `complexity`). Higher levels can help with dense text and complex layouts but add latency."},"mask_url":{"description":"Mask image URL. White marks regions to edit and black marks regions to keep.","title":"Mask URL","anyOf":[{"type":"string"},{"type":"null"}]},"output_format":{"default":"png","enum":["jpeg","png","webp","gif"],"description":"Output format for the images. 'gif' returns an animation.","title":"Output Format","type":"string"},"background":{"default":"auto","enum":["auto","transparent","opaque"],"description":"Background for the generated image","title":"Background","type":"string"},"image_urls":{"description":"The URLs of the images to use as a reference for the generation. A maximum of 16 images are allowed.","title":"Image URLs","maxItems":16,"examples":[["https://v3b.fal.media/files/b/0a8691af/9Se_1_VX1wzTjjTOpWbs9_bb39c2eb-1a41-4749-b1d0-cf134abc8bbf.png"]],"type":"array","items":{"type":"string"}},"markup_image_url":{"description":"Transparent PNG containing only annotations (circles, arrows, notes) that guide the edit of the first image. Must match the first image's dimensions. Cannot be combined with mask_url. Reference images are sent unmodified when set.","title":"Markup Image URL","anyOf":[{"type":"string"},{"type":"null"}]},"sync_mode":{"default":false,"description":"If `True`, the media will be returned as a data URI and the output data won't be available in the request history.","title":"Sync Mode","type":"boolean"},"num_images":{"default":1,"maximum":10,"description":"Number of images to generate. Must be 1 for SVG output. For GIF output, all frames of all outputs share the request's pixel budget.","title":"Number of Images","type":"integer","examples":[1],"minimum":1},"quality":{"default":"high","enum":["auto","low","medium","high","xhigh","max"],"title":"Quality","type":"string","description":"Rendering quality for the generated image. For SVG output it controls the reference image used to create the vector."},"frame_duration_ms":{"default":200,"maximum":2000,"description":"GIF only: milliseconds per frame, rounded to 10 ms.","title":"Frame Duration Ms","type":"integer","minimum":20},"enable_safety_checker":{"default":true,"description":"Authorized callers may set false to request relaxed screening.","title":"Enable Safety Checker","type":"boolean"},"image_size":{"default":"auto","description":"The size of the generated image. Use 'auto' to infer from input images.","title":"Image Size","anyOf":[{"$ref":"#/components/schemas/ImageSize"},{"enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","auto"],"type":"string"}]}},"x-fal-order-properties":["prompt","image_urls","mask_url","markup_image_url","image_size","background","quality","reasoning_effort","num_images","output_format","output_compression","frame_count","frame_duration_ms","sync_mode","enable_safety_checker"],"title":"GPTImage26EditImageRequest","required":["prompt","image_urls"],"type":"object"},"GptImage26FlareEditOutput":{"properties":{"images":{"description":"The generated images.","title":"Images","type":"array","examples":[[{"width":1024,"height":1024,"content_type":"image/png","file_name":"yUt7tifLSbg1WzWWgfj2o.png","url":"https://v3b.fal.media/files/b/0a8691b0/yUt7tifLSbg1WzWWgfj2o.png"}]],"items":{"$ref":"#/components/schemas/ImageFile"}}},"x-fal-order-properties":["images"],"title":"EditImageResponse","required":["images"],"type":"object"},"ImageSize":{"properties":{"width":{"default":512,"description":"The width of the generated image.","exclusiveMinimum":0,"title":"Width","type":"integer","maximum":14142},"height":{"default":512,"description":"The height of the generated image.","exclusiveMinimum":0,"title":"Height","type":"integer","maximum":14142}},"x-fal-order-properties":["width","height"],"title":"ImageSize","type":"object"},"ImageFile":{"properties":{"width":{"description":"The width of the image","title":"Width","anyOf":[{"type":"integer"},{"type":"null"}]},"file_size":{"description":"The size of the file in bytes.","title":"File Size","anyOf":[{"type":"integer"},{"type":"null"}],"examples":[4404019]},"height":{"description":"The height of the image","title":"Height","anyOf":[{"type":"integer"},{"type":"null"}]},"content_type":{"description":"The mime type of the file.","title":"Content Type","anyOf":[{"type":"string"},{"type":"null"}],"examples":["image/png"]},"file_name":{"description":"The name of the file. It will be auto-generated if not provided.","title":"File Name","anyOf":[{"type":"string"},{"type":"null"}],"examples":["z9RV14K95DvU.png"]},"url":{"description":"The URL where the file can be downloaded from.","title":"Url","type":"string"}},"x-fal-order-properties":["url","content_type","file_name","file_size","width","height"],"title":"ImageFile","required":["url"],"type":"object"}}},"paths":{"/openai/gpt-image-2.6/flare/edit/requests/{request_id}/status":{"get":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}},{"name":"logs","in":"query","required":false,"schema":{"type":"number","description":"Whether to include logs (`1`) in the response or not (`0`)."}}],"responses":{"200":{"description":"The request status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatus"}}}}}}},"/openai/gpt-image-2.6/flare/edit/requests/{request_id}/cancel":{"put":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}}],"responses":{"200":{"description":"The request was cancelled.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was cancelled successfully."}}}}}}}}},"/openai/gpt-image-2.6/flare/edit":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GptImage26FlareEditInput"}}}},"responses":{"200":{"description":"The request status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatus"}}}}}}},"/openai/gpt-image-2.6/flare/edit/requests/{request_id}":{"get":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}}],"responses":{"200":{"description":"Result of the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GptImage26FlareEditOutput"}}}}}}}},"servers":[{"url":"https://queue.fal.run"}],"security":[{"apiKeyAuth":[]}]} \ No newline at end of file diff --git a/pipeline/fal_schemas/openai__gpt-image-2.6__sunburst__edit.json b/pipeline/fal_schemas/openai__gpt-image-2.6__sunburst__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..2a71c14e32271b1f8f6c4e6b6adb329c30372c18 --- /dev/null +++ b/pipeline/fal_schemas/openai__gpt-image-2.6__sunburst__edit.json @@ -0,0 +1 @@ +{"openapi":"3.1.0","info":{"title":"Queue OpenAPI for openai/gpt-image-2.6/sunburst/edit","version":"1.0.0","description":"The OpenAPI schema for the openai/gpt-image-2.6/sunburst/edit queue.","x-fal-metadata":{"endpointId":"openai/gpt-image-2.6/sunburst/edit","category":"image-to-image","thumbnailUrl":"https://v3b.fal.media/files/b/0ab1255d/vcqbyugh4tvlCOFkaWp1W.jpg","playgroundUrl":"https://fal.ai/models/openai/gpt-image-2.6/sunburst/edit","documentationUrl":"https://fal.ai/models/openai/gpt-image-2.6/sunburst/edit/api","about":"Edit images with the selected GPT Image 2.6 model."}},"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Fal Key"}},"schemas":{"QueueStatus":{"type":"object","properties":{"status":{"type":"string","enum":["IN_QUEUE","IN_PROGRESS","COMPLETED"]},"request_id":{"type":"string","description":"The request id."},"response_url":{"type":"string","description":"The response url."},"status_url":{"type":"string","description":"The status url."},"cancel_url":{"type":"string","description":"The cancel url."},"logs":{"type":"object","description":"The logs.","additionalProperties":true},"metrics":{"type":"object","description":"The metrics.","additionalProperties":true},"queue_position":{"type":"integer","description":"The queue position."}},"required":["status","request_id"]},"GptImage26SunburstEditInput":{"description":"GPT Image 2.6 edit inputs with model-specific quality and compression.","properties":{"prompt":{"description":"The prompt for image generation","maxLength":32000,"title":"Prompt","type":"string","examples":["Same workers, same beam, same lunch boxes - but they're all on their phones now. One is taking a selfie. One is on a call looking annoyed. Same danger, new priorities. A hard hat has AirPods."],"minLength":1},"output_compression":{"description":"Compression level from 0 to 100. Only supported when output_format is 'jpeg' or 'webp'.","title":"Output Compression","anyOf":[{"maximum":100,"type":"integer","minimum":0},{"type":"null"}]},"frame_count":{"default":9,"maximum":16,"description":"GIF only: number of frames. image_size applies to each frame; reduce size or count if the request exceeds the pixel budget.","title":"Frame Count","type":"integer","minimum":2},"reasoning_effort":{"default":"high","enum":["low","medium","high"],"title":"Reasoning Effort","type":"string","description":"How much the model plans before rendering, independently of quality (OpenAI `complexity`). Higher levels can help with dense text and complex layouts but add latency."},"mask_url":{"description":"Mask image URL. White marks regions to edit and black marks regions to keep.","title":"Mask URL","anyOf":[{"type":"string"},{"type":"null"}]},"output_format":{"default":"png","enum":["jpeg","png","webp","gif"],"description":"Output format for the images. 'gif' returns an animation.","title":"Output Format","type":"string"},"background":{"default":"auto","enum":["auto","transparent","opaque"],"description":"Background for the generated image","title":"Background","type":"string"},"image_urls":{"description":"The URLs of the images to use as a reference for the generation. A maximum of 16 images are allowed.","title":"Image URLs","maxItems":16,"examples":[["https://v3b.fal.media/files/b/0a8691af/9Se_1_VX1wzTjjTOpWbs9_bb39c2eb-1a41-4749-b1d0-cf134abc8bbf.png"]],"type":"array","items":{"type":"string"}},"markup_image_url":{"description":"Transparent PNG containing only annotations (circles, arrows, notes) that guide the edit of the first image. Must match the first image's dimensions. Cannot be combined with mask_url. Reference images are sent unmodified when set.","title":"Markup Image URL","anyOf":[{"type":"string"},{"type":"null"}]},"sync_mode":{"default":false,"description":"If `True`, the media will be returned as a data URI and the output data won't be available in the request history.","title":"Sync Mode","type":"boolean"},"num_images":{"default":1,"maximum":10,"description":"Number of images to generate. Must be 1 for SVG output. For GIF output, all frames of all outputs share the request's pixel budget.","title":"Number of Images","type":"integer","examples":[1],"minimum":1},"quality":{"default":"high","enum":["auto","low","medium","high","xhigh","max"],"title":"Quality","type":"string","description":"Rendering quality for the generated image. For SVG output it controls the reference image used to create the vector."},"frame_duration_ms":{"default":200,"maximum":2000,"description":"GIF only: milliseconds per frame, rounded to 10 ms.","title":"Frame Duration Ms","type":"integer","minimum":20},"enable_safety_checker":{"default":true,"description":"Authorized callers may set false to request relaxed screening.","title":"Enable Safety Checker","type":"boolean"},"image_size":{"default":"auto","description":"The size of the generated image. Use 'auto' to infer from input images.","title":"Image Size","anyOf":[{"$ref":"#/components/schemas/ImageSize"},{"enum":["square_hd","square","portrait_4_3","portrait_16_9","landscape_4_3","landscape_16_9","auto"],"type":"string"}]}},"x-fal-order-properties":["prompt","image_urls","mask_url","markup_image_url","image_size","background","quality","reasoning_effort","num_images","output_format","output_compression","frame_count","frame_duration_ms","sync_mode","enable_safety_checker"],"title":"GPTImage26EditImageRequest","required":["prompt","image_urls"],"type":"object"},"GptImage26SunburstEditOutput":{"properties":{"images":{"description":"The generated images.","title":"Images","type":"array","examples":[[{"width":1024,"height":1024,"content_type":"image/png","file_name":"yUt7tifLSbg1WzWWgfj2o.png","url":"https://v3b.fal.media/files/b/0a8691b0/yUt7tifLSbg1WzWWgfj2o.png"}]],"items":{"$ref":"#/components/schemas/ImageFile"}}},"x-fal-order-properties":["images"],"title":"EditImageResponse","required":["images"],"type":"object"},"ImageSize":{"properties":{"width":{"default":512,"description":"The width of the generated image.","exclusiveMinimum":0,"title":"Width","type":"integer","maximum":14142},"height":{"default":512,"description":"The height of the generated image.","exclusiveMinimum":0,"title":"Height","type":"integer","maximum":14142}},"x-fal-order-properties":["width","height"],"title":"ImageSize","type":"object"},"ImageFile":{"properties":{"width":{"description":"The width of the image","title":"Width","anyOf":[{"type":"integer"},{"type":"null"}]},"file_size":{"description":"The size of the file in bytes.","title":"File Size","anyOf":[{"type":"integer"},{"type":"null"}],"examples":[4404019]},"height":{"description":"The height of the image","title":"Height","anyOf":[{"type":"integer"},{"type":"null"}]},"content_type":{"description":"The mime type of the file.","title":"Content Type","anyOf":[{"type":"string"},{"type":"null"}],"examples":["image/png"]},"file_name":{"description":"The name of the file. It will be auto-generated if not provided.","title":"File Name","anyOf":[{"type":"string"},{"type":"null"}],"examples":["z9RV14K95DvU.png"]},"url":{"description":"The URL where the file can be downloaded from.","title":"Url","type":"string"}},"x-fal-order-properties":["url","content_type","file_name","file_size","width","height"],"title":"ImageFile","required":["url"],"type":"object"}}},"paths":{"/openai/gpt-image-2.6/sunburst/edit/requests/{request_id}/status":{"get":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}},{"name":"logs","in":"query","required":false,"schema":{"type":"number","description":"Whether to include logs (`1`) in the response or not (`0`)."}}],"responses":{"200":{"description":"The request status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatus"}}}}}}},"/openai/gpt-image-2.6/sunburst/edit/requests/{request_id}/cancel":{"put":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}}],"responses":{"200":{"description":"The request was cancelled.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was cancelled successfully."}}}}}}}}},"/openai/gpt-image-2.6/sunburst/edit":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GptImage26SunburstEditInput"}}}},"responses":{"200":{"description":"The request status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatus"}}}}}}},"/openai/gpt-image-2.6/sunburst/edit/requests/{request_id}":{"get":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}}],"responses":{"200":{"description":"Result of the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GptImage26SunburstEditOutput"}}}}}}}},"servers":[{"url":"https://queue.fal.run"}],"security":[{"apiKeyAuth":[]}]} \ No newline at end of file diff --git a/pipeline/fal_schemas/wayback_2026-11-06.tsv b/pipeline/fal_schemas/wayback_2026-11-06.tsv new file mode 100644 index 0000000000000000000000000000000000000000..6da614ea1445238a45c46ffdb9aba8425bc2a769 --- /dev/null +++ b/pipeline/fal_schemas/wayback_2026-11-06.tsv @@ -0,0 +1,4 @@ +openai/gpt-image-2.6/sunburst/edit failed: HTTPError HTTP Error 429: Too Many Requests +openai/gpt-image-2.6/flare/edit failed: HTTPError HTTP Error 429: Too Many Requests +fal-ai/nano-banana-2/edit failed: HTTPError HTTP Error 429: Too Many Requests +fal-ai/qwen-image-edit-2511 failed: HTTPError HTTP Error 429: Too Many Requests diff --git a/pipeline/fal_schemas/xai__grok-imagine-image__v2.0__edit.json b/pipeline/fal_schemas/xai__grok-imagine-image__v2.0__edit.json new file mode 100644 index 0000000000000000000000000000000000000000..2c51fabfc00280109084108f70818874716226bb --- /dev/null +++ b/pipeline/fal_schemas/xai__grok-imagine-image__v2.0__edit.json @@ -0,0 +1,459 @@ +{ + "components": { + "schemas": { + "GrokImagineImageV20EditInput": { + "properties": { + "aspect_ratio": { + "default": "auto", + "description": "Aspect ratio of the edited image. Standard auto uses the nearest supported ratio of the first reference.", + "enum": [ + "2:1", + "20:9", + "19.5:9", + "16:9", + "4:3", + "3:2", + "1:1", + "2:3", + "3:4", + "9:16", + "9:19.5", + "9:20", + "1:2", + "auto", + "21:9", + "5:2" + ], + "title": "Aspect Ratio", + "type": "string" + }, + "enable_safety_checker": { + "default": true, + "description": "Authorized callers may set false to request relaxed screening.", + "title": "Enable Safety Checker", + "type": "boolean" + }, + "image_urls": { + "description": "List of URLs of the images to edit. A maximum of 5 images are supported.", + "examples": [ + [ + "https://v3b.fal.media/files/b/0a8b911d/Abk8vStrvmSPlzUqI_NN3_image_043.png" + ] + ], + "items": { + "type": "string" + }, + "title": "Image URLs", + "type": "array" + }, + "num_images": { + "default": 1, + "description": "Number of images to generate.", + "maximum": 10, + "minimum": 1, + "title": "Number of Images", + "type": "integer" + }, + "output_format": { + "default": "jpeg", + "description": "The format of the generated image.", + "enum": [ + "jpeg", + "png", + "webp" + ], + "title": "Output Format", + "type": "string" + }, + "prompt": { + "description": "Text description of the desired image.", + "examples": [ + "Make this scene more realistic but still keep the game vibes" + ], + "maxLength": 8000, + "title": "Prompt", + "type": "string" + }, + "quality": { + "default": "medium", + "description": "Quality level of the edited image. `auto` lets xAI choose; it currently uses `medium` for editing.", + "enum": [ + "low", + "medium", + "auto" + ], + "title": "Quality", + "type": "string" + }, + "resolution": { + "default": "1k", + "description": "Resolution of the generated image: 1k, 1.5k, or 2k.", + "enum": [ + "1k", + "1.5k", + "2k" + ], + "title": "Resolution", + "type": "string" + }, + "sync_mode": { + "default": false, + "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.", + "title": "Sync Mode", + "type": "boolean" + } + }, + "required": [ + "prompt" + ], + "title": "XAIImageEditV2Input", + "type": "object", + "x-fal-order-properties": [ + "prompt", + "image_urls", + "num_images", + "aspect_ratio", + "resolution", + "output_format", + "sync_mode", + "enable_safety_checker", + "quality" + ] + }, + "GrokImagineImageV20EditOutput": { + "properties": { + "images": { + "description": "The URL of the edited image.", + "examples": [ + [ + { + "url": "https://v3b.fal.media/files/b/0a8b911d/XMqiVoO2ECXUZEUYmPl2l.jpg" + } + ] + ], + "items": { + "$ref": "#/components/schemas/ImageFile" + }, + "title": "Images", + "type": "array" + }, + "revised_prompt": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The enhanced prompt that was used to generate the image.", + "title": "Revised Prompt" + } + }, + "required": [ + "images" + ], + "title": "XAIImageEditOutput", + "type": "object", + "x-fal-order-properties": [ + "images", + "revised_prompt" + ] + }, + "ImageFile": { + "properties": { + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mime type of the file.", + "examples": [ + "image/png" + ], + "title": "Content Type" + }, + "file_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the file. It will be auto-generated if not provided.", + "examples": [ + "z9RV14K95DvU.png" + ], + "title": "File Name" + }, + "file_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The size of the file in bytes.", + "examples": [ + 4404019 + ], + "title": "File Size" + }, + "height": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The height of the image", + "title": "Height" + }, + "url": { + "description": "The URL where the file can be downloaded from.", + "title": "Url", + "type": "string" + }, + "width": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The width of the image", + "title": "Width" + } + }, + "required": [ + "url" + ], + "title": "ImageFile", + "type": "object", + "x-fal-order-properties": [ + "url", + "content_type", + "file_name", + "file_size", + "width", + "height" + ] + }, + "QueueStatus": { + "properties": { + "cancel_url": { + "description": "The cancel url.", + "type": "string" + }, + "logs": { + "additionalProperties": true, + "description": "The logs.", + "type": "object" + }, + "metrics": { + "additionalProperties": true, + "description": "The metrics.", + "type": "object" + }, + "queue_position": { + "description": "The queue position.", + "type": "integer" + }, + "request_id": { + "description": "The request id.", + "type": "string" + }, + "response_url": { + "description": "The response url.", + "type": "string" + }, + "status": { + "enum": [ + "IN_QUEUE", + "IN_PROGRESS", + "COMPLETED" + ], + "type": "string" + }, + "status_url": { + "description": "The status url.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + }, + "securitySchemes": { + "apiKeyAuth": { + "description": "Fal Key", + "in": "header", + "name": "Authorization", + "type": "apiKey" + } + } + }, + "info": { + "description": "The OpenAPI schema for the xai/grok-imagine-image/v2.0/edit queue.", + "title": "Queue OpenAPI for xai/grok-imagine-image/v2.0/edit", + "version": "1.0.0", + "x-fal-metadata": { + "about": "Edit images using Grok Imagine Image 2.0.", + "category": "image-to-image", + "documentationUrl": "https://fal.ai/models/xai/grok-imagine-image/v2.0/edit/api", + "endpointId": "xai/grok-imagine-image/v2.0/edit", + "playgroundUrl": "https://fal.ai/models/xai/grok-imagine-image/v2.0/edit", + "thumbnailUrl": "https://v3b.fal.media/files/b/0aa53f9f/NPxHgnCK_ldUc0dOfNe1q.jpg" + } + }, + "openapi": "3.1.0", + "paths": { + "/xai/grok-imagine-image/v2.0/edit": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GrokImagineImageV20EditInput" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + }, + "/xai/grok-imagine-image/v2.0/edit/requests/{request_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GrokImagineImageV20EditOutput" + } + } + }, + "description": "Result of the request." + } + } + } + }, + "/xai/grok-imagine-image/v2.0/edit/requests/{request_id}/cancel": { + "put": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "success": { + "description": "Whether the request was cancelled successfully.", + "type": "boolean" + } + }, + "type": "object" + } + } + }, + "description": "The request was cancelled." + } + } + } + }, + "/xai/grok-imagine-image/v2.0/edit/requests/{request_id}/status": { + "get": { + "parameters": [ + { + "in": "path", + "name": "request_id", + "required": true, + "schema": { + "description": "Request ID", + "type": "string" + } + }, + { + "in": "query", + "name": "logs", + "required": false, + "schema": { + "description": "Whether to include logs (`1`) in the response or not (`0`).", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueueStatus" + } + } + }, + "description": "The request status." + } + } + } + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "servers": [ + { + "url": "https://queue.fal.run" + } + ] +} \ No newline at end of file diff --git a/pipeline/judge_prompt.txt b/pipeline/judge_prompt.txt new file mode 100644 index 0000000000000000000000000000000000000000..105b98db8b2607735da7bc2570140f3b8d9db3bd --- /dev/null +++ b/pipeline/judge_prompt.txt @@ -0,0 +1,80 @@ +An image-editing model was asked to apply this edit to the BEFORE image (first image): +"{ins}" +The AFTER image (second image) is its output. Check the edit strictly, as a careful human reviewer would. +First find the item in BEFORE, then look at the same place in AFTER, then compare the rest of the picture, then fill every field. +Verdict rules: +- done: every check is true (placement, origin cleared for moves/replacements, right item, attribute, framing kept) and there are no major unrequested changes. +- partial: the requested change is visible on the right item, but one detail is wrong (wrong place, copy instead of move, wrong colour or words). +- not_done: no visible change for this instruction, OR the change was made to a different item or person, OR the instruction cannot be applied to BEFORE, OR the framing changed, OR there is any major unrequested change. +Do not judge the people's faces or identity; ignore image quality. + +SCHEMA: +{ + "type": "object", + "additionalProperties": false, + "properties": { + "instruction_clear": { + "type": "boolean", + "description": "the BEFORE image has exactly one thing the instruction can refer to, and any named place exists" + }, + "target_in_before": { + "type": "string", + "description": "the item the instruction refers to and where it is in BEFORE" + }, + "target_in_after": { + "type": "string", + "description": "what is at that place in AFTER, and where the item is now (or 'gone')" + }, + "placement_ok": { + "type": "boolean", + "description": "the result is where the instruction says (or, if no place is named, where a reader would expect); true for remove" + }, + "origin_cleared": { + "type": "boolean", + "description": "for move/relocate and replace: the old item is no longer at its old place; true for other operations" + }, + "right_item_changed": { + "type": "boolean", + "description": "the edit was applied to the intended item, not to a different item or person" + }, + "attribute_ok": { + "type": "boolean", + "description": "the requested colour, words, material, pattern or object type is correct" + }, + "framing_kept": { + "type": "boolean", + "description": "AFTER shows the same view as BEFORE: no zoom, crop, reframing, rotation or added/removed border" + }, + "unrequested_changes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "MAJOR changes the instruction did not ask for: a person, garment or clearly visible object added or removed, or a different garment or object than the one named changed in colour, pattern, material or type. Do NOT list small redrawn details (logo or badge text, a pocket, a button, a seam, texture of a rock), changes to a person's face, hair, skin or body shape, slight colour/lighting/sharpness shifts, or changes that follow naturally from the edit (e.g. what is revealed behind a removed item, a garment's fit adjusting to a replacement)" + }, + "verdict": { + "type": "string", + "enum": [ + "done", + "partial", + "not_done" + ] + }, + "reason": { + "type": "string" + } + }, + "required": [ + "instruction_clear", + "target_in_before", + "target_in_after", + "placement_ok", + "origin_cleared", + "right_item_changed", + "attribute_ok", + "framing_kept", + "unrequested_changes", + "verdict", + "reason" + ] +} \ No newline at end of file diff --git a/pipeline/provider_docs/ARCHIVE_NOTES.md b/pipeline/provider_docs/ARCHIVE_NOTES.md new file mode 100644 index 0000000000000000000000000000000000000000..d9d6e95b379b561282b5e3c857abe5127ba48183 --- /dev/null +++ b/pipeline/provider_docs/ARCHIVE_NOTES.md @@ -0,0 +1,6 @@ +Local copies of every page are in this folder, fetched 2026-10-30 (fetch_log.tsv). +Wayback Machine snapshots taken 2026-10-30: fetch_log.tsv (first 9) and wayback_retry.tsv (next 5). +Alibaba Cloud pages (wan-image-generation-and-editing-api-reference, wan-image-edit, +qwen-image-generation-and-editing-api-reference) could not be archived: the Wayback save returned 520 on four tries. +Older public snapshots exist for two of them (2026-09-20, 2026-08-21); the local copies here are the 2026-10-30 versions. +kling__rendered_text.txt is the rendered page text (the raw HTML loads its content with JavaScript). diff --git a/pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_qwen-image-generation-and-editing-api-reference b/pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_qwen-image-generation-and-editing-api-reference new file mode 100644 index 0000000000000000000000000000000000000000..1e633d0f28fd198692cdec3ccd5393004e120c1e --- /dev/null +++ b/pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_qwen-image-generation-and-editing-api-reference @@ -0,0 +1,787 @@ + + + + + + + + + + + + + + + + + + + + + + + + Qwen-Image text-to-image image editing API reference - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+
+
+ +
+
+
+
All Products
+
+
+ + + +
+
+
+
+
+
+Search +
+
+
+ +
+ +
+
+
+ +
+

+This Product + +

+ + +
+ +
    + +
    +

    +Alibaba Cloud Model Studio:Qwen Image Generation and Editing API Reference + +

    +
    +
    +
    +
    + + +Document Center + +
    +
    +

    Alibaba Cloud Model Studio:Qwen Image Generation and Editing API Reference

    +
    +Last Updated:Oct 11, 2026 +
    +
    +
    +
    +

    The Qwen Image Generation and Editing model supports both text-to-image (T2I) and image-to-image/image editing (I2I). It can generate images directly from text prompts or edit images based on reference images combined with editing instructions. Supports both the OpenAI-compatible and DashScope protocols.

    Model overview

    +

    Model

    Description

    Output image specifications

    qwen-image-3.0-pro

    Qwen Image Generation and Editing 3.0 model that supports both text-to-image (T2I) and image-to-image/image editing (I2I).

    Image resolution:

    • Text-to-image (T2I): Total pixels must be between 512*512 and 2048*2048.

    • Image-to-image (I2I): Total pixels must be between 512*512 and 2048*2048.

    • Default: When size is not specified, the model automatically recommends a resolution based on the prompt.

    Image format: PNG

    qwen-image-3.0

    Qwen Image Generation and Editing 3.0 standard model that supports both text-to-image (T2I) and image-to-image/image editing (I2I). Balances quality and speed.

    qwen-image-2.1-pro

    Qwen Image Generation and Editing 2.1 Pro model. Image-to-image/image editing (I2I) supports up to 10 reference images. It can also automatically decide whether to output a standard image or an image with a transparent (alpha) channel based on the prompt description.

    qwen-image-2.1-turbo

    Qwen Image Generation and Editing 2.1 Turbo model. The most balanced and cost-effective model in the Qwen-Image series. Image-to-image/image editing (I2I) supports up to 10 reference images. It can also automatically decide whether to output a standard image or an image with a transparent (alpha) channel based on the prompt description.

    +

    Availability

    +

    The model, endpoint URL, and API key must belong to the same region. Cross-region calls fail.

    + +

    NoteThe sample code in this topic applies to the Singapore region.

    +

    ImportantAlibaba Cloud Model Studio has released workspace-specific domains for the China (Beijing) and Singapore regions. The new dedicated domains deliver superior performance and higher stability for inference requests. We recommend migrating to the new domains:

      +
    • China (Beijing): from https://dashscope.aliyuncs.com to https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com
      • +
    • Singapore: from https://dashscope-intl.aliyuncs.com to https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com
      • +

    {WorkspaceId} is your workspace ID, which can be found on the Workspace Details page in the Alibaba Cloud Model Studio console. The existing domain remains fully functional.

    +

    Access methods

    +

    Qwen Image Generation and Editing offers three access methods with identical model capabilities. Choose the one that fits your application:

    +

    Access method

    When to use

    OpenAI-compatible

    Applications already built on the OpenAI Images protocol or the OpenAI SDK. Switch base_url and model to migrate. Synchronous calls only. Image input supports both public URL and Base64.

    DashScope synchronous

    Recommended. Full feature coverage, including both public URL and Base64 image input.

    DashScope asynchronous

    Batch generation, or when you do not want to hold a connection open. Submit a task and poll for results with task_id.

    +

    OpenAI-compatible

    +

    If your application is already built on the OpenAI Images protocol or the OpenAI SDK, you can call Qwen Image Generation and Editing through the OpenAI-compatible mode without changing your request structure. Text-to-image (T2I) and image-to-image/image editing (I2I) share the same endpoint: omit image for T2I, and provide image for I2I.

    +

    NoteThe OpenAI-compatible mode is a synchronous, non-streaming endpoint. Image editing uses the image extension field on /images/generations. It does not use the multipart file upload format of the official OpenAI /images/edits endpoint. The following are not yet supported: asynchronous calls, streaming output, partial images, /images/edits, multipart, and mask. Passing response_format=b64_json does not raise an error, but it is ignored and the response still contains image URLs. For asynchronous calls, use DashScope asynchronous.

    +

    URL

    +

    Singapore

    HTTP endpoint: POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/images/generations

    base_url for SDK calls: https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1

    US (Virginia)

    HTTP endpoint: POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/compatible-mode/v1/images/generations

    base_url for SDK calls: https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/compatible-mode/v1

    China (Beijing)

    HTTP endpoint: POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/images/generations

    base_url for SDK calls: https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1

    China (Hong Kong)

    HTTP endpoint: POST https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/compatible-mode/v1/images/generations

    base_url for SDK calls: https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/compatible-mode/v1

    Germany (Frankfurt)

    HTTP endpoint: POST https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/compatible-mode/v1/images/generations

    base_url for SDK calls: https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/compatible-mode/v1

    Japan (Tokyo)

    HTTP endpoint: POST https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/compatible-mode/v1/images/generations

    base_url for SDK calls: https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/compatible-mode/v1

    +

    Replace {WorkspaceId} with your actual workspace ID.

    +

    Request parameters

    Headers

    Content-Type string (Required)

    The content type of the request. Must be application/json.

    Authorization string (Required)

    Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.

    Request body

    Unlike the DashScope protocol, the OpenAI-compatible mode places all parameters at the top level of the request body. There is no input or parameters nesting.

    model string (Required)

    The model name. Available values: qwen-image-3.0-pro, qwen-image-3.0, qwen-image-2.1-pro, and qwen-image-2.1-turbo.

    prompt string (Required)

    The positive prompt that describes the image content, style, and composition you want to generate or edit. Both Chinese and English are supported. Recommended maximum: 4,500 tokens. Cannot be an empty string.

    image string or array (Optional)

    The URL or Base64 encoded data of the input image. Omit this parameter for text-to-image (T2I). Provide it for image-to-image (I2I), where the qwen-image-2.1 series supports 1-10 images, and the qwen-image-3.0 series supports 1-3 images. Pass a string for a single image, or an array of strings for multiple images. When multiple images are provided, the order is defined by the array sequence.

    Note: null and empty arrays are rejected with a 400 error.

    Image requirements:
      +
    • Image format: JPG, JPEG, PNG, BMP, TIFF, WEBP, and GIF.
      • +
    • Image resolution: The width and height must be between 1 and 8000 pixels; exceeding this returns a 400 error. For best results, use 384 to 2048 pixels.
      • +
    • Aspect ratio: The ratio of the longer side to the shorter side must not exceed 10:1.
      • +
    • Image size: Up to 10 MB.
      • +
    Supported input formats
      +
    1. Public URL: HTTP and HTTPS protocols are supported.
      2. +
    2. Base64 encoding: Format is data:{MIME_type};base64,{base64_data}.
      3. +

    n integer (Optional)

    The number of output images. Value range: 1 to 6. Default: 1. Must be an integer. A string value such as "1" returns a 400 error.

    size string (Optional)

    The output image resolution in the format widthxheight, for example "1024x1024". You can also pass auto. If not specified, the model automatically recommends a resolution based on the prompt.

    WarningThe OpenAI protocol uses the letter x as the separator (1024x1024), not the asterisk * used by the DashScope protocol (1024*1024). Update this value when migrating from DashScope.

      +
    • Text-to-image (T2I): Pixel area from 512x512 to 2048x2048. Aspect ratio: 1:8 to 8:1.
      • +
    • Image-to-image (I2I): Pixel area from 512x512 to 2048x2048. Aspect ratio: 1:8 to 8:1.
      • +

    negative_prompt string (Optional)

    The negative prompt that describes content you do not want to appear in the image. Only the qwen-image-3.0 series supports this parameter.

    seed integer (Optional)

    The random seed. Value range: [0, 2147483647]. If omitted, the service generates a random seed. Use a fixed seed for reproducible results.

    prompt_extend boolean (Optional)

    Whether to enable intelligent prompt rewriting. Default: true (recommended). When enabled, the model optimizes the positive prompt using the method specified by prompt_extend_mode, which significantly improves results for simple descriptions.

    prompt_extend_mode string (Optional)

    The prompt rewriting method. Default: direct. Options:

      +
    • direct: Direct Prompt Enhancement (DPE), suitable for most scenarios. Supported for both T2I and I2I.
      • +
    • agent: Agent Prompt Enhancement (APE), provides more refined rewriting. Only supports text-to-image (T2I). Passing agent for image-to-image (I2I) will return a 400 error.
      • +

    enable_thinking boolean (Optional)

    Enables thinking mode. The default is true. This enhances model reasoning to improve image quality, but increases generation time. It requires prompt_extend=true. Supported for Direct T2I, Direct I2I, and Agent T2I. Not supported for I2I Agent.

    watermark boolean (Optional)

    Whether to add a watermark. Default: false.

    Noteimage, negative_prompt, seed, prompt_extend, prompt_extend_mode, enable_thinking, and watermark are Model Studio extension fields, not official OpenAI parameters. For raw HTTP requests, place them at the top level of the request body. When using an OpenAI SDK, pass them through extra_body.

    curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/images/generations' \
+--header 'Content-Type: application/json' \
+--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+--data '{
+    "model": "qwen-image-3.0-pro",
+    "prompt": "A vertical outdoor portrait photograph with a warm afternoon street atmosphere. Deep green vines and small orange flowers cascade from building eaves across the upper area. A dark blue sign reads '\''Il Messaggero'\'' in white Gothic lettering, partially obscured by foliage. Below, a newsstand displays newspapers behind black metal-framed glass, blurred by shallow depth of field. Strong backlight streams from the street'\''s end. Center-right, a young woman in a black spaghetti-strap backless dress looks back at the camera with a warm smile. Her long, thick wavy black hair is outlined by golden rim light. She has fair skin, bright eyes, soft coral-red lips, and holds a large bouquet of orange, apricot, pink and peach roses contrasting with her black dress. The sunlit city street stretches into the blurred background. Warm film-like tones with fine grain, soft contrast and pronounced backlit edge glow create a romantic, bright, urban strolling atmosphere.",
+    "size": "1024x1024",
+    "n": 1,
+    "prompt_extend": true
+}'
+
    curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/images/generations' \
+--header 'Content-Type: application/json' \
+--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+--data '{
+    "model": "qwen-image-3.0-pro",
+    "prompt": "Generate a sophisticated urban-style female portrait. Perfectly preserve the facial features and smooth black long hair of the young woman in the input image. She changes from her beige knit top into an elegant urban professional outfit: a champagne silk blouse with a well-tailored dark grey casual blazer and matching high-waisted wide-leg trousers. The scene is in a modern minimalist upscale coffee shop with floor-to-ceiling windows showing a bustling city view. Dark wood tables and leather chairs furnish the interior, with a silver laptop, documents, and a steaming Americano on the table. She sits relaxed, leaning slightly back with one arm on the armrest and the other holding a coffee cup, gazing at the camera with calm, slightly languid eyes and an elegant smile. Polished formal makeup with clean base, defined brows, and mauve lipstick. Soft afternoon light enters from the side through the windows, creating delicate light transitions on her face and clothing. Natural bokeh background in earth tones, greys and warm whites, creating a serene, sophisticated urban office atmosphere.",
+    "image": "https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png",
+    "size": "1024x1024",
+    "n": 1,
+    "prompt_extend": true
+}'
+
    +

    Response parameters

    created integer

    The Unix timestamp, in seconds, when the response was created.

    data array

    The list of generated results. When n is greater than 1, the array contains multiple elements.

    Properties

    url string

    The URL of the generated image in PNG format. The link is valid for 24 hours. Download and save the image promptly.

    usage object

    The resource usage of this call. Only returned on success. These are image input and output metering fields, not token usage.

    Properties

    qwen-image-3.0 series

    output_width integer

    The width of the final output image in pixels.

    output_height integer

    The height of the final output image in pixels.

    input_image_count integer

    The number of input images in the request. Returns 0 for text-to-image (T2I), and the actual count for image-to-image (I2I).

    input_image_type string

    The input image billing tier. Determined by the output resolution pixel area: qima_input_1k if area ≤ 2,250,000, or qima_input_2k if area > 2,250,000.

    output_image_count integer

    The actual number of output images returned.

    output_image_type string

    The output image billing tier. Determined by the output resolution pixel area: qima_output_1k if area ≤ 2,250,000, or qima_output_2k if area > 2,250,000.

    qwen-image-2.1 series

    image_count integer

    The number of images generated by the model.

    width integer

    The width of the generated image in pixels.

    height integer

    The height of the generated image in pixels.

    error object

    The error details. Only returned for failed requests.

    Properties

    message string

    Detailed error message.

    type string

    The error type, such as invalid_request_error.

    param string

    The name of the parameter that caused the error, or null when the error cannot be attributed to a specific parameter.

    code string

    Error code. See Error codes.

    NoteUnlike the DashScope protocol, the OpenAI-compatible mode does not return request_id in the response body. The unique request identifier is returned in the x-request-id HTTP response header. With the OpenAI Python SDK, read response._request_id on success and APIStatusError.request_id on failure. Include this identifier when reporting an issue.

    Success

    Image URLs are retained for only 24 hours and then automatically purged. Save generated images promptly.

    {
+    "created": 1788339600,
+    "data": [
+        {
+            "url": "https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx"
+        }
+    ],
+    "usage": {
+        "output_height": 1024,
+        "output_width": 1024,
+        "input_image_count": 0,
+        "input_image_type": "qima_input_1k",
+        "output_image_count": 1,
+        "output_image_type": "qima_output_1k"
+    }
+}
+
    {
+    "created": 1788339600,
+    "data": [
+        {
+            "url": "https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx"
+        }
+    ],
+    "usage": {
+        "image_count": 1,
+        "width": 1024,
+        "height": 1024
+    }
+}
+

    Error

    If the request fails, the response contains an error object whose code and message fields identify the cause. See Error codes for troubleshooting.

    {
+    "error": {
+        "message": "Field 'prompt' is required",
+        "type": "invalid_request_error",
+        "param": null,
+        "code": "InvalidParameter"
+    }
+}
+
    +

    SDK

    +

    Install or upgrade the OpenAI Python SDK first:

    +
    pip install -U openai
+
    +

    ImportantImage generation can take a long time. Set an explicit, generous client timeout. For multi-image output (a larger n) or concurrent requests, start at 600 seconds so the client does not disconnect early.

    +
    import os
+from openai import OpenAI
+
+client = OpenAI(
+    api_key=os.getenv("DASHSCOPE_API_KEY"),
+    base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1",
+    timeout=600.0,
+)
+
+response = client.images.generate(
+    model="qwen-image-3.0-pro",
+    prompt="A vertical outdoor portrait photograph with a warm afternoon street atmosphere. Deep green vines and small orange flowers cascade from building eaves across the upper area. A dark blue sign reads 'Il Messaggero' in white Gothic lettering, partially obscured by foliage. Below, a newsstand displays newspapers behind black metal-framed glass, blurred by shallow depth of field. Strong backlight streams from the street's end. Center-right, a young woman in a black spaghetti-strap backless dress looks back at the camera with a warm smile. Her long, thick wavy black hair is outlined by golden rim light. She has fair skin, bright eyes, soft coral-red lips, and holds a large bouquet of orange, apricot, pink and peach roses contrasting with her black dress. The sunlit city street stretches into the blurred background. Warm film-like tones with fine grain, soft contrast and pronounced backlit edge glow create a romantic, bright, urban strolling atmosphere.",
+    size="1024x1024",
+    n=1,
+    # All parameters above are official OpenAI parameters. Extension fields such as
+    # image and prompt_extend go through extra_body. See the I2I example.
+)
+
+for item in response.data:
+    print(item.url)
+print(f"request_id: {response._request_id}")
+
    import os
+from openai import OpenAI
+
+client = OpenAI(
+    api_key=os.getenv("DASHSCOPE_API_KEY"),
+    base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1",
+    timeout=600.0,
+)
+
+response = client.images.generate(
+    model="qwen-image-3.0-pro",
+    prompt="Generate a sophisticated urban-style female portrait. Perfectly preserve the facial features and smooth black long hair of the young woman in the input image. Change her outfit to an elegant urban professional look. Set the scene in a modern minimalist upscale coffee shop.",
+    size="1024x1024",
+    n=1,
+    extra_body={
+        # A single image can also be passed as a plain string. Base64 is also accepted:
+        # data:{MIME_type};base64,{base64_data}
+        "image": [
+            "https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png"
+        ],
+        "prompt_extend": True,
+    },
+)
+
+for item in response.data:
+    print(item.url)
+print(f"request_id: {response._request_id}")
+
    import os
+from openai import OpenAI, APIStatusError
+
+client = OpenAI(
+    api_key=os.getenv("DASHSCOPE_API_KEY"),
+    base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1",
+    timeout=600.0,
+)
+
+try:
+    response = client.images.generate(
+        model="qwen-image-3.0-pro",
+        prompt="A vertical outdoor portrait photograph with a warm afternoon street atmosphere.",
+    )
+    print(response.data[0].url)
+except APIStatusError as exc:
+    print(f"status_code: {exc.status_code}")
+    print(f"request_id: {exc.request_id}")
+    print(exc)
+
    + +

    HTTP

    +

    Singapore

    POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

    US (Virginia)

    POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

    China (Beijing)

    POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

    China (Hong Kong)

    POST https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

    Germany (Frankfurt)

    POST https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

    Japan (Tokyo)

    POST https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

    +

    Replace {WorkspaceId} with your actual workspace ID.

    +

    Request parameters

    Headers

    Content-Type string (Required)

    The content type of the request. Must be application/json.

    Authorization string (Required)

    Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.

    Request body

    model string (Required)

    The model name. Available values: qwen-image-3.0-pro, qwen-image-3.0, qwen-image-2.1-pro, and qwen-image-2.1-turbo.

    input object (Required)

    The input parameter object, which contains the following fields:

    Properties

    messages array (Required)

    The request content array. Only single-round conversations are supported, so the array must contain exactly one object with role and content properties.

    Properties

    rolestring (Required)

    The role of the message sender. Must be set to user.

    contentarray (Required)

    The message content array, with different combinations depending on the use case:

      +
    • Text-to-image (T2I): Contains only one {"text": "..."} object.
      • +
    • Image-to-image (I2I): the qwen-image-2.1 series contains 1-10 {"image": "..."} objects, the qwen-image-3.0 series contains 1-3, and 1 {"text": "..."} object.
      • +

    Properties

    image string (Required for I2I)

    The URL or Base64 encoded data of the input image. In I2I scenarios, the qwen-image-2.1 series supports 1-10 images, and the qwen-image-3.0 series supports 1-3 images. When multiple images are provided, the order is defined by the array sequence.

    Image requirements:
      +
    • Image format: JPG, JPEG, PNG, BMP, TIFF, WEBP, and GIF.
      • +
    • Image resolution: The width and height must be between 1 and 8000 pixels; exceeding this returns a 400 error. For best results, use 384 to 2048 pixels.
      • +
    • Aspect ratio: The ratio of the longer side to the shorter side must not exceed 10:1.
      • +
    • Image size: Up to 10 MB.
      • +
    Supported input formats
      +
    1. Public URL: HTTP and HTTPS protocols are supported.
      2. +
    2. Base64 encoding: Format is data:{MIME_type};base64,{base64_data}.
      3. +

    textstring(Required)

    The positive prompt that describes the image content, style, and composition you want to generate or edit. Both Chinese and English are supported. Recommended maximum: 4,500 tokens.

    Note: Only one text object is allowed. Omitting it or providing multiple text objects will result in an error.

    parameters object (Optional)

    Additional parameters to control image generation.

    Properties

    prompt_extend boolean (Optional)

    Whether to enable intelligent prompt rewriting. Default: true (recommended). When enabled, the model optimizes the positive prompt using the method specified by prompt_extend_mode, which significantly improves results for simple descriptions.

    prompt_extend_mode string (Optional)

    The prompt rewriting method. Default: direct. Options:

      +
    • direct: Direct Prompt Enhancement (DPE), suitable for most scenarios. Supported for both T2I and I2I.
      • +
    • agent: Agent Prompt Enhancement (APE), provides more refined rewriting. Only supports text-to-image (T2I). Passing agent for image-to-image (I2I) will return a 400 error.
      • +

    enable_thinking boolean (Optional)

    Enables thinking mode. The default is true. This enhances model reasoning to improve image quality, but increases generation time. It requires prompt_extend=true. Supported for Direct T2I, Direct I2I, and Agent T2I. Not supported for I2I Agent.

    n integer (Optional)

    The number of output images. Value range: 1 to 6. Default: 1.

    size string (Optional)

    The output image resolution in the format width*height, for example "1024*1024". If not specified, the model automatically recommends a resolution based on the prompt.

      +
    • Text-to-image (T2I): Pixel area from 512*512 to 2048*2048. Aspect ratio: 1:8 to 8:1.
      • +
    • Image-to-image (I2I): Pixel area from 512*512 to 2048*2048. Aspect ratio: 1:8 to 8:1.
      • +

    negative_prompt string (Optional)

    The negative prompt that describes content you do not want to appear in the image. Only the qwen-image-3.0 series supports this parameter.

    seed integer (Optional)

    The random seed. Value range: [0, 2147483647]. If omitted, the service generates a random seed. Use a fixed seed for reproducible results.

    watermark boolean (Optional)

    Whether to add a watermark. Default: false.

    curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation' \
+--header 'Content-Type: application/json' \
+--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+--data '{
+    "model": "qwen-image-3.0-pro",
+    "input": {
+        "messages": [
+            {
+                "role": "user",
+                "content": [
+                    {
+                        "text": "A vertical outdoor portrait photograph with a warm afternoon street atmosphere. Deep green vines and small orange flowers cascade from building eaves across the upper area. A dark blue sign reads '\''Il Messaggero'\'' in white Gothic lettering, partially obscured by foliage. Below, a newsstand displays newspapers behind black metal-framed glass, blurred by shallow depth of field. Strong backlight streams from the street'\''s end. Center-right, a young woman in a black spaghetti-strap backless dress looks back at the camera with a warm smile. Her long, thick wavy black hair is outlined by golden rim light. She has fair skin, bright eyes, soft coral-red lips, and holds a large bouquet of orange, apricot, pink and peach roses contrasting with her black dress. The sunlit city street stretches into the blurred background. Warm film-like tones with fine grain, soft contrast and pronounced backlit edge glow create a romantic, bright, urban strolling atmosphere."
+                    }
+                ]
+            }
+        ]
+    },
+    "parameters": {
+        "prompt_extend": true
+    }
+}'
+
    curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation' \
+--header 'Content-Type: application/json' \
+--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+--data '{
+    "model": "qwen-image-3.0-pro",
+    "input": {
+        "messages": [
+            {
+                "role": "user",
+                "content": [
+                    {
+                        "image": "https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png"
+                    },
+                    {
+                        "text": "Generate a sophisticated urban-style female portrait. Perfectly preserve the facial features and smooth black long hair of the young woman in the input image. She changes from her beige knit top into an elegant urban professional outfit: a champagne silk blouse with a well-tailored dark grey casual blazer and matching high-waisted wide-leg trousers. The scene is in a modern minimalist upscale coffee shop with floor-to-ceiling windows showing a bustling city view. Dark wood tables and leather chairs furnish the interior, with a silver laptop, documents, and a steaming Americano on the table. She sits relaxed, leaning slightly back with one arm on the armrest and the other holding a coffee cup, gazing at the camera with calm, slightly languid eyes and an elegant smile. Polished formal makeup with clean base, defined brows, and mauve lipstick. Soft afternoon light enters from the side through the windows, creating delicate light transitions on her face and clothing. Natural bokeh background in earth tones, greys and warm whites, creating a serene, sophisticated urban office atmosphere."
+                    }
+                ]
+            }
+        ]
+    },
+    "parameters": {
+        "prompt_extend": true
+    }
+}'
+
    +

    Response parameters

    output object

    Contains the model generation results.

    Properties

    rewrite_status string

    The prompt rewriting status. The value depends on whether rewriting was enabled in the request and the result of the rewrite.

    choices array

    The list of result options.

    Properties

    finish_reason string

    The reason why the task stopped. The value is stop when the task completes normally.

    message object

    The message returned by the model.

    Properties

    rolestring

    The role of the message. Fixed as assistant.

    contentarray

    The message content containing the generated image information.

    Properties

    image string

    The URL of the generated image in PNG format. The link is valid for 24 hours. Please download and save the image promptly.

    usage object

    The resource usage of this call. Only returned on success. These are image input and output metering fields, not token usage.

    Properties

    qwen-image-3.0 series

    output_width integer

    The width of the final output image in pixels.

    output_height integer

    The height of the final output image in pixels.

    input_image_count integer

    The number of input images in the request. Returns 0 for text-to-image (T2I), and the actual count for image-to-image (I2I).

    input_image_type string

    The input image billing tier. Determined by the output resolution pixel area: qima_input_1k if area ≤ 2,250,000, or qima_input_2k if area > 2,250,000.

    output_image_count integer

    The actual number of output images returned.

    output_image_type string

    The output image billing tier. Determined by the output resolution pixel area: qima_output_1k if area ≤ 2,250,000, or qima_output_2k if area > 2,250,000.

    qwen-image-2.1 series

    image_count integer

    The number of images generated by the model.

    width integer

    The width of the generated image in pixels.

    height integer

    The height of the generated image in pixels.

    request_id string

    Unique request identifier for tracing and troubleshooting.

    code string

    Error code. Returned only for failed requests. See Error codes.

    message string

    Detailed error message. Returned only for failed requests. See Error codes.

    Success

    Task data (task status and image URLs) is retained for only 24 hours and then automatically purged. Save generated images promptly.

    {
+    "output": {
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx"
+                        }
+                    ],
+                    "role": "assistant"
+                }
+            }
+        ]
+    },
+    "usage": {
+        "output_height": 1024,
+        "output_width": 1024,
+        "input_image_count": 1,
+        "input_image_type": "qima_input_1k",
+        "output_image_count": 1,
+        "output_image_type": "qima_output_1k"
+    },
+    "request_id": "571ae02f-5c9d-436c-83c2-f221e6df0xxx"
+}
+
    {
+    "output": {
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx"
+                        }
+                    ],
+                    "role": "assistant"
+                }
+            }
+        ]
+    },
+    "usage": {
+        "image_count": 1,
+        "width": 1024,
+        "height": 1024
+    },
+    "request_id": "571ae02f-5c9d-436c-83c2-f221e6df0xxx"
+}
+

    Error

    If the task fails, the response includes the error code and message. See Error codes for troubleshooting.

    {
+    "request_id": "31f808fd-8eef-9004-xxxxx",
+    "code": "InvalidApiKey",
+    "message": "Invalid API-key provided."
+}
+
    +

    SDK

    +

    The following examples demonstrate how to call the API using Python and Java SDKs for image-to-image / image editing (I2I).

    +
    import os
+import base64
+import mimetypes
+import dashscope
+from dashscope import MultiModalConversation
+
+dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1'
+
+def encode_file(file_path):
+    mime_type, _ = mimetypes.guess_type(file_path)
+    if not mime_type or not mime_type.startswith("image/"):
+        raise ValueError("Unsupported or unrecognized image format")
+    with open(file_path, "rb") as image_file:
+        encoded_string = base64.b64encode(image_file.read()).decode('utf-8')
+    return f"data:{mime_type};base64,{encoded_string}"
+
+# [Method 1] Use a public image URL
+image_url = "https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png"
+
+# [Method 2] Use a Base64-encoded image
+# image_url = encode_file("./your_image.png")
+
+response = MultiModalConversation.call(
+    api_key=os.getenv("DASHSCOPE_API_KEY"),
+    model="qwen-image-3.0-pro",
+    messages=[{
+        "role": "user",
+        "content": [
+            {"image": image_url},
+            {"text": "Generate a sophisticated urban-style female portrait. Perfectly preserve the facial features and smooth black long hair of the young woman in the input image. Change her outfit to an elegant urban professional look. Set the scene in a modern minimalist upscale coffee shop."}
+        ]
+    }],
+    prompt_extend=True
+)
+
+print(response)
+if response.status_code == 200:
+    url = response.output.choices[0].message.content[0]["image"]
+    print(f"Generated image URL: {url}")
+else:
+    print(f"Error: {response.code} - {response.message}")
+
    import java.util.Arrays;
+import java.util.Base64;
+import java.util.Collections;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import com.alibaba.dashscope.aigc.multimodalconversation.MultiModalConversation;
+import com.alibaba.dashscope.aigc.multimodalconversation.MultiModalConversationParam;
+import com.alibaba.dashscope.aigc.multimodalconversation.MultiModalConversationResult;
+import com.alibaba.dashscope.common.MultiModalMessage;
+import com.alibaba.dashscope.common.Role;
+import com.alibaba.dashscope.utils.Constants;
+
+public class ImageEditExample {
+    public static void main(String[] args) {
+        Constants.baseHttpApiUrl = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1";
+
+        // [Method 1] Use a public image URL
+        String imageUrl = "https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png";
+
+        // [Method 2] Use a Base64-encoded image
+        // String imageUrl = encodeFile("/path/to/your/image.png");
+
+        MultiModalConversation conv = new MultiModalConversation();
+        MultiModalMessage userMessage = MultiModalMessage.builder()
+            .role(Role.USER.getValue())
+            .content(Arrays.asList(
+                Collections.singletonMap("image", imageUrl),
+                Collections.singletonMap("text", "Generate a sophisticated urban-style female portrait. Perfectly preserve the facial features and smooth black long hair of the young woman in the input image. Change her outfit to an elegant urban professional look. Set the scene in a modern minimalist upscale coffee shop.")
+            ))
+            .build();
+        MultiModalConversationParam param = MultiModalConversationParam.builder()
+            .apiKey(System.getenv("DASHSCOPE_API_KEY"))
+            .model("qwen-image-3.0-pro")
+            .messages(Arrays.asList(userMessage))
+            .parameter("prompt_extend", true)
+            .build();
+        try {
+            MultiModalConversationResult result = conv.call(param);
+            System.out.println(result);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+    public static String encodeFile(String filePath) {
+        Path path = Paths.get(filePath);
+        if (!Files.exists(path)) {
+            throw new IllegalArgumentException("File does not exist: " + filePath);
+        }
+        String mimeType = null;
+        try {
+            mimeType = Files.probeContentType(path);
+        } catch (IOException e) {
+            throw new IllegalArgumentException("Cannot detect file type: " + filePath);
+        }
+        if (mimeType == null || !mimeType.startsWith("image/")) {
+            throw new IllegalArgumentException("Unsupported or unrecognized image format");
+        }
+        byte[] fileBytes = null;
+        try {
+            fileBytes = Files.readAllBytes(path);
+        } catch (IOException e) {
+            throw new IllegalArgumentException("Cannot read file content: " + filePath);
+        }
+        String encodedString = Base64.getEncoder().encodeToString(fileBytes);
+        return "data:" + mimeType + ";base64," + encodedString;
+    }
+}
+
    +

    DashScope asynchronous API

    +

    In addition to the synchronous call described above, Qwen Image Generation and Editing also supports asynchronous calls. The asynchronous API shares the same request parameter structure as the synchronous API. You only need to add the X-DashScope-Async: enable header. After the service accepts the request, it returns a task ID (task_id), which you then use to poll the query API for the final result.

    +

    ImportantThe endpoint for the asynchronous API differs from the synchronous API. Use the endpoints in this section instead of the synchronous endpoint.

    +

    HTTP

    +

    Asynchronous calls use a two-step workflow:

    +
      +
    1. Create a task to get a task ID: Send a request to create a task. The response contains a task ID (task_id).
      2. +
    2. Poll for results using the task ID: Use the task_id to poll the task status until the task completes and the image URL is returned.
      3. +
    +

    Step 1: Create a task to get a task ID

    +

    Singapore

    POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation

    US (Virginia)

    POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation

    China (Beijing)

    POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation

    China (Hong Kong)

    POST https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation

    Germany (Frankfurt)

    POST https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation

    Japan (Tokyo)

    POST https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation

    +
    Request parameters
    Headers

    Content-Type string (Required)

    The content type of the request. Must be application/json.

    Authorization string (Required)

    Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.

    X-DashScope-Async string (Required)

    Enables asynchronous processing. Must be enable. The endpoint in this section accepts asynchronous requests only and does not support synchronous calls.

    ImportantIf this request header is missing, the error "current user api does not support synchronous calls" is returned.

    Request body

    model string (Required)

    The model name. Available values: qwen-image-3.0-pro, qwen-image-3.0, qwen-image-2.1-pro, and qwen-image-2.1-turbo.

    input object (Required)

    The input parameter object, which contains the following fields:

    Properties

    messages array (Required)

    The request content array. Only single-round conversations are supported, so the array must contain exactly one object with role and content properties.

    Properties

    rolestring (Required)

    The role of the message sender. Must be set to user.

    contentarray (Required)

    The message content array, with different combinations depending on the use case:

      +
    • Text-to-image (T2I): Contains only one {"text": "..."} object.
      • +
    • Image-to-image (I2I): the qwen-image-2.1 series contains 1-10 {"image": "..."} objects, the qwen-image-3.0 series contains 1-3, and 1 {"text": "..."} object.
      • +

    Properties

    image string (Required for I2I)

    The URL or Base64 encoded data of the input image. In I2I scenarios, the qwen-image-2.1 series supports 1-10 images, and the qwen-image-3.0 series supports 1-3 images. When multiple images are provided, the order is defined by the array sequence.

    Image requirements:
      +
    • Image format: JPG, JPEG, PNG, BMP, TIFF, WEBP, and GIF.
      • +
    • Image resolution: The width and height must be between 1 and 8000 pixels; exceeding this returns a 400 error. For best results, use 384 to 2048 pixels.
      • +
    • Aspect ratio: The ratio of the longer side to the shorter side must not exceed 10:1.
      • +
    • Image size: Up to 10 MB.
      • +
    Supported input formats
      +
    1. Public URL: HTTP and HTTPS protocols are supported.
      2. +
    2. Base64 encoding: Format is data:{MIME_type};base64,{base64_data}.
      3. +

    textstring(Required)

    The positive prompt that describes the image content, style, and composition you want to generate or edit. Both Chinese and English are supported. Recommended maximum: 4,500 tokens.

    Note: Only one text object is allowed. Omitting it or providing multiple text objects will result in an error.

    parameters object (Optional)

    Additional parameters to control image generation.

    Properties

    prompt_extend boolean (Optional)

    Whether to enable intelligent prompt rewriting. Default: true (recommended). When enabled, the model optimizes the positive prompt using the method specified by prompt_extend_mode, which significantly improves results for simple descriptions.

    prompt_extend_mode string (Optional)

    The prompt rewriting method. Default: direct. Options:

      +
    • direct: Direct Prompt Enhancement (DPE), suitable for most scenarios. Supported for both T2I and I2I.
      • +
    • agent: Agent Prompt Enhancement (APE), provides more refined rewriting. Only supports text-to-image (T2I). Passing agent for image-to-image (I2I) will return a 400 error.
      • +

    enable_thinking boolean (Optional)

    Enables thinking mode. The default is true. This enhances model reasoning to improve image quality, but increases generation time. It requires prompt_extend=true. Supported for Direct T2I, Direct I2I, and Agent T2I. Not supported for I2I Agent.

    n integer (Optional)

    The number of output images. Value range: 1 to 6. Default: 1.

    size string (Optional)

    The output image resolution in the format width*height, for example "1024*1024". If not specified, the model automatically recommends a resolution based on the prompt.

      +
    • Text-to-image (T2I): Pixel area from 512*512 to 2048*2048. Aspect ratio: 1:8 to 8:1.
      • +
    • Image-to-image (I2I): Pixel area from 512*512 to 2048*2048. Aspect ratio: 1:8 to 8:1.
      • +

    negative_prompt string (Optional)

    The negative prompt that describes content you do not want to appear in the image. Only the qwen-image-3.0 series supports this parameter.

    seed integer (Optional)

    The random seed. Value range: [0, 2147483647]. If omitted, the service generates a random seed. Use a fixed seed for reproducible results.

    watermark boolean (Optional)

    Whether to add a watermark. Default: false.

    curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation' \
+--header 'Content-Type: application/json' \
+--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+--header 'X-DashScope-Async: enable' \
+--data '{
+    "model": "qwen-image-3.0-pro",
+    "input": {
+        "messages": [
+            {
+                "role": "user",
+                "content": [
+                    {
+                        "text": "A vertical outdoor portrait photograph with a warm afternoon street atmosphere. Deep green vines and small orange flowers cascade from building eaves across the upper area. A dark blue sign reads '\''Il Messaggero'\'' in white Gothic lettering, partially obscured by foliage. Below, a newsstand displays newspapers behind black metal-framed glass, blurred by shallow depth of field. Strong backlight streams from the street'\''s end. Center-right, a young woman in a black spaghetti-strap backless dress looks back at the camera with a warm smile. Her long, thick wavy black hair is outlined by golden rim light. She has fair skin, bright eyes, soft coral-red lips, and holds a large bouquet of orange, apricot, pink and peach roses contrasting with her black dress. The sunlit city street stretches into the blurred background. Warm film-like tones with fine grain, soft contrast and pronounced backlit edge glow create a romantic, bright, urban strolling atmosphere."
+                    }
+                ]
+            }
+        ]
+    },
+    "parameters": {
+        "prompt_extend": true
+    }
+}'
+
    curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation' \
+--header 'Content-Type: application/json' \
+--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+--header 'X-DashScope-Async: enable' \
+--data '{
+    "model": "qwen-image-3.0-pro",
+    "input": {
+        "messages": [
+            {
+                "role": "user",
+                "content": [
+                    {
+                        "image": "https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png"
+                    },
+                    {
+                        "text": "Generate a sophisticated urban-style female portrait. Perfectly preserve the facial features and smooth black long hair of the young woman in the input image. She changes from her beige knit top into an elegant urban professional outfit: a champagne silk blouse with a well-tailored dark grey casual blazer and matching high-waisted wide-leg trousers. The scene is in a modern minimalist upscale coffee shop with floor-to-ceiling windows showing a bustling city view. Dark wood tables and leather chairs furnish the interior, with a silver laptop, documents, and a steaming Americano on the table. She sits relaxed, leaning slightly back with one arm on the armrest and the other holding a coffee cup, gazing at the camera with calm, slightly languid eyes and an elegant smile. Polished formal makeup with clean base, defined brows, and mauve lipstick. Soft afternoon light enters from the side through the windows, creating delicate light transitions on her face and clothing. Natural bokeh background in earth tones, greys and warm whites, creating a serene, sophisticated urban office atmosphere."
+                    }
+                ]
+            }
+        ]
+    },
+    "parameters": {
+        "prompt_extend": true
+    }
+}'
+
    +
    Response parameters

    output object

    The task acceptance information.

    Properties

    task_id string

    The asynchronous task ID, used to query the task status and result. Make sure to save it.

    task_status string

    The task status. Usually PENDING when the task is submitted, indicating only that the task has been accepted, not that the image has been generated.

    request_id string

    Unique request identifier for tracing and troubleshooting.

    code string

    Error code. Returned only for failed requests. See Error codes.

    Successful response

    Save the task_id to query the task status and result.

    {
+    "output": {
+        "task_status": "PENDING",
+        "task_id": "0385dc79-5ff8-4d82-bcb6-xxxxxx"
+    },
+    "request_id": "4909100c-7b5a-9f92-bfe5-xxxxxx"
+}
+

    Error response

    Task creation failed. See Error codes.

    {
+    "code": "InvalidApiKey",
+    "message": "Invalid API-key provided.",
+    "request_id": "7438d53d-6eb8-4596-8835-xxxxxx"
+}
+
    +

    Step 2: Poll for results using the task ID

    +

    Singapore

    GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id}

    US (Virginia)

    GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v1/tasks/{task_id}

    China (Beijing)

    GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/tasks/{task_id}

    China (Hong Kong)

    GET https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/api/v1/tasks/{task_id}

    Germany (Frankfurt)

    GET https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/api/v1/tasks/{task_id}

    Japan (Tokyo)

    GET https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id}

    +

    You must use the same region, workspace, and API key as when you created the task. Cross-region or cross-workspace queries are not supported.

    +
    Request parameters
    Headers

    Authorization string (Required)

    Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.

    URL path parameters

    task_id string (Required)

    The ID of the task.

    Query task result

    Replace {task_id} with the task_id value returned by the previous API call. The task_id is valid for queries for 24 hours, Replace {WorkspaceId} with your actual workspace ID.

    curl -X GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id} \
+--header "Authorization: Bearer $DASHSCOPE_API_KEY"
+
    +
    Response parameters

    output object

    The task output information.

    Properties

    task_id string

    The task ID. Valid for queries for 24 hours.

    task_status string

    The status of the task.

    Enumeration values

      +
    • PENDING
      • +
    • RUNNING
      • +
    • SUCCEEDED
      • +
    • FAILED
      • +
    • CANCELED
      • +
    • UNKNOWN: The task does not exist or its status is unknown.
      • +
    State transitions during polling:
      +
    • PENDING → RUNNING → SUCCEEDED or FAILED.
      • +
    • The initial query status is usually PENDING or RUNNING.
      • +
    • When the status changes to SUCCEEDED, the response contains the generated image URL.
      • +
    • If the status is FAILED, check the error message and retry the task.
      • +

    submit_time string

    The time when the task was submitted. The time is in UTC+8 and the format is YYYY-MM-DD HH:mm:ss.SSS.

    scheduled_time string

    The time when the task was executed. The time is in UTC+8 and the format is YYYY-MM-DD HH:mm:ss.SSS.

    end_time string

    The time when the task was completed. The time is in UTC+8 and the format is YYYY-MM-DD HH:mm:ss.SSS.

    rewrite_status string

    The prompt rewriting status. The value depends on whether rewriting was enabled in the request and the result of the rewrite.

    choices array

    The list of result options.

    Properties

    finish_reason string

    The reason why the task stopped. The value is stop when the task completes normally.

    message object

    The message returned by the model.

    Properties

    rolestring

    The role of the message. Fixed as assistant.

    contentarray

    The message content containing the generated image information.

    Properties

    image string

    The URL of the generated image in PNG format. The link is valid for 24 hours. Please download and save the image promptly.

    usage object

    The resource usage of this call. Only returned on success. These are image input and output metering fields, not token usage.

    Properties

    qwen-image-3.0 series

    output_width integer

    The width of the final output image in pixels.

    output_height integer

    The height of the final output image in pixels.

    input_image_count integer

    The number of input images in the request. Returns 0 for text-to-image (T2I), and the actual count for image-to-image (I2I).

    input_image_type string

    The input image billing tier. Determined by the output resolution pixel area: qima_input_1k if area ≤ 2,250,000, or qima_input_2k if area > 2,250,000.

    output_image_count integer

    The actual number of output images returned.

    output_image_type string

    The output image billing tier. Determined by the output resolution pixel area: qima_output_1k if area ≤ 2,250,000, or qima_output_2k if area > 2,250,000.

    qwen-image-2.1 series

    image_count integer

    The number of images generated by the model.

    width integer

    The width of the generated image in pixels.

    height integer

    The height of the generated image in pixels.

    request_id string

    Unique request identifier for tracing and troubleshooting.

    code string

    Error code. Returned only for failed requests. See Error codes.

    message string

    Detailed error message. Returned only for failed requests. See Error codes.

    Task succeeded

    Task data (task status and image URLs) is retained for only 24 hours and then automatically purged. Save generated images promptly.

    {
+    "output": {
+        "task_id": "17d7d840-82b9-485b-a954-724d06bc88d2",
+        "task_status": "SUCCEEDED",
+        "submit_time": "2026-08-07 15:50:14.837",
+        "scheduled_time": "2026-08-07 15:50:14.884",
+        "end_time": "2026-08-07 15:50:33.607",
+        "rewrite_status": "not_use",
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ]
+    },
+    "usage": {
+        "output_height": 1024,
+        "output_width": 1024,
+        "input_image_count": 0,
+        "input_image_type": "qima_input_1k",
+        "output_image_count": 1,
+        "output_image_type": "qima_output_1k"
+    },
+    "request_id": "2bd94002-5624-9129-916b-fbdde107b4ba"
+}
+
    {
+    "output": {
+        "task_id": "17d7d840-82b9-485b-a954-724d06bc88d2",
+        "task_status": "SUCCEEDED",
+        "submit_time": "2026-08-07 15:50:14.837",
+        "scheduled_time": "2026-08-07 15:50:14.884",
+        "end_time": "2026-08-07 15:50:33.607",
+        "rewrite_status": "not_use",
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ]
+    },
+    "usage": {
+        "image_count": 1,
+        "width": 1024,
+        "height": 1024
+    },
+    "request_id": "2bd94002-5624-9129-916b-fbdde107b4ba"
+}
+

    Task failed

    When a task fails, task_status is FAILED with an error code and message. See Error codes.

    {
+    "output": {
+        "task_id": "17d7d840-82b9-485b-a954-724d06bc88d2",
+        "task_status": "FAILED",
+        "code": "InternalError",
+        "message": "An internal error has occurred."
+    },
+    "request_id": "31f808fd-8eef-9004-xxxxx"
+}
+
    +

    Error codes

    +

    If the model call fails and returns an error message, see Error codes for resolution.

    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    + + + + + + + \ No newline at end of file diff --git a/pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_wan-image-edit b/pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_wan-image-edit new file mode 100644 index 0000000000000000000000000000000000000000..2cb6e1e6bd3e7f831cf244f69fcfaf7c145966a6 --- /dev/null +++ b/pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_wan-image-edit @@ -0,0 +1,1864 @@ + + + + + + + + + + + + + + + + + + + + + + + + How to call the Wan image editing model? - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    +
    +
    + +
    +
    +
    +
    All Products
    +
    +
    + + + +
    +
    +
    +
    +
    +
    +Search +
    +
    +
    + +
    + +
    +
    +
    + +
    +

    +This Product + +

    + + +
    + +
      + +
      +

      +Alibaba Cloud Model Studio:Image editing - Wan2.5 to 2.7 + +

      +
      +
      +
      +
      + + +Document Center + +
      +
      +

      Alibaba Cloud Model Studio:Image editing - Wan2.5 to 2.7

      +
      +Last Updated:Oct 11, 2026 +
      +
      +
      +
      +

      Edit images with text instructions using Wan models. Supports multi-image input/output, image fusion, subject preservation, and object detection.

      Getting started

      +

      Generate an edited image from two input images and a text prompt with wan2.7-image-pro.

      +
      +

      Prompt: Spray the graffiti from image 2 onto the car in image 1

      +
      +

      Input image 1

      Input image 2

      Output image (wan2.7-image-pro)

      umbrella

      input2

      1774509357_902b1408-2026-03-30-16-12-31

      +

      Before making a call, get an API key and export the API key as an environment variable. To make calls using the SDK, install the DashScope SDK.

      +

      Synchronous call

      ImportantEnsure that the DashScope Python SDK version is1.25.15or later, and the DashScope Java SDK version is2.22.13or later.

      Python

      Request example 

      import os
+import base64
+import mimetypes
+import urllib.request
+import dashscope
+from dashscope.aigc.image_generation import ImageGeneration
+from dashscope.api_entities.dashscope_response import Message
+
+# The following base_url is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+dashscope.base_http_api_url = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1"
+
+# If you have not configured environment variables, replace the following line with your Model Studio API key: api_key="sk-xxx"
+# The API key varies by region. To obtain an API key, visit: https://www.alibabacloud.com/help/model-studio/get-api-key
+api_key = os.getenv("DASHSCOPE_API_KEY")
+
+# --- Base64 encoding function ---
+# The Base64 encoding format is data:{MIME_type};base64,{base64_data}
+def encode_file(file_path):
+    mime_type, _ = mimetypes.guess_type(file_path)
+    if not mime_type or not mime_type.startswith("image/"):
+        raise ValueError("Unsupported or unrecognized image format")
+    with open(file_path, "rb") as image_file:
+        encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
+    return f"data:{mime_type};base64,{encoded_string}"
+
+"""
+Image input methods:
+The following are three methods for image input. You need to choose only one.
+1. Use a public URL: This method is suitable for publicly accessible images.
+2. Use a local file: This method is suitable for local development and testing.
+3. Use Base64 encoding: This method is suitable for private images or scenarios that require encrypted transmission.
+"""
+# [Method 1] Use a public image URL
+image_1 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp"
+image_2 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp"
+
+# [Method 2] Use a local file (supports absolute and relative paths)
+# image_1 = "file:///path/to/your/car.png"
+# image_2 = "file:///path/to/your/paint.png"
+
+# [Method 3] Use a Base64-encoded image
+# image_1 = encode_file("/path/to/your/car.png")
+# image_2 = encode_file("/path/to/your/paint.png")
+
+message = Message(
+    role="user",
+    content=[
+        {"text": "Spray the graffiti from image 2 onto the car in image 1"},
+        {"image": image_1},
+        {"image": image_2},
+    ],
+)
+print("----sync call, please wait a moment----")
+rsp = ImageGeneration.call(
+    model="wan2.7-image-pro",
+    api_key=api_key,
+    messages=[message],
+    watermark=False,
+    n=1,
+    size="2K",  # wan2.7-image-pro supports 4K resolution only for text-to-image generation. Image editing and multi-image generation support up to 2K resolution.
+)
+
+# Extract the result image URL and save the image to a local file.
+if rsp.status_code == 200:
+    for i, choice in enumerate(rsp.output.choices):
+        for j, content in enumerate(choice["message"]["content"]):
+            if content.get("type") == "image":
+                image_url = content["image"]
+                file_name = f"output_{i}_{j}.png"
+                # The result URL is valid for 24 hours. Please download it promptly.
+                urllib.request.urlretrieve(image_url, file_name)
+                print(f"Image saved to {file_name}")
+else:
+    print(f"Failed: status_code={rsp.status_code}, message={rsp.message}")
+

      Response example

      +

      The URL is valid for 24 hours. Download the image promptly.

      +
      {
+    "status_code": 200,
+    "request_id": "81d868c6-6ce1-92d8-a90d-d2ee71xxxxxx",
+    "code": "",
+    "message": "",
+    "output": {
+        "text": null,
+        "finish_reason": null,
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "audio": null,
+        "finished": true
+    },
+    "usage": {
+        "input_tokens": 18790,
+        "output_tokens": 2,
+        "characters": 0,
+        "image_count": 1,
+        "size": "2985*1405",
+        "total_tokens": 18792
+    }
+}
+

      Java

      Request example 

      import com.alibaba.dashscope.aigc.imagegeneration.*;
+import com.alibaba.dashscope.exception.ApiException;
+import com.alibaba.dashscope.exception.NoApiKeyException;
+import com.alibaba.dashscope.exception.UploadFileException;
+import com.alibaba.dashscope.utils.Constants;
+import com.alibaba.dashscope.utils.JsonUtils;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * wan2.7-image-pro Image Editing - Synchronous Call Example
+ */
+public class Main {
+
+    static {
+        // The following URL is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+        Constants.baseHttpApiUrl = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1";
+    }
+
+    // If you have not configured an environment variable, replace the following line with your Model Studio API key: apiKey="sk-xxx"
+    // The API key varies by region. To obtain an API key, visit https://www.alibabacloud.com/help/model-studio/get-api-key
+    static String apiKey = System.getenv("DASHSCOPE_API_KEY");
+
+    // --- Base64 encoding function ---
+    // Base64 encoding format: data:{MIME_type};base64,{base64_data}
+    public static String encodeFile(String filePath) throws IOException {
+        byte[] fileContent = Files.readAllBytes(Paths.get(filePath));
+        String base64String = Base64.getEncoder().encodeToString(fileContent);
+        String mimeType = Files.probeContentType(Paths.get(filePath));
+        return "data:" + mimeType + ";base64," + base64String;
+    }
+
+    public static void basicCall() throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        /*
+         * Description of image input methods:
+         * Three image input methods are provided below. Select one.
+         * 1. Use a public URL: Suitable for publicly accessible images.
+         * 2. Use a local file: Suitable for local development and testing.
+         * 3. Use Base64 encoding: Suitable for private images or scenarios that require encrypted transmission.
+         */
+        // Method 1: Use a public image URL.
+        String image1 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp";
+        String image2 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp";
+
+        // Method 2: Use a local file. Both absolute and relative paths are supported.
+        // Format: file:// + file path
+        // String image1 = "file:///path/to/your/car.png";
+        // String image2 = "file:///path/to/your/paint.png";
+
+        // Method 3: Use a Base64-encoded image.
+        // String image1 = encodeFile("/path/to/your/car.png");
+        // String image2 = encodeFile("/path/to/your/paint.png");
+
+        // Build a multi-image input message.
+        ImageGenerationMessage message = ImageGenerationMessage.builder()
+                .role("user")
+                .content(Arrays.asList(
+                        // Multi-image input is supported. You can provide multiple reference images.
+                        Collections.singletonMap("text", "Spray the graffiti from image 2 onto the car in image 1"),
+                        Collections.singletonMap("image", image1),
+                        Collections.singletonMap("image", image2)
+                )).build();
+
+        ImageGenerationParam param = ImageGenerationParam.builder()
+                .apiKey(apiKey)
+                .model("wan2.7-image-pro")
+                .messages(Collections.singletonList(message))
+                .n(1)
+                .size("2K") // For wan2.7-image-pro, only the text-to-image generation scenario supports 4K resolution. Image editing and collage generation support a maximum resolution of 2K.
+                .build();
+
+        ImageGeneration imageGeneration = new ImageGeneration();
+        ImageGenerationResult result = null;
+        try {
+            System.out.println("---sync call for image editing, please wait a moment----");
+            result = imageGeneration.call(param);
+        } catch (ApiException | NoApiKeyException | UploadFileException e) {
+            throw new RuntimeException(e.getMessage());
+        }
+        // Extract the result image URL and save it to a local file.
+        for (int i = 0; i < result.getOutput().getChoices().size(); i++) {
+            List<Map<String, Object>> contents = result.getOutput().getChoices().get(i)
+                    .getMessage().getContent();
+            for (int j = 0; j < contents.size(); j++) {
+                if ("image".equals(contents.get(j).get("type"))) {
+                    String imageUrl = (String) contents.get(j).get("image");
+                    String fileName = "output_" + i + "_" + j + ".png";
+                    // The result URL is valid for 24 hours. Download the image in a timely manner.
+                    try (InputStream in = new URL(imageUrl).openStream()) {
+                        Files.copy(in, Paths.get(fileName), StandardCopyOption.REPLACE_EXISTING);
+                    }
+                    System.out.println("Image saved to " + fileName);
+                }
+            }
+        }
+    }
+
+    public static void main(String[] args) throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        basicCall();
+    }
+}
+

      Response example

      +

      The URL is valid for 24 hours. Save it promptly.

      +
      {
+    "requestId": "1bf6173a-e8de-9f75-94d3-5e618f875xxx",
+    "usage": {
+        "input_tokens": 18790,
+        "output_tokens": 2,
+        "total_tokens": 18792,
+        "image_count": 1,
+        "size": "2985*1405"
+    },
+    "output": {
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "finished": true
+    },
+    "status_code": 200,
+    "code": "",
+    "message": ""
+}
+

      curl

      Request example 
      curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"image": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp"},
+                        {"image": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp"},
+                        {"text": "Spray-paint the graffiti from image 2 onto the car in image 1"}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "size": "2K",
+            "n": 1,
+            "watermark": false
+        }
+    }'
+
+
      Response example 
      {
+    "output": {
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "content": [
+                        {
+                            "image": "https://dashscope-xxx.oss-xxx.aliyuncs.com/xxx.png?Expires=xxx",
+                            "type": "image"
+                        }
+                    ],
+                    "role": "assistant"
+                }
+            }
+        ],
+        "finished": true
+    },
+    "usage": {
+        "image_count": 1,
+        "input_tokens": 10867,
+        "output_tokens": 2,
+        "size": "1488*704",
+        "total_tokens": 10869
+    },
+    "request_id": "71dfc3c6-f796-9972-97e4-bc4efc4faxxx"
+}
+

      Asynchronous call

      ImportantEnsure that the DashScope Python SDK version is1.25.15or later, and the DashScope Java SDK version is2.22.13or later.

      Python

      Request example 

      import os
+import base64
+import mimetypes
+import urllib.request
+import dashscope
+from dashscope.aigc.image_generation import ImageGeneration
+from dashscope.api_entities.dashscope_response import Message
+from http import HTTPStatus
+
+# The following base_url is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+dashscope.base_http_api_url = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1"
+
+# If you have not configured environment variables, replace the following line with your Model Studio API key: api_key="sk-xxx"
+# The API key varies by region. To obtain an API key, visit https://www.alibabacloud.com/help/model-studio/get-api-key
+api_key = os.getenv("DASHSCOPE_API_KEY")
+
+# --- Base64 encoding function ---
+# The Base64 encoding format is data:{MIME_type};base64,{base64_data}
+def encode_file(file_path):
+    mime_type, _ = mimetypes.guess_type(file_path)
+    if not mime_type or not mime_type.startswith("image/"):
+        raise ValueError("Unsupported or unrecognized image format.")
+    with open(file_path, "rb") as image_file:
+        encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
+    return f"data:{mime_type};base64,{encoded_string}"
+
+"""
+Image input methods:
+Three image input methods are provided below. Choose one.
+1. Use a public URL - suitable for publicly accessible images.
+2. Use a local file - suitable for local development and testing.
+3. Use Base64 encoding - suitable for private images or scenarios that require encrypted transmission.
+"""
+# [Method 1] Use a public image URL
+image_1 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp"
+image_2 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp"
+
+# [Method 2] Use a local file (supports absolute and relative paths)
+# image_1 = "file:///path/to/your/car.png"
+# image_2 = "file:///path/to/your/paint.png"
+
+# [Method 3] Use a Base64-encoded image
+# image_1 = encode_file("/path/to/your/car.png")
+# image_2 = encode_file("/path/to/your/paint.png")
+
+# Create an asynchronous task.
+def create_async_task():
+    print("Creating async task...")
+    message = Message(
+        role="user",
+        content=[
+            {"text": "Spray the graffiti from image 2 onto the car in image 1."},
+            {"image": image_1},
+            {"image": image_2},
+        ],
+    )
+    response = ImageGeneration.async_call(
+        model="wan2.7-image-pro",
+        api_key=api_key,
+        messages=[message],
+        watermark=False,
+        n=1,
+        size="2K",  # wan2.7-image-pro supports 4K resolution only for text-to-image generation scenarios. Image editing and collage generation support a maximum resolution of 2K.
+    )
+
+    if response.status_code == 200:
+        print("Task created successfully:", response)
+        return response
+    else:
+        raise Exception(f"Failed to create task: {response.code} - {response.message}")
+
+# Wait for the task to complete.
+def wait_for_completion(task_response):
+    print("Waiting for task completion...")
+    status = ImageGeneration.wait(task=task_response, api_key=api_key)
+
+    if status.output.task_status == "SUCCEEDED":
+        print("Task succeeded!")
+        # Extract the result image URL and save the image to a local file.
+        for i, choice in enumerate(status.output.choices):
+            for j, content in enumerate(choice["message"]["content"]):
+                if content.get("type") == "image":
+                    image_url = content["image"]
+                    file_name = f"output_{i}_{j}.png"
+                    # The result URL is valid for 24 hours. Download the image in a timely manner.
+                    urllib.request.urlretrieve(image_url, file_name)
+                    print(f"Image saved to {file_name}")
+    else:
+        raise Exception(f"Task failed with status: {status.output.task_status}")
+
+# Obtain information about the asynchronous task.
+def fetch_task_status(task):
+    print("Fetching task status...")
+    status = ImageGeneration.fetch(task=task, api_key=api_key)
+
+    if status.status_code == HTTPStatus.OK:
+        print("Task status:", status.output.task_status)
+        print("Response details:", status)
+    else:
+        print(f"Failed to fetch status: {status.code} - {status.message}")
+
+# Cancel the asynchronous task.
+def cancel_task(task):
+    print("Canceling task...")
+    response = ImageGeneration.cancel(task=task, api_key=api_key)
+
+    if response.status_code == HTTPStatus.OK:
+        print("Task canceled successfully:", response.output.task_status)
+    else:
+        print(f"Failed to cancel task: {response.code} - {response.message}")
+
+# Main execution flow.
+if __name__ == "__main__":
+    task = create_async_task()
+    wait_for_completion(task)
+

      Response example

        +
      1. Response example for creating a task
        2. +
      {
+    "status_code": 200,
+    "request_id": "4fb3050f-de57-4a24-84ff-e37ee5xxxxxx",
+    "code": "",
+    "message": "",
+    "output": {
+        "text": null,
+        "finish_reason": null,
+        "choices": null,
+        "audio": null,
+        "task_id": "127ec645-118f-4884-955d-0eba8dxxxxxx",
+        "task_status": "PENDING"
+    },
+    "usage": {
+        "input_tokens": 0,
+        "output_tokens": 0,
+        "characters": 0
+    }
+}
+
        +
      1. +

        Response example for querying a task result

        +
        +

        The URL is valid for 24 hours. Download the image promptly.

        +
        +
        2. +
      {
+    "status_code": 200,
+    "request_id": "3b99aae5-d26f-9059-8dd0-ee9ca4804xxx",
+    "code": null,
+    "message": "",
+    "output": {
+        "text": null,
+        "finish_reason": null,
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "audio": null,
+        "task_id": "127ec645-118f-4884-955d-0eba8dxxxxxx",
+        "task_status": "SUCCEEDED",
+        "submit_time": "2026-03-31 22:58:47.646",
+        "scheduled_time": "2026-03-31 22:58:47.683",
+        "end_time": "2026-03-31 22:58:59.642",
+        "finished": true
+    },
+    "usage": {
+        "input_tokens": 18711,
+        "output_tokens": 2,
+        "characters": 0,
+        "size": "2985*1405",
+        "total_tokens": 18713,
+        "image_count": 1
+    }
+}
+

      Java

      Request example 

      import com.alibaba.dashscope.aigc.imagegeneration.*;
+import com.alibaba.dashscope.exception.ApiException;
+import com.alibaba.dashscope.exception.NoApiKeyException;
+import com.alibaba.dashscope.exception.UploadFileException;
+import com.alibaba.dashscope.utils.Constants;
+import com.alibaba.dashscope.utils.JsonUtils;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * wan2.7-image-pro Image Editing - Asynchronous Invocation Example
+ */
+public class Main {
+
+    static {
+        // The following URL is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+        Constants.baseHttpApiUrl = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1";
+    }
+
+    // If you have not configured an environment variable, replace the following line with your Model Studio API key: apiKey="sk-xxx"
+    // The API key varies by region. To obtain an API key, visit: https://www.alibabacloud.com/help/model-studio/get-api-key
+    static String apiKey = System.getenv("DASHSCOPE_API_KEY");
+
+    // --- Base64 encoding function ---
+    // The Base64 encoding format is data:{MIME_type};base64,{base64_data}
+    public static String encodeFile(String filePath) throws IOException {
+        byte[] fileContent = Files.readAllBytes(Paths.get(filePath));
+        String base64String = Base64.getEncoder().encodeToString(fileContent);
+        String mimeType = Files.probeContentType(Paths.get(filePath));
+        return "data:" + mimeType + ";base64," + base64String;
+    }
+
+    public static void asyncCall() throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        /*
+         * Description of image input methods:
+         * The following three image input methods are provided. You can choose one of them.
+         * 1. Use a public URL - Suitable for publicly accessible images.
+         * 2. Use a local file - Suitable for local development and testing.
+         * 3. Use Base64 encoding - Suitable for scenarios that involve private images or require encrypted transmission.
+         */
+        // [Method 1] Use a public image URL
+        String image1 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp";
+        String image2 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp";
+
+        // [Method 2] Use a local file (supports absolute and relative paths)
+        // Required format: file:// + file path
+        // String image1 = "file:///path/to/your/car.png";
+        // String image2 = "file:///path/to/your/paint.png";
+
+        // [Method 3] Use a Base64-encoded image
+        // String image1 = encodeFile("/path/to/your/car.png");
+        // String image2 = encodeFile("/path/to/your/paint.png");
+
+        // Build a multi-image input message
+        ImageGenerationMessage message = ImageGenerationMessage.builder()
+                .role("user")
+                .content(Arrays.asList(
+                        // Supports multi-image input. You can provide multiple reference images.
+                        Collections.singletonMap("text", "Spray-paint the graffiti from image 2 onto the car in image 1"),
+                        Collections.singletonMap("image", image1),
+                        Collections.singletonMap("image", image2)
+                )).build();
+
+        ImageGenerationParam param = ImageGenerationParam.builder()
+                .apiKey(apiKey)
+                .model("wan2.7-image-pro")
+                .n(1)
+                .size("2K") // The wan2.7-image-pro model supports 4K resolution only for text-to-image generation. For image editing and composite image generation, the maximum supported resolution is 2K.
+                .messages(Arrays.asList(message))
+                .build();
+
+        ImageGeneration imageGeneration = new ImageGeneration();
+        ImageGenerationResult result = null;
+        try {
+            System.out.println("---async call for image editing, creating task----");
+            result = imageGeneration.asyncCall(param);
+        } catch (ApiException | NoApiKeyException | UploadFileException e) {
+            throw new RuntimeException(e.getMessage());
+        }
+        System.out.println("Task creation result:");
+        System.out.println(JsonUtils.toJson(result));
+
+        String taskId = result.getOutput().getTaskId();
+        // Wait for the task to complete
+        waitTask(taskId);
+    }
+
+    public static void waitTask(String taskId) throws ApiException, NoApiKeyException, IOException {
+        ImageGeneration imageGeneration = new ImageGeneration();
+        System.out.println("\n---waiting for task completion----");
+        ImageGenerationResult result = imageGeneration.wait(taskId, apiKey);
+        // Fetch the resulting image URL and save it to a local file
+        for (int i = 0; i < result.getOutput().getChoices().size(); i++) {
+            List<Map<String, Object>> contents = result.getOutput().getChoices().get(i)
+                    .getMessage().getContent();
+            for (int j = 0; j < contents.size(); j++) {
+                if ("image".equals(contents.get(j).get("type"))) {
+                    String imageUrl = (String) contents.get(j).get("image");
+                    String fileName = "output_" + i + "_" + j + ".png";
+                    // The result URL is valid for 24 hours. Download the image in a timely manner.
+                    try (InputStream in = new URL(imageUrl).openStream()) {
+                        Files.copy(in, Paths.get(fileName), StandardCopyOption.REPLACE_EXISTING);
+                    }
+                    System.out.println("Image saved to " + fileName);
+                }
+            }
+        }
+    }
+
+    public static void main(String[] args) throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        asyncCall();
+    }
+}
+

      Response example

        +
      1. Response example for creating a task
        2. +
      {
+    "requestId": "ccf4b2f4-bf30-9e13-9461-3a28c6a7bxxx",
+    "output": {
+        "task_id": "8811b4a4-00ac-4aa2-a2fd-017d3b90cxxx",
+        "task_status": "PENDING"
+    },
+    "status_code": 200,
+    "code": "",
+    "message": ""
+}
+
        +
      1. +

        Response example for querying a task result

        +
        +

        The URL is valid for 24 hours. Save it promptly.

        +
        +
        2. +
      {
+    "requestId": "60a08540-f1c1-9e76-8cd3-d5949db8cxxx",
+    "usage": {
+        "input_tokens": 18711,
+        "output_tokens": 2,
+        "total_tokens": 18713,
+        "image_count": 1,
+        "size": "2985*1405"
+    },
+    "output": {
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "task_id": "8811b4a4-00ac-4aa2-a2fd-017d3b90cxxx",
+        "task_status": "SUCCEEDED",
+        "finished": true,
+        "submit_time": "2026-03-31 19:57:58.840",
+        "scheduled_time": "2026-03-31 19:57:58.877",
+        "end_time": "2026-03-31 19:58:11.563"
+    },
+    "status_code": 200,
+    "code": "",
+    "message": ""
+}
+

      curl

      Step 1: Create a task to get the task ID 

      curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --header "X-DashScope-Async: enable" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"image": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp"},
+                        {"image": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp"},
+                        {"text": "Spray-paint the graffiti from image 2 onto the car in image 1"}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "size": "2K",
+            "n": 1,
+            "watermark": false
+        }
+    }'
+
+
      Response example
      {
+    "output": {
+        "task_status": "PENDING",
+        "task_id": "0385dc79-5ff8-4d82-bcb6-xxxxxx"
+    },
+    "request_id": "4909100c-7b5a-9f92-bfe5-xxxxxx"
+}
+

      Step2: Query the result by task ID

      Use the task_id obtained in the previous step to poll the task status through the API until the task_status becomes SUCCEEDED or FAILED.

      Replace {task_id} with the task_id value returned by the previous API call. The task_id is valid for queries for 24 hours, Replace {WorkspaceId} with your actual workspace ID.

      curl -X GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id} \
+--header "Authorization: Bearer $DASHSCOPE_API_KEY"
+
      Response example
      +

      The image URL is valid for 24 hours. Download the image promptly.

      +
      {
+    "request_id": "810fa5f5-334c-91f3-aaa4-ed89cf0caxxx",
+    "output": {
+        "task_id": "a81ee7cb-014c-473d-b842-76e98311cxxx",
+        "task_status": "SUCCEEDED",
+        "submit_time": "2026-03-26 17:16:01.663",
+        "scheduled_time": "2026-03-26 17:16:01.716",
+        "end_time": "2026-03-26 17:16:22.961",
+        "finished": true,
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-xxx.oss-xxx.aliyuncs.com/xxx.png?Expires=xxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ]
+    },
+    "usage": {
+        "size": "2976*1408",
+        "total_tokens": 11017,
+        "image_count": 1,
+        "output_tokens": 2,
+        "input_tokens": 11015
+    }
+}
+
      +

      wan2.5-i2i-preview uses different API endpoints and parameters.

      +

      Click to view call examples for wan2.5-i2i-preview

      Synchronous call

      ImportantEnsure that the DashScope Python SDK version is at least1.25.2and the DashScope Java SDK version is at least2.22.2.

      Outdated SDK versions may trigger "url error, please check url!" errors. Install or upgrade the SDK.

      Python

      This example supports three image input methods: public URL, Base64 encoding, and local file path.

      Request example 
      import base64
+import mimetypes
+from http import HTTPStatus
+from urllib.parse import urlparse, unquote
+from pathlib import PurePosixPath
+
+import dashscope
+import requests
+from dashscope import ImageSynthesis
+import os
+
+# The following URL is for the Singapore region. Replace {WorkspaceId} with your actual workspace ID. URLs differ by region.
+dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1'
+
+# If you have not configured an environment variable, replace the next line with: api_key="sk-xxx"
+# API keys differ between Singapore and Beijing. Get an API key: https://www.alibabacloud.com/help/model-studio/get-api-key
+api_key = os.getenv("DASHSCOPE_API_KEY")
+
+# --- Input image: Base64 encoding ---
+# Base64 format: data:{MIME_type};base64,{base64_data}
+def encode_file(file_path):
+    mime_type, _ = mimetypes.guess_type(file_path)
+    if not mime_type or not mime_type.startswith("image/"):
+        raise ValueError("Unsupported or unrecognized image format")
+    with open(file_path, "rb") as image_file:
+        encoded_string = base64.b64encode(image_file.read()).decode('utf-8')
+    return f"data:{mime_type};base64,{encoded_string}"
+
+"""
+Image input methods:
+Choose one of the following:
+
+1. Public URL — best for publicly accessible images
+2. Local file — best for local development and testing
+3. Base64 encoding — best for private images or secure transmission
+"""
+
+# [Method 1] Public image URL
+image_url_1 = "https://img.alicdn.com/imgextra/i3/O1CN0157XGE51l6iL9441yX_!!6000000004770-49-tps-1104-1472.webp"
+image_url_2 = "https://img.alicdn.com/imgextra/i3/O1CN01SfG4J41UYn9WNt4X1_!!6000000002530-49-tps-1696-960.webp"
+
+# [Method 2] Local file (supports absolute and relative paths)
+# Format: file:// + file path
+# Example (absolute path):
+# image_url_1 = "file://" + "/path/to/your/image_1.png"     # Linux/macOS
+# image_url_2 = "file://" + "C:/path/to/your/image_2.png"  # Windows
+# Example (relative path):
+# image_url_1 = "file://" + "./image_1.png"                 # Adjust to your path
+# image_url_2 = "file://" + "./image_2.png"                # Adjust to your path
+
+# [Method 3] Base64-encoded image
+# image_url_1 = encode_file("./image_1.png")               # Adjust to your path
+# image_url_2 = encode_file("./image_2.png")              # Adjust to your path
+
+print('----sync call, please wait a moment----')
+rsp = ImageSynthesis.call(api_key=api_key,
+                          model="wan2.5-i2i-preview",
+                          prompt="Place the alarm clock from image 1 beside the vase on the dining table in image 2.",
+                          images=[image_url_1, image_url_2],
+                          negative_prompt="",
+                          n=1,
+                          # size="1280*1280",
+                          prompt_extend=True,
+                          watermark=False,
+                          seed=12345)
+print('response: %s' % rsp)
+if rsp.status_code == HTTPStatus.OK:
+    # Save images to current directory
+    for result in rsp.output.results:
+        file_name = PurePosixPath(unquote(urlparse(result.url).path)).parts[-1]
+        with open('./%s' % file_name, 'wb+') as f:
+            f.write(requests.get(result.url).content)
+else:
+    print('sync_call Failed, status_code: %s, code: %s, message: %s' %
+          (rsp.status_code, rsp.code, rsp.message))
+
      Response example
      +

      The image URL is valid for 24 hours. Download the image promptly.

      +
      {
+    "status_code": 200,
+    "request_id": "8ad45834-4321-44ed-adf5-xxxxxx",
+    "code": null,
+    "message": "",
+    "output": {
+        "task_id": "3aff9ebd-35fc-4339-98a3-xxxxxx",
+        "task_status": "SUCCEEDED",
+        "results": [
+            {
+                "url": "https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/xxx.png?Expires=xxx",
+                "orig_prompt": "Place the alarm clock from image 1 beside the vase on the dining table in image 2.",
+                "actual_prompt": "Place the blue alarm clock from image 1 to the right of the vase on the dining table in image 2, near the edge of the tablecloth. Keep the clock facing the camera and parallel to the tabletop, with natural shadow projection."
+            }
+        ],
+        "submit_time": "2025-10-23 16:18:16.009",
+        "scheduled_time": "2025-10-23 16:18:16.040",
+        "end_time": "2025-10-23 16:19:09.591",
+        "task_metrics": {
+            "TOTAL": 1,
+            "FAILED": 0,
+            "SUCCEEDED": 1
+        }
+    },
+    "usage": {
+        "image_count": 1
+    }
+}
+

      Java

      This example supports three image input methods: public URL, Base64 encoding, and local file path.

      Request example 
      // Copyright (c) Alibaba, Inc. and its affiliates.
+
+import com.alibaba.dashscope.aigc.imagesynthesis.ImageSynthesis;
+import com.alibaba.dashscope.aigc.imagesynthesis.ImageSynthesisParam;
+import com.alibaba.dashscope.aigc.imagesynthesis.ImageSynthesisResult;
+import com.alibaba.dashscope.exception.ApiException;
+import com.alibaba.dashscope.exception.NoApiKeyException;
+import com.alibaba.dashscope.utils.Constants;
+import com.alibaba.dashscope.utils.JsonUtils;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.*;
+
+public class Image2Image {
+
+    static {
+        // The following URL is for the Singapore region. Replace {WorkspaceId} with your actual workspace ID. URLs differ by region.
+        Constants.baseHttpApiUrl = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1";
+    }
+
+    // If you have not configured an environment variable, replace the next line with: apiKey="sk-xxx"
+    // API keys differ between Singapore and Beijing. Get an API key: https://www.alibabacloud.com/help/model-studio/get-api-key
+    static String apiKey = System.getenv("DASHSCOPE_API_KEY");
+
+    /**
+     * Image input methods: choose one
+     *
+     * 1. Public URL — best for publicly accessible images
+     * 2. Local file — best for local development and testing
+     * 3. Base64 encoding — best for private images or secure transmission
+     */
+
+    // [Method 1] Public URL
+    static String imageUrl_1 = "https://img.alicdn.com/imgextra/i3/O1CN0157XGE51l6iL9441yX_!!6000000004770-49-tps-1104-1472.webp";
+    static String imageUrl_2 = "https://img.alicdn.com/imgextra/i3/O1CN01SfG4J41UYn9WNt4X1_!!6000000002530-49-tps-1696-960.webp";
+
+    // [Method 2] Local file path (file://+absolute path or file:///+absolute path)
+    // static String imageUrl_1 = "file://" + "/your/path/to/image_1.png";    // Linux/macOS
+    // static String imageUrl_2 = "file:///" + "C:/your/path/to/image_2.png";  // Windows
+
+    // [Method 3] Base64 encoding
+    // static String imageUrl_1 = encodeFile("/your/path/to/image_1.png");
+    // static String imageUrl_2 = encodeFile("/your/path/to/image_2.png");
+
+    // List of images to edit
+    static List<String> imageUrls = new ArrayList<>();
+    static {
+        imageUrls.add(imageUrl_1);
+        imageUrls.add(imageUrl_2);
+    }
+
+    public static void syncCall() {
+        ImageSynthesisParam param =
+                ImageSynthesisParam.builder()
+                        .apiKey(apiKey)
+                        .model("wan2.5-i2i-preview")
+                        .prompt("Place the alarm clock from image 1 beside the vase on the dining table in image 2.")
+                        .images(imageUrls)
+                        .n(1)
+                         //.size("1280*1280")
+                        .negativePrompt("")
+                        .promptExtend(true)
+                        .watermark(false)
+                        .seed(12345)
+                        .build();
+
+        ImageSynthesis imageSynthesis = new ImageSynthesis();
+        ImageSynthesisResult result = null;
+        try {
+            System.out.println("---sync call, please wait a moment----");
+            result = imageSynthesis.call(param);
+        } catch (ApiException | NoApiKeyException e){
+            throw new RuntimeException(e.getMessage());
+        }
+        System.out.println(JsonUtils.toJson(result));
+    }
+
+    /**
+     * Encode a file as a Base64 string
+     * @param filePath File path
+     * @return Base64 string in format data:{MIME_type};base64,{base64_data}
+     */
+    public static String encodeFile(String filePath) {
+        Path path = Paths.get(filePath);
+        if (!Files.exists(path)) {
+            throw new IllegalArgumentException("File not found: " + filePath);
+        }
+        // Detect MIME type
+        String mimeType = null;
+        try {
+            mimeType = Files.probeContentType(path);
+        } catch (IOException e) {
+            throw new IllegalArgumentException("Cannot detect file type: " + filePath);
+        }
+        if (mimeType == null || !mimeType.startsWith("image/")) {
+            throw new IllegalArgumentException("Unsupported or unrecognized image format");
+        }
+        // Read file and encode
+        byte[] fileBytes = null;
+        try{
+            fileBytes = Files.readAllBytes(path);
+        } catch (IOException e) {
+            throw new IllegalArgumentException("Cannot read file: " + filePath);
+        }
+
+        String encodedString = Base64.getEncoder().encodeToString(fileBytes);
+        return "data:" + mimeType + ";base64," + encodedString;
+    }
+
+    public static void main(String[] args) {
+        syncCall();
+    }
+}
+
      Response example
      +

      The image URL is valid for 24 hours. Download the image promptly.

      +
      {
+    "request_id": "d362685b-757f-4eac-bab5-xxxxxx",
+    "output": {
+        "task_id": "bfa7fc39-3d87-4fa7-b1e6-xxxxxx",
+        "task_status": "SUCCEEDED",
+        "results": [
+            {
+                "orig_prompt": "Place the alarm clock from image 1 beside the vase on the dining table in image 2.",
+                "actual_prompt": "Place the blue alarm clock from image 1 to the right of the vase on the dining table in image 2, near the edge of the tablecloth. Keep the clock facing the camera and parallel to the vase.",
+                "url": "https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/xxx.png?Expires=xxx"
+            }
+        ],
+        "task_metrics": {
+            "TOTAL": 1,
+            "SUCCEEDED": 1,
+            "FAILED": 0
+        }
+    },
+    "usage": {
+        "image_count": 1
+    }
+}
+

      Asynchronous call

      ImportantEnsure that the DashScope Python SDK version is at least1.25.2and the DashScope Java SDK version is at least2.22.2.

      Outdated SDK versions may trigger "url error, please check url!" errors. Install or upgrade the SDK.

      Python

      This example uses a public URL to pass the image.

      Request example 

      import os
+from http import HTTPStatus
+from urllib.parse import urlparse, unquote
+from pathlib import PurePosixPath
+import dashscope
+import requests
+from dashscope import ImageSynthesis
+
+# The following URL is for the Singapore region. Replace {WorkspaceId} with your actual workspace ID. URLs differ by region.
+dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1'
+
+# If you have not configured an environment variable, replace the next line with: api_key="sk-xxx"
+# API keys differ between Singapore and Beijing. Get an API key: https://www.alibabacloud.com/help/model-studio/get-api-key
+api_key = os.getenv("DASHSCOPE_API_KEY")
+
+# Public image URLs
+image_url_1 = "https://img.alicdn.com/imgextra/i3/O1CN0157XGE51l6iL9441yX_!!6000000004770-49-tps-1104-1472.webp"
+image_url_2 = "https://img.alicdn.com/imgextra/i3/O1CN01SfG4J41UYn9WNt4X1_!!6000000002530-49-tps-1696-960.webp"
+
+def async_call():
+    print('----create task----')
+    task_info = create_async_task()
+    print('----wait task----')
+    wait_async_task(task_info)
+
+# Create an asynchronous task
+def create_async_task():
+    rsp = ImageSynthesis.async_call(api_key=api_key,
+                                    model="wan2.5-i2i-preview",
+                                    prompt="Place the alarm clock from image 1 beside the vase on the dining table in image 2.",
+                                    images=[image_url_1, image_url_2],
+                                    negative_prompt="",
+                                    n=1,
+                                    # size="1280*1280",
+                                    prompt_extend=True,
+                                    watermark=False,
+                                    seed=12345)
+    print(rsp)
+    if rsp.status_code == HTTPStatus.OK:
+        print(rsp.output)
+    else:
+        print('Failed, status_code: %s, code: %s, message: %s' %
+              (rsp.status_code, rsp.code, rsp.message))
+    return rsp
+
+# Wait for the asynchronous task to finish
+def wait_async_task(task):
+    rsp = ImageSynthesis.wait(task=task, api_key=api_key)
+    print(rsp)
+    if rsp.status_code == HTTPStatus.OK:
+        print(rsp.output)
+        # Save file to current directory
+        for result in rsp.output.results:
+            file_name = PurePosixPath(unquote(urlparse(result.url).path)).parts[-1]
+            with open('./%s' % file_name, 'wb+') as f:
+                f.write(requests.get(result.url).content)
+    else:
+        print('Failed, status_code: %s, code: %s, message: %s' %
+              (rsp.status_code, rsp.code, rsp.message))
+
+# Fetch asynchronous task status
+def fetch_task_status(task):
+    status = ImageSynthesis.fetch(task=task, api_key=api_key)
+    print(status)
+    if status.status_code == HTTPStatus.OK:
+        print(status.output.task_status)
+    else:
+        print('Failed, status_code: %s, code: %s, message: %s' %
+              (status.status_code, status.code, status.message))
+
+# Cancel an asynchronous task. Only PENDING tasks can be canceled.
+def cancel_task(task):
+    rsp = ImageSynthesis.cancel(task=task, api_key=api_key)
+    print(rsp)
+    if rsp.status_code == HTTPStatus.OK:
+        print(rsp.output.task_status)
+    else:
+        print('Failed, status_code: %s, code: %s, message: %s' %
+              (rsp.status_code, rsp.code, rsp.message))
+
+if __name__ == '__main__':
+    async_call()
+

      Response example

        +
      1. Response when creating a task
        2. +
      {
+	"status_code": 200,
+	"request_id": "31b04171-011c-96bd-ac00-f0383b669cc7",
+	"code": "",
+	"message": "",
+	"output": {
+		"task_id": "4f90cf14-a34e-4eae-xxxxxxxx",
+		"task_status": "PENDING",
+		"results": []
+	},
+	"usage": null
+}
+
        +
      1. Response when querying task results
        2. +
      +

      Image URLs expire after 24 hours. Download images promptly.

      +
      {
+    "status_code": 200,
+    "request_id": "8ad45834-4321-44ed-adf5-xxxxxx",
+    "code": null,
+    "message": "",
+    "output": {
+        "task_id": "3aff9ebd-35fc-4339-98a3-xxxxxx",
+        "task_status": "SUCCEEDED",
+        "results": [
+            {
+                "url": "https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/xxx.png?Expires=xxx",
+                "orig_prompt": "Place the alarm clock from image 1 beside the vase on the dining table in image 2.",
+                "actual_prompt": "Place the blue alarm clock from image 1 to the right of the vase on the dining table in image 2, near the edge of the tablecloth. Keep the clock facing the camera and parallel to the tabletop, with natural shadow projection."
+            }
+        ],
+        "submit_time": "2025-10-23 16:18:16.009",
+        "scheduled_time": "2025-10-23 16:18:16.040",
+        "end_time": "2025-10-23 16:19:09.591",
+        "task_metrics": {
+            "TOTAL": 1,
+            "FAILED": 0,
+            "SUCCEEDED": 1
+        }
+    },
+    "usage": {
+        "image_count": 1
+    }
+}
+

      Java

      This example uses a public URL to pass the image by default.

      Request example 
      // Copyright (c) Alibaba, Inc. and its affiliates.
+
+import com.alibaba.dashscope.aigc.imagesynthesis.ImageSynthesis;
+import com.alibaba.dashscope.aigc.imagesynthesis.ImageSynthesisListResult;
+import com.alibaba.dashscope.aigc.imagesynthesis.ImageSynthesisParam;
+import com.alibaba.dashscope.aigc.imagesynthesis.ImageSynthesisResult;
+import com.alibaba.dashscope.exception.ApiException;
+import com.alibaba.dashscope.exception.NoApiKeyException;
+import com.alibaba.dashscope.task.AsyncTaskListParam;
+import com.alibaba.dashscope.utils.Constants;
+import com.alibaba.dashscope.utils.JsonUtils;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class Image2Image {
+
+    static {
+        // The following URL is for the Singapore region. Replace {WorkspaceId} with your actual workspace ID. URLs differ by region.
+        Constants.baseHttpApiUrl = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1";
+    }
+
+    // If you have not configured an environment variable, replace the next line with: apiKey="sk-xxx"
+    // API keys differ between Singapore and Beijing. Get an API key: https://www.alibabacloud.com/help/model-studio/get-api-key
+    static String apiKey = System.getenv("DASHSCOPE_API_KEY");
+
+    // Public URLs
+    static String imageUrl_1 = "https://img.alicdn.com/imgextra/i3/O1CN0157XGE51l6iL9441yX_!!6000000004770-49-tps-1104-1472.webp";
+    static String imageUrl_2 = "https://img.alicdn.com/imgextra/i3/O1CN01SfG4J41UYn9WNt4X1_!!6000000002530-49-tps-1696-960.webp";
+
+    // List of images to edit
+    static List<String> imageUrls = new ArrayList<>();
+    static {
+        imageUrls.add(imageUrl_1);
+        imageUrls.add(imageUrl_2);
+    }
+
+    public static void asyncCall() {
+        ImageSynthesisParam param =
+                ImageSynthesisParam.builder()
+                        .apiKey(apiKey)
+                        .model("wan2.5-i2i-preview")
+                        .prompt("Place the alarm clock from image 1 beside the vase on the dining table in image 2.")
+                        .images(imageUrls)
+                        .n(1)
+                        //.size("1280*1280")
+                        .negativePrompt("")
+                        .promptExtend(true)
+                        .watermark(false)
+                        .seed(12345)
+                        .build();
+        ImageSynthesis imageSynthesis = new ImageSynthesis();
+        ImageSynthesisResult result = null;
+        try {
+            System.out.println("---async call, please wait a moment----");
+            result = imageSynthesis.asyncCall(param);
+        } catch (ApiException | NoApiKeyException e){
+            throw new RuntimeException(e.getMessage());
+        }
+
+        System.out.println(JsonUtils.toJson(result));
+
+        String taskId = result.getOutput().getTaskId();
+
+        System.out.println("taskId=" + taskId);
+
+        try {
+            result = imageSynthesis.wait(taskId, apiKey);
+        } catch (ApiException | NoApiKeyException e){
+            throw new RuntimeException(e.getMessage());
+        }
+        System.out.println(JsonUtils.toJson(result));
+        System.out.println(JsonUtils.toJson(result.getOutput()));
+    }
+
+    public static void listTask() throws ApiException, NoApiKeyException {
+        ImageSynthesis is = new ImageSynthesis();
+        AsyncTaskListParam param = AsyncTaskListParam.builder().build();
+        param.setApiKey(apiKey);
+        ImageSynthesisListResult result = is.list(param);
+        System.out.println(result);
+    }
+
+    public void fetchTask(String taskId) throws ApiException, NoApiKeyException {
+        ImageSynthesis is = new ImageSynthesis();
+        // If DASHSCOPE_API_KEY is set as an environment variable, apiKey can be empty.
+        ImageSynthesisResult result = is.fetch(taskId, apiKey);
+        System.out.println(result.getOutput());
+        System.out.println(result.getUsage());
+    }
+
+    public static void main(String[] args) {
+        asyncCall();
+    }
+}
+
      Response example
        +
      1. Response when creating a task
        2. +
      {
+	"request_id": "5dbf9dc5-4f4c-9605-85ea-542f97709ba8",
+	"output": {
+		"task_id": "7277e20e-aa01-4709-xxxxxxxx",
+		"task_status": "PENDING"
+	}
+}
+
        +
      1. Response when querying task results
        2. +
      +

      Image URLs expire after 24 hours. Download images promptly.

      +
      {
+    "request_id": "d362685b-757f-4eac-bab5-xxxxxx",
+    "output": {
+        "task_id": "bfa7fc39-3d87-4fa7-b1e6-xxxxxx",
+        "task_status": "SUCCEEDED",
+        "results": [
+            {
+                "orig_prompt": "Place the alarm clock from image 1 beside the vase on the dining table in image 2.",
+                "actual_prompt": "Place the blue alarm clock from image 1 to the right of the vase on the dining table in image 2, near the edge of the tablecloth. Keep the clock facing the camera and parallel to the vase.",
+                "url": "https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/xxx.png?Expires=xxx"
+            }
+        ],
+        "task_metrics": {
+            "TOTAL": 1,
+            "SUCCEEDED": 1,
+            "FAILED": 0
+        }
+    },
+    "usage": {
+        "image_count": 1
+    }
+}
+

      curl

      This is a two-step process: create a task, then retrieve the result.

      Note

        +
      • For asynchronous calls, set the header parameter X-DashScope-Async to enable.
        • +
      • The task_id for an asynchronous task is valid for 24 hours. After it expires, the task status becomes UNKNOWN.
        • +

      Step 1: Send a request to create a task

      This request returns a task ID (task_id).

      Request example 
       curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image2image/image-synthesis' \
+    -H 'X-DashScope-Async: enable' \
+    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -d '{
+    "model": "wan2.5-i2i-preview",
+    "input": {
+        "prompt": "Place the alarm clock from image 1 beside the vase on the dining table in image 2.",
+        "images": [
+            "https://img.alicdn.com/imgextra/i3/O1CN0157XGE51l6iL9441yX_!!6000000004770-49-tps-1104-1472.webp",
+            "https://img.alicdn.com/imgextra/i3/O1CN01SfG4J41UYn9WNt4X1_!!6000000002530-49-tps-1696-960.webp"
+        ]
+    },
+    "parameters": {
+        "n": 1
+    }
+}'
+
      Response example
      {
+    "output": {
+        "task_status": "PENDING",
+        "task_id": "0385dc79-5ff8-4d82-bcb6-xxxxxx"
+    },
+    "request_id": "4909100c-7b5a-9f92-bfe5-xxxxxx"
+}
+

      Step 2: Query the result by task ID

      Use the task_id obtained in the previous step to poll the task status through the API until the task_status becomes SUCCEEDED or FAILED.

      Request example

      Replace {task_id} with the task_id value returned by the previous API call. The task_id is valid for queries for 24 hours, Replace {WorkspaceId} with your actual workspace ID.

      curl -X GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id} \
+--header "Authorization: Bearer $DASHSCOPE_API_KEY"
+
      Response example
      +

      The image URL is valid for 24 hours. Download the image promptly.

      +
      {
+    "request_id": "d1f2a1be-9c58-48af-b43f-xxxxxx",
+    "output": {
+        "task_id": "7f4836cd-1c47-41b3-b3a4-xxxxxx",
+        "task_status": "SUCCEEDED",
+        "submit_time": "2025-09-23 22:14:10.800",
+        "scheduled_time": "2025-09-23 22:14:10.825",
+        "end_time": "2025-09-23 22:15:23.456",
+        "results": [
+            {
+                "orig_prompt": "Place the alarm clock from image 1 next to the vase on the dining table in image 2",
+                "url": "https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/xxx.png?Expires=xxx"
+            }
+        ],
+        "task_metrics": {
+            "TOTAL": 1,
+            "FAILED": 0,
+            "SUCCEEDED": 1
+        }
+    },
+    "usage": {
+        "image_count": 1
+    }
+}
+
      +

      Model selection

      +
        +
      • +

        wan2.7-image-pro and wan2.7-image (recommended): Best for precise editing or generating multiple coherent images.

        +
          +
        • Precise local editing: Select a specific area to move, replace, or add elements. Ideal for e-commerce retouching and design adjustments.
          • +
        • Multi-panel generation: Generate multiple consistent-style images in one call. Ideal for comic storyboards and product series.
          • +
        +
        • +
      • +

        wan2.6-image: Stylized editing with mixed text/images or multiple references. Generates text in images and accepts up to four reference images.

        +
        • +
      • +

        wan2.5-i2i-preview: Suitable for simple image editing and multi-image fusion.

        +
        • +
      +

      For the input and output specifications of each model, see Input image specifications and Output image resolution.

      + +

      Image-to-image set

      +

      Input image

      Output image

      East Asian male portrait, 20 years old, curly medium-length hair, artistic temperament

      output

      wan_image_reqid_57d7a71c-1932-4de8-8c32-be0f3fd5696f_n1-2026-03-31-19-32-44

      output

      +

      Click to view prompts

      Case 1: Photoshoot

      Base character setting: A 20-year-old East Asian male with curly, medium-length hair, an artistic temperament, defined features, and delicate eyes. He is wearing a simple white T-shirt or a light blue shirt, exuding a youthful and natural vibe.
+1. Republic Era Scholar Style
+Prompt:
+[Base facial description] The character's appearance is based on reference image 1, wearing a dark cyan long gown and round, gold-rimmed glasses, holding a folding fan. The background is an old Shanghai study with wooden bookshelves, a warm yellow tone, a retro film texture, soft side lighting, and dust dancing in the light beams, creating a cultural and serene atmosphere. Hasselblad medium format, 85mm lens, high resolution, cinematic color grading, Wong Kar-wai style.
+Props: Folding fan / Thread-bound book / Round-frame glasses
+Color tone: Warm yellow / Dark cyan / Sepia
+2. British Gentleman Style
+Prompt:
+[Base facial description] The character's appearance is based on reference image 1, wearing a dark gray tweed three-piece suit and a vintage mechanical watch, holding a glass of red wine and looking at it. The background is a classic library or private club with dark leather sofas, Rembrandt lighting, and a dark, elegant, and noble atmosphere. He has a cool gaze, with rich details and clear textures, exuding a British aristocratic temperament. 8k resolution, fashion magazine-style shot.
+Props: Wine glass / Pipe / Mechanical watch
+Color tone: Dark gray / Burgundy / Dark gold
+3. 90s HK Retro Style
+Prompt:
+[Base facial description] The character's appearance is based on reference image 1, wearing a washed denim jacket or a floral shirt, with slightly messy hair and arms crossed. The background is a street with neon signs at night, with blurry light spots, high grain, and rich colors, featuring a red and blue color clash. Wong Kar-wai style, emotional, with a dreamy gaze, direct flash effect, and a nostalgic atmosphere. [Full-body shot].
+Color tone: Neon red / Dark blue / Film green
+4. New Chinese Zen Style
+Prompt:
+[Base facial description] The character's appearance is based on reference image 1, with a slight smile showing teeth, wearing a modified white Chinese stand-up collar shirt, holding a branch of plum blossoms. The background is a minimalist blank wall or a bamboo forest, with sunlight casting mottled shadows on the wall. The color tone is cool and serene, embodying Eastern aesthetics. The skin is translucent, with high grain and a matte finish. The composition is simple, with rich layers of light and shadow. High-end photography, Zen atmosphere.
+Props: Plum blossom branch
+Color tone: White / Dark green / Light gray
+5. Vintage Artist Style
+Prompt:
+[Base facial description] The character's appearance is based on reference image 1, wearing a white shirt stained with paint and a brown leather apron, holding a paintbrush or a palette. The background is a clean studio with bright light and colorful light and shadow. He has a focused expression, looking at the paint in his hand, not at the camera. His hair is slightly messy, with an artistic flair, an impressionist color tone, and a strong texture.
+Props: Paintbrush / Palette / Sketchbook
+Color tone: Warm light / Colorful paint / Brown
+6. Classic Noir B&W Style
+Prompt:
+[Base facial description] The character's appearance is based on reference image 1, wearing a black turtleneck sweater, holding a cigarette, and wearing a black fedora. The background is a staircase or hallway with intersecting shadows. High-contrast black and white photography, hard lighting, strong shadows, a sense of mystery, and a hard-boiled detective style. The facial contours are sharp, with extremely clear skin texture. A classic movie still, timeless feel, side-profile close-up, artistic photography.
+Props: Cane / Fedora / Sunglasses
+Color tone: Black and white / High contrast
+

      Case 2: Visual design

      Image 1: A commercial-grade product photography main visual cover image, front-view panoramic composition. A pair of retro-futuristic wireless over-ear headphones floats above a geometric plaster form, showcasing perfect symmetrical aesthetics. The materials are champagne gold metal and a cream-white shell. The background is a deeply blurred warm indoor light and shadow, with soft light outlining the product's silhouette. The white space in the image creates a strong sense of breathability, suggesting a quiet auditory experience. 8k ultra-high resolution, minimalist and premium feel.
+Image 2: A 100mm macro shot of the product's material details, focusing closely on the connection of the headphone's telescopic arm. It clearly shows the texture of the champagne gold brushed aluminum alloy and the CNC precision-cut chamfers. A sharp backlight creates a starburst highlight on the metal edge. The background is dark to emphasize the industrial precision of the metal. The image quality is extremely sharp with no noise.
+Image 3: An extreme close-up macro shot of the material, focusing on the surface of the mocha-colored protein leather earcups. Side lighting reveals the fine pore texture of the leather, the soft wrinkles from pressing, and the ventilation hole details, conveying ultimate skin-friendly comfort and resilience. The light and shadow are rich in layers, and the color tone is warm and moist. Ultra-high-definition macro photography.
+Image 4: An artistic exploded view of the product, showing the internal sound units, noise-canceling chips, battery modules, and external walnut wood decorative panels and metal frame of the retro-futuristic headphones in a suspended, disassembled state. The background is a deep tech blue, and the internal components have a semi-transparent holographic technological texture, emphasizing the combination of internal precision craftsmanship and modern technology. High-tech commercial poster style.
+Image 5: A 35mm humanistic shot of the wearing scenario, with a close-up on the model's jawline and neck, showing the perfect fit of the champagne gold headphones. Natural warm sunset light from the side-rear creates a rim light, with the edges of the hair glowing gold. The model's skin tone has a healthy and natural texture, creating a relaxed, immersive music-listening lifestyle feel. The background is a blurry home environment.
+Image 6: A still life photograph paying homage to architectural light and shadow. The headphones are placed on a minimalist gray concrete table. Afternoon sunlight streams through blinds, casting striped hard shadows that cut across the matte cream-white body and champagne gold frame, creating a strong geometric composition of light and dark. This highlights the three-dimensional shape of the body and the contrast of materials. A clash of cool and warm color tones, minimalist composition.
+Image 7: A top-down flat-lay composition showing the color options. Three headphones from the series in different color schemes—silver-white, black-gold, and blue-copper—are arranged side by side. The background is a highly textured gray wool felt cloth. Soft top lighting emphasizes the diversity of the CMF design and the delicate touch of the materials. The image is clean and orderly, in a design magazine style.
+Image 8: A brand lifestyle family portrait still life photograph. The retro-futuristic headphones are placed next to their matching exquisite leather case. On the table are a vinyl record player, a spinning vinyl record, and a cup of steaming coffee. The background is rendered with warm ambient lighting, dominated by a deep walnut wood tone, conveying a brand philosophy that combines a slow-paced lifestyle with high-fidelity sound quality. Cinematic narrative lighting.
+
      +

      Interactive editing

      +

      Input image

      Output image

      image (20)-2026-03-31-19-17-37

      image (21)-2026-03-31-19-17-37

      Edit based on image 1. Replace the raspberry selected in box 1 with a lemon, the raspberry in box 2 with a strawberry, and the raspberry in box 3 with a blueberry. The result should be harmoniously integrated with the original image, without the reference boxes and numbers, and keep the rest of the content unchanged.

      5eecdaf48460cde5f7fd58249809b192a118accde85283f275b8339e1c4c24831b75b38faadcd24bec177c308ebd5304463ca8e345548eb5f551b6ba01cd2c8d2d9b5606fa569ff7ba4077816ac9b801464f65aedbcf494f4fb4c8ed7016461c-combine

      5eecdaf48460cde5f7fd58249809b192a118accde85283f275b8339e1c4c24831b75b38faadcd24bec177c308ebd530460436714d0283cee289325430893028097a53a8e5d630fb1c2d4c85d8cbb68a4387575c4b03700344fb4c8ed7016461c-2026-03-31-19-13-38

      Place the selected pattern from image 1 into the selected area in image 2.

      +

      Multi-image fusion

      +

      Input image

      Output image

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304e9d05d028a65a9ac270ee730e44b8c75c6634a9b9a7a70240d438b02b2f2153dc68966b442378d1d4fb4c8ed7016461c-combine

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd53044b9a1d72dee2f8507ee704b9cef3832907ff1182f52507c9bc4737520762d46a722e658f57cda6524fb4c8ed7016461c-2025-12-29-19-11-31

      Take a portrait of the boy from image 1 and the dog from image 2. The boy is hugging the dog, and both are very happy. Studio soft lighting, blue textured background.

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304f060ec7a363e318af9bfaaa5e07be972cfc1ea4e21b47637fcdb2dfc53130c40a8efed5defc408a04fb4c8ed7016461c-combine

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304922cbdef3e3c42f83239de6d0f35a8b76f0e38934cc5170f7a908ec12140fb0af6590c72bcf1ba6f4fb4c8ed7016461c-2025-12-29-19-15-53

      Recolor the dress from image 1 using the colors of the bird in image 2. Make it artistic, but keep the style of the dress and the model unchanged.

      +

      Subject feature preservation

      +

      Input image

      Output image

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304448a972b9f2ee7a7aadcc61495f4975a049f009e7721cbc833dc3a8005b1b026a54eaaec109d73484fb4c8ed7016461c-2025-12-29-20-00-21

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304cc1b4a509823c5fb5e60999898811f8b51d7419220a118c9ff82110bc9525725a9ad7338f75985794fb4c8ed7016461c-2025-12-29-20-00-21

      Please generate a set of four Polaroid photos with the theme "Seasonal Changes". Each photo is taken at the same location, under a tree in a park, but shows the scenes of spring, summer, autumn, and winter respectively. The person's attire should also match the season: a light jacket in spring, a short-sleeved shirt in summer, a trench coat in autumn, and a scarf and thick coat in winter. Place this set of photos on a dining table.

      +

      Detection and segmentation

      +

      Input image

      Output image

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304b025e74206dc2cec5c2e587c3fe6fb135293836c9479220355470da15476dc934b26018061e9db0b4fb4c8ed7016461c-2025-12-29-19-54-33

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd530451385eb561b49b0fe1f2169526b6a7e15bd78940def3c640c801511c349f6df35dceb72f4d3755f94fb4c8ed7016461c-2025-12-29-19-54-33

      Detect the laptop and alarm clock in the image, draw bounding boxes, and label them "laptop" and "clock".

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd530440256f9add4113787af5d4f3a55469b38ef2422f018076640eb7cb552584c02ee729fcb23fec3bca4fb4c8ed7016461c-2025-12-29-19-54-33

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304f0612d67f5c810ebef958385624ebd17323047aa5d00465d0e35257de5a2ea49d4b375d2e57693fa4fb4c8ed7016461c-2025-12-29-19-54-32

      Segment the glass cup in the image.

      +

      Extract elements

      +

      Input image

      Output image

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd53046b83761f1ab18c40e144f5db2b388e5f865ba9a5961d98b2710ce177c6a0f4baff63fe52259c44364fb4c8ed7016461c-2025-12-29-19-48-27

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd53048e2a0d1d2805d92ba8d45a3bd1368528dd76f517b21ad1f545eb4097610838497cbdb5196da94ff54fb4c8ed7016461c-2025-12-29-19-48-27

      Extract the clothing items from the uploaded photo and arrange them in a flat-lay display on a pure white background. Maintain realistic details and material textures. Fashion e-commerce style, suitable for clothing display.

      +

      Text editing

      +

      Input image

      Output image

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd530490f493eca22f34f0197173ddfdef17a04b34cb94813178b9d4eee36d246d3530a3e2fc6258cca0694fb4c8ed7016461c-2025-12-29-19-28-35

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304fe77776567f4ef79cb621289a6fdaa981f3364fe4c7c56265403b5d9d5ac43eaf5931f62db14952f4fb4c8ed7016461c-2025-12-29-19-28-35

      Remove all watermarks from the image.

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd530476e971380812b1b9dbeac68272a27057175499fe84f0781c7b6fa6535f438c67f3556acc8c7324394fb4c8ed7016461c-2025-12-29-19-28-35

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd53047be52c6f41edecdefa77f0d93335d1492f1821b47dff7a1b08f60e99bdafcc84c31e3658fc593c904fb4c8ed7016461c-2025-12-29-19-28-35

      Casually write "Time for Holiday?" on the sand with a hand.

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304fdb284f8d5c8ead814d11890da1a49411a6d9d41ad1bb2a4bf0b93d0bee5d792e8f5b419a3da9d534fb4c8ed7016461c-2025-12-29-19-28-34

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304df1c8787530497f4cc3bee0b84d3ba51d0353fceb8d0518ded6a25e8c0ddfec714f719154ac1c9354fb4c8ed7016461c-2025-12-29-19-28-34

      Change 18 to 29 and JUNE to SEPTEMBER.

      +

      Camera and perspective editing

      +

      Input image

      Output image

      image (2)-2025-12-29-19-42-44

      image (3)-2025-12-29-19-42-44

      Keep the person's features unchanged and generate front, side, and back views.

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd5304a53988b2efdd2fb6b95cb3b1b02701e6ff2c4902170b1ee230a9b4e3726a891c93646d68b821de294fb4c8ed7016461c-2025-12-29-19-42-43

      5eecdaf48460cde5544f9fac410016bc2fe4c1b4d23666c075b8339e1c4c24831b75b38faadcd24bec177c308ebd530428783dee341e41eb06234dfb75bd149d774f4850000123559a98bcd7ece97dc4a6c3cefa983ae8ac4fb4c8ed7016461c-2025-12-29-19-42-43

      Reshoot this photo with a fisheye lens.

      +

      Input specifications

      +

      Input image specifications

      +

      Specification

      wan2.7-image-pro, wan2.7-image

      wan2.6-image

      wan2.5-i2i-preview

      Number of input images

      0 to 9 (0 corresponds to text-to-image mode)

      Image editing: 1 to 4 / Mixed text and image: 0 to 1

      1 to 3

      Image format

      JPEG, JPG, PNG (alpha channel not supported), BMP, WEBP

      JPEG, JPG, PNG (alpha channel not supported), BMP, WEBP

      JPEG, JPG, PNG (alpha channel not supported), BMP, WEBP

      Image width and height range

      [240, 8000] pixels

      [240, 8000] pixels

      [384, 5000] pixels

      File size

      ≤ 20 MB

      ≤ 10 MB

      ≤ 10 MB

      Aspect ratio

      [1:8, 8:1]

      Unlimited

      [1:4, 4:1]

      +

      Image input order

      +

      Image numbers in prompts correspond to array position: the first image is "image 1", the second is "image 2". You can also use markers like "[image 1]" and "[image 2]".

      +
      {
+    "content": [
+        {"text": "Editing instruction, for example: Place the alarm clock from image 1 next to the vase on the dining table in image 2"},
+        {"image": "https://example.com/image1.png"},
+        {"image": "https://example.com/image2.png"}
+    ]
+}
+
      +

      Input image

      Output image

      image (19)-转换自-png

      Image 1

      image (20)-转换自-png

      Image 2

      04e0fc39-7ad6-41e0-9df9-1f69ac3ce825-转换自-png

      Prompt: Move image 1 onto image 2

      36ed450d-bd54-4169-b13f-3d0f26d9d360-转换自-png

      Prompt: Move image 2 onto image 1

      +

      Image input methods

      +

      Pass images using any of these methods:

      +

      Method 1: Public URL

        +
      • Provide a publicly accessible HTTP or HTTPS image URL.
        • +
      • Example value: https://xxxx/img.png.
        • +
      • Use when images are hosted on OSS or a public image hosting service.
        • +
      +

      Method 2: Base64 encoding

      Convert the image file to a Base64-encoded string and format it as: data:{MIME_type};base64,{base64_data}.

        +
      • +

        Example value: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABDg...... (This is a snippet due to length limitations). When making a call, pass the complete string.

        +
        • +
      • +

        {base64_data}: The Base64-encoded string of the image file.

        +
        • +
      • +

        {MIME_type}: The media type of the image, which must correspond to the file format.

        +

        Image format

        MIME Type

        JPEG

        image/jpeg

        JPG

        image/jpeg

        PNG

        image/png

        BMP

        image/bmp

        WEBP

        image/webp

        +
        • +
      • +

        Use for local, private, or encrypted image transmission.

        +
        • +

      Code example: Base64 encoding for an image

      import os
+import base64
+import mimetypes
+
+# The format is data:{mime_type};base64,{base64_data}
+def encode_file(file_path):
+    mime_type, _ = mimetypes.guess_type(file_path)
+    with open(file_path, "rb") as image_file:
+        encoded_string = base64.b64encode(image_file.read()).decode('utf-8')
+    return f"data:{mime_type};base64,{encoded_string}"
+
+# Call the encoding function. Replace "/path/to/your/image.png" with the path to your local image file, otherwise the code will not run.
+image = encode_file("/path/to/your/image.png")
+
      +

      Method 3: Local file path (SDK only)

        +
      • +

        Python SDK: Supports both absolute and relative paths. The file path rules are as follows:

        +

        System

        Input file path

        Example (absolute path)

        Example (relative path)

        Linux or macOS

        file://{absolute or relative path of the file}

        file:///home/images/test.png

        file://./images/test.png

        Windows

        file://D:/images/test.png

        file://./images/test.png

        +
        • +
      • +

        Java SDK: Supports only the absolute path. The file path rules are as follows:

        +

        System

        Input file path

        Example (absolute path)

        Linux or macOS

        file://{absolute path of the file}

        file:///home/images/test.png

        Windows

        file:///{absolute path of the file}

        file:///D:/images/test.png

        +
        • +
      • +

        Use for quick testing in local development.

        +
        • +
      +

      Key features

      +

      1. Instruction following (prompts)

      +

      Parameters: messages.content.text or input.prompt (required), negative_prompt (optional).

      +
        +
      • text or prompt (Positive prompt): Describe content, subjects, scenes, styles, lighting, and composition for the output image.
        • +
      • negative_prompt (Negative prompt): Specify unwanted content, such as "blurry" or "extra fingers".
        • +
      +

      Parameter

      wan2.7-image-pro, wan2.7-image

      wan2.6-image

      wan2.5-i2i-preview

      text

      Required, up to 5,000 characters

      Required, up to 2,000 characters

      Not supported

      prompt

      Not supported

      Not supported

      Required, up to 2,000 characters

      negative_prompt

      Not supported

      Supported, up to 500 characters

      Supported, up to 500 characters

      +

      2. Enable intelligent prompt rewriting

      +

      Parameter: parameters.prompt_extend (bool, defaults to true).

      +

      Expands short prompts to improve image quality at the cost of increased response time.

      +

      Best practices:

      +
        +
      • Enable: When prompts are concise or broad.
        • +
      • Disable: For fine detail control, detailed descriptions, or latency-sensitive scenarios. Set prompt_extend to false.
        • +
      +

      Parameter

      wan2.7-image-pro, wan2.7-image

      wan2.6-image

      wan2.5-i2i-preview

      prompt_extend

      Not supported

      Supported (image editing mode only)

      Supported

      +

      3. Set the output image resolution

      +

      Parameter: parameters.size (string), in the format "width*height".

      +
      Parameterwan2.7-image-pro, wan2.7-imagewan2.6-imagewan2.5-i2i-preview

      size

      		Method 1: Specify the output image resolution (recommended)

      In editing mode (with at least one image passed), the optional output resolution tiers are: 1K, 2K (default).

        +
      • 1K: The output total pixels are close to 1024*1024, with the aspect ratio matching the last input image.
        • +
      • 2K: The output total pixels are close to 2048*2048, with the aspect ratio matching the last input image.
        • +
      Method 2: Specify the width and height pixel values of the generated image
        +
      • The total pixels are between 768768 and 20482048, with an aspect ratio range of [1:8, 8:1].
        • +
      +

      Only wan2.7-image-pro in text-to-image scenarios supports 4K resolution.

      +
      		Method 1: Reference the input image ratio (recommended)

      In editing mode (enable_interleave=false), the optional output resolution tiers are: 1K (default), 2K.

        +
      • 1K: The output total pixels are close to 1280*1280, with the aspect ratio matching the last input image.
        • +
      • 2K: The output total pixels are close to 2048*2048, with the aspect ratio matching the last input image.
        • +
      Method 2: Specify the width and height pixel values of the generated image
        +
      • The total pixels are between 768768 and 20482048, with an aspect ratio range of [1:4, 4:1].
        • +
      +

      The actual output image pixel values will be the closest multiple of 16 to the specified value.

      +
      		Only supports specifying the width and height pixel values of the generated image
        +
      • The total pixels are between 768768 and 12801280, with an aspect ratio range of [1:4, 4:1].
        • +
      • If size is not specified, the system will default to generating an image with a total pixel count of 1280*1280, with the aspect ratio matching the last input image.
        • +
      +

      4. Interactive precise editing

      +

      Use parameters.bbox_list to select specific regions for editing. Only supported by wan2.7-image-pro and wan2.7-image.

      +
        +
      • List length: Must match the number of input images. Use an empty list [] for images that don't require editing.
        • +
      • Coordinate format: [x1, y1, x2, y2] (top-left x, top-left y, bottom-right x, bottom-right y). Coordinates are absolute pixel values with origin (0, 0) at top-left, x-axis right, y-axis down.
        • +
      • Quantity limit: A maximum of 2 bounding boxes per image.
        • +
      +

      Example: 3 input images where image 1 has two bounding boxes and image 2 has none

      +
      [
+  [[0, 0, 12, 12], [25, 25, 100, 100]],  # Image 1 (2 boxes)
+  [],                                    # Image 2 (no box)
+  [[10, 10, 50, 50]]                    # Image 3 (1 box)
+]
+
      +

      Click to view call examples

      curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"image": "https://img.alicdn.com/imgextra/i3/O1CN0157XGE51l6iL9441yX_!!6000000004770-49-tps-1104-1472.webp"},
+                        {"image": "https://img.alicdn.com/imgextra/i3/O1CN01SfG4J41UYn9WNt4X1_!!6000000002530-49-tps-1696-960.webp"},
+                        {"text": "Place the alarm clock from image 1 into the bounding box of image 2, and blend the scene and lighting naturally."}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "bbox_list": [[],[[989, 515, 1138, 681]]],
+            "size": "2K",
+            "n": 1,
+            "watermark": false
+        }
+    }'
+
+

      How to determine editing region coordinates

      Method 1: Draw bounding boxes with OpenCV

      Draw bounding boxes by dragging the mouse on the image for precise and intuitive selection:

      # Install dependencies: pip install opencv-python
+import cv2
+import urllib.request
+
+# Download a sample image (replace with your own image URL or local path)
+image_url = "https://img.alicdn.com/imgextra/i3/O1CN01SfG4J41UYn9WNt4X1_!!6000000002530-49-tps-1696-960.webp"
+urllib.request.urlretrieve(image_url, "example.webp")
+
+# Read the image and open an interactive window
+img = cv2.imread("example.webp")
+# Drag the mouse in the pop-up window to draw a box. Press Enter to confirm, press Esc to cancel
+x, y, w, h = cv2.selectROI("Draw bounding box (Enter=confirm, Esc=cancel)", img)
+cv2.destroyAllWindows()
+
+# Convert the (x, y, w, h) returned by OpenCV to the [x1, y1, x2, y2] format required by bbox_list
+# Coordinate system: origin at the top-left corner, x-axis points right, y-axis points down, unit is pixels
+bbox = [x, y, x + w, y + h]
+print(f"Bounding box coordinates: {bbox}")  # Pass these coordinates to parameters.bbox_list
+
      Method 2: Visual understanding model

      Use qwen3.6-plus to automatically identify target region coordinates by describing the target in natural language:

      # Install dependencies: pip install dashscope pillow
+import os
+import json
+from dashscope import MultiModalConversation
+import dashscope
+from PIL import Image
+import urllib.request
+
+# The following URL is for the Singapore region. Replace WorkspaceId with your actual workspace ID. URLs differ by region.
+dashscope.base_http_api_url = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1"
+
+def get_bbox_list(image, prompt):
+    """
+    Identify target regions in an image using qwen3.6-plus and return absolute pixel coordinates.
+
+    Args:
+        image: Image URL or local path (local path format: "file:///absolute/path.png")
+        prompt: Natural language description, e.g., "coffee cup", "all fruits on the plate", "the fruit in the center of the plate"
+
+    Returns:
+        [[x1, y1, x2, y2], ...] Absolute pixel coordinates that can be passed directly to bbox_list
+    """
+    # Concatenate user description with return format instructions
+    full_prompt = (
+        prompt + "\n"
+        "Based on the description above, return the coordinates of the corresponding region.\n"
+        "Return a maximum of 2 regions, prioritizing the most matching target.\n"
+        "Strictly follow the JSON 2D list format: [[x1, y1, x2, y2], ...]\n"
+        "Each set of coordinates: [top-left x, top-left y, bottom-right x, bottom-right y]\n"
+        "Use absolute pixel coordinates of the original image, with (0,0) at the top-left corner, x-axis pointing right, y-axis pointing down.\n"
+        "If there is only one region, you must still use a 2D list: [[x1, y1, x2, y2]]\n"
+        "Only return the JSON list, do not return any other content."
+    )
+
+    messages = [
+        {'role': 'user',
+         'content': [
+             {'image': image},
+             {'text': full_prompt}
+         ]}
+    ]
+
+    response = MultiModalConversation.call(
+        api_key=os.getenv('DASHSCOPE_API_KEY'),
+        model='qwen3.6-plus',
+        messages=messages,
+    )
+
+    text = response.output.choices[0].message.content[0]["text"]
+    text = text.replace("```json", "").replace("```", "").strip()
+    coords = json.loads(text)
+
+    # Handle the case where the model returns a 1D list [x1,y1,x2,y2]
+    if coords and not isinstance(coords[0], list):
+        coords = [coords]
+
+    # Get image dimensions for coordinate conversion
+    if image.startswith("file://"):
+        local_path = image[len("file://"):]
+        img = Image.open(local_path)
+    else:
+        tmp_path = "temp_bbox_image"
+        urllib.request.urlretrieve(image, tmp_path)
+        img = Image.open(tmp_path)
+    width, height = img.size
+
+    # Convert model's normalized coordinates [0, 999] to absolute pixel coordinates
+    bbox_list = []
+    for box in coords:
+        bbox_list.append([
+            int(box[0] / 1000 * width),
+            int(box[1] / 1000 * height),
+            int(box[2] / 1000 * width),
+            int(box[3] / 1000 * height)
+        ])
+
+    return bbox_list
+
+# === Usage examples ===
+image_url = "https://img.alicdn.com/imgextra/i3/O1CN01ewUWhg1eS3VqJ3wap_!!6000000003869-49-tps-2048-2048.webp"
+
+# Select target by name
+bbox = get_bbox_list(image_url, "coffee cup")           # [[x1, y1, x2, y2]]
+
+# Select target by position description
+bbox = get_bbox_list(image_url, "the fruit in the center of the plate")  # [[x1, y1, x2, y2]]
+
+# Describe a region
+bbox = get_bbox_list(image_url, "lavender potted plant")
+
+# Results can be used as elements in the bbox_list array
+# Note: A maximum of 2 bounding boxes per image
+
      +

      Billing and rate limits

      +
        +
      • +

        Free quota and pricing: Model list and pricing.

        +
        • +
      • +

        For rate limits, see Wanxiang.

        +
        • +
      • +

        Billing:

        +
          +
        • Charges apply per successfully generated image. You are charged only when the API returns a task_status of SUCCEEDED.
          • +
        • Failed model calls or processing errors do not incur any fees or consume the free quota.
          • +
        +
        • +
      +

      API reference

      +

      Each model uses a different endpoint and request structure:

      +

      Model

      Endpoint(Example for the Singapore region)

      wan2.7-image, wan2.7-image-pro, wan2.6-image

      Sync API: POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

      Async API: POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation

      Replace WorkspaceId with your actual Workspace ID.

      wan2.5-i2i-preview

      Async API: POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image2image/image-synthesis

      Replace WorkspaceId with your actual Workspace ID.

      +
        +
      • wan2.7 / wan2.6: Use the messages format. In the messages[].content array, pass the image in the image parameter and the prompt in the text parameter.
        • +
      • wan2.5: Pass the image in the input.images array and the prompt in the input.prompt parameter.
        • +
      +
      "input": {
+    "messages": [
+        {
+            "role": "user",
+            "content": [
+                {"image": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp"},
+                {"image": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp"},
+                {"text": "Spray the graffiti from image 2 onto the car in image 1"}
+            ]
+        }
+    ]
+}
+
      "input": {
+    "prompt": "Place the alarm clock from image 1 next to the vase on the dining table in image 2",
+    "images": [
+        "https://img.alicdn.com/imgextra/i3/O1CN0157XGE51l6iL9441yX_!!6000000004770-49-tps-1104-1472.webp",
+        "https://img.alicdn.com/imgextra/i3/O1CN01SfG4J41UYn9WNt4X1_!!6000000002530-49-tps-1696-960.webp"
+    ]
+}
+
      +

      For input and output parameters, see Wan2.7 - image generation and editing, Wan2.6 - image generation and editing, Wanxiang – General Image Editing 2.5

      +
      +
      + +
      +
      +
      + +
      +
      +
      +
      +
      +
      +
      +
      +
      + + + + + + + \ No newline at end of file diff --git a/pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_wan-image-generation-and-editing-api-reference b/pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_wan-image-generation-and-editing-api-reference new file mode 100644 index 0000000000000000000000000000000000000000..5355c9e01245f0241c75a481adccfb7185b1e544 --- /dev/null +++ b/pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_wan-image-generation-and-editing-api-reference @@ -0,0 +1,2048 @@ + + + + + + + + + + + + + + + + + + + + + + + + Wan-Image Generation and Editing 2.7 API Reference - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center + + + + + + + + + + + + + + + + + + + + +
      +
      + + + +
      +
      +
      + +
      +
      +
      +
      All Products
      +
      +
      + + + +
      +
      +
      +
      +
      +
      +Search +
      +
      +
      + +
      + +
      +
      +
      + +
      +

      +This Product + +

      + + +
      + +
        + +
        +

        +Alibaba Cloud Model Studio:Wan2.7 - image generation and editing + +

        +
        +
        +
        +
        + + +Document Center + +
        +
        +

        Alibaba Cloud Model Studio:Wan2.7 - image generation and editing

        +
        +Last Updated:Oct 11, 2026 +
        +
        +
        +
        +

        Wan2.7-Image supports text-to-image, text-to-image-set, image-to-image-set, image editing, and multi-image reference generation.

        Model overview

        +

        Model

        Description

        Output image specifications

        wan2.7-image-pro

        Wan 2.7 image Pro. Supports 4K output for text-to-image generation (not for image sets).

        Image format: PNG.

        For image resolution and dimensions, see the size parameter.

        wan2.7-image

        Wan 2.7 image. Faster generation.

        +

        NoteBefore you call a model, check Model list and prices for regional model availability.

        +

        Prerequisites

        +

        Obtain an API key and export the API key as an environment variable.

        +

        ImportantThe China (Beijing) and Singapore regions have separate API keys and request endpoints. They cannot be used interchangeably. Cross-region calls lead to authentication failures or service errors.

        +

        HTTP synchronous

        +

        Returns the result in a single request. Recommended for most use cases.

        +

        Singapore

        POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

        Replace {WorkspaceId} with your actual workspace ID.

        Beijing

        POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

        Replace {WorkspaceId} with your actual workspace ID.

        +

        Request parameters

        Text-to-image

        +

        The wan2.7-image-pro model supports 4K resolution for text-to-image generation only. Image editing and image set generation support up to 2K resolution.

        +
        curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"text": "A flower shop with exquisite windows, a beautiful wooden door, and flowers on display"}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "size": "2K",
+            "n": 1,
+            "watermark": false,
+            "thinking_mode": true
+        }
+    }'
+
+

        Image editing

        curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"image": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp"},
+                        {"image": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp"},
+                        {"text": "Spray-paint the graffiti from image 2 onto the car in image 1"}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "size": "2K",
+            "n": 1,
+            "watermark": false
+        }
+    }'
+
+

        Interactive editing

        curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"image": "https://img.alicdn.com/imgextra/i3/O1CN0157XGE51l6iL9441yX_!!6000000004770-49-tps-1104-1472.webp"},
+                        {"image": "https://img.alicdn.com/imgextra/i3/O1CN01SfG4J41UYn9WNt4X1_!!6000000002530-49-tps-1696-960.webp"},
+                        {"text": "Place the alarm clock from image 1 into the bounding box of image 2, and blend the scene and lighting naturally."}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "bbox_list": [[],[[989, 515, 1138, 681]]],
+            "size": "2K",
+            "n": 1,
+            "watermark": false
+        }
+    }'
+
+

        Image set generation

        curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"text": "A cinematic group of images documenting the same stray ginger cat. The features must be consistent throughout. First image: In spring, the ginger cat weaves through blooming cherry blossom trees. Second image: In summer, the ginger cat cools off in the shade on an old street. Third image: In autumn, the ginger cat steps on a ground covered with golden fallen leaves. Fourth image: In winter, the ginger cat walks on the snow, leaving footprints."}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "enable_sequential": true,
+            "n": 4,
+            "size": "2K"
+        }
+    }'
+
+
        Headers

        Content-Type string (Required)

        The content type of the request. Must be application/json.

        Authorization string (Required)

        Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.

        Request body

        model string (Required)

        The model name. Valid values: wan2.7-image-pro, wan2.7-image.

        input object (Required)

        The input object.

        Properties

        messages array (Required)

        An array of request content. Only single-turn conversations are supported.

        Properties

        role string (Required)

        The message role. Must be user.

        content array (Required)

        An array of message content.

        Properties

        text string

        The text prompt. Supports Chinese and English. Maximum 5,000 characters. Each character, letter, number, or symbol counts as one. Excess characters are truncated.

        image string

        The URL or Base64-encoded string of the input image.

        Image limits:

          +
        • Image format: JPEG, JPG, PNG (alpha channels are not supported), BMP, WEBP.
          • +
        • Image resolution: The width and height must be between 240 and 8,000 pixels. The aspect ratio must be between 1:8 and 8:1.
          • +
        • File size: No more than 20 MB.
          • +

        Image number limits:

          +
        • You can input 0 to 9 images.
          • +
        • When you input multiple images, you must pass multiple image objects in the content array. The order of the objects in the array determines the order of the images.
          • +

        Supported input formats:

          +
        1. +

          Use a publicly accessible URL

          +
            +
          • Supports HTTP or HTTPS protocols.
            • +
          • Example: http://wanx.alicdn.com/material/xxx.jpeg.
            • +
          +
          2. +
        2. +

          Pass a Base64-encoded image string

          +
            +
          • Format: data:{MIME_type};base64,{base64_data}
            • +
          • Example: data:image/jpeg;base64,GDU7MtCZzEbTbmRZ... (This is for illustration only. You must pass the complete string.)
            • +
          • For more information, see Image input methods.
            • +
          +
          3. +

        parameters object (Optional)

        Model parameter settings.

        Properties

        bbox_list List[List[List[int]]] (Optional)

        The bounding box area for interactive editing.

          +
        • The length of the list must match the number of input images. If an image does not require editing, pass an empty list [] in the corresponding position.
          • +
        • Coordinate format: [x1, y1, x2, y2] (top-left x, top-left y, bottom-right x, bottom-right y). Use absolute pixel coordinates of the original image. The top-left coordinate is (0, 0).
          • +
        • A single image supports a maximum of two bounding boxes.
          • +

        Example: Input 3 images, where the second image has no bounding box and the first image has two bounding boxes:

        [
+  [[0, 0, 12, 12], [25, 25, 100, 100]],  # Image 1 (2 boxes)
+  [],                                    # Image 2 (no box)
+  [[10, 10, 50, 50]]                     # Image 3 (1 box)
+]
+

        enable_sequential boolean (Optional)

        Controls the image generation mode:

          +
        • false (default): The default output mode.
          • +
        • true: The image set output mode.
          • +

        size string (Optional)

        The output image resolution. Supports two mutually exclusive methods:

        Model: wan2.7-image-pro
          +
        • +Method 1: Specify the output image resolution (Recommended) +
            +
          • +

            Supports 1K, 2K (default), and 4K specifications.

            +
            • +
          • +

            Scope of application:

            +
              +
            • Text-to-image (no image input, not for image set generation): Supports 1K, 2K, and 4K.
              • +
            • Other scenarios: Supports 1K and 2K.
              • +
            +
            • +
          • +

            Total pixels for each specification: 1K: 1024×1024, 2K: 2048×2048, 4K: 4096×4096

            +
            • +
          • +

            Image aspect ratio:

            +
              +
            • When an image is input: The output aspect ratio matches the input image (the last one if multiple images are input) and is scaled to the selected resolution.
              • +
            • When no image is input: The output is a square image.
              • +
            +
            • +
          +
          • +
        • +Method 2: Specify the width and height in pixels for the generated image +
            +
          • Text-to-image: Total pixels are between 768×768 and 4096×4096. The aspect ratio is between 1:8 and 8:1.
            • +
          • Other scenarios: Total pixels are between 768×768 and 2048×2048. The aspect ratio is between 1:8 and 8:1.
            • +
          +
          • +
        Model: wan2.7-image
          +
        • +Method 1: Specify the output image resolution (Recommended) +
            +
          • Supports 1K and 2K (default) specifications. 4K is not supported.
            • +
          +
          • +
        • +Method 2: Specify the width and height in pixels for the generated image +
            +
          • In all scenarios, the total pixels are between 768×768 and 2048×2048. The aspect ratio is between 1:8 and 8:1.
            • +
          +
          • +
        +

        The pixel values of the output image may have minor differences from the specified values.

        +

        n int (Optional)

        ImportantThe n parameter directly affects cost: unit price × number of successfully generated images. Confirm the model pricing before calling.

          +
        • When image set mode is disabled, this value represents the number of images to generate. The range is 1 to 4. Defaults to 1.
          • +
        • When image set mode is enabled, this value represents the maximum number of images to generate. The range is 1 to 12. Defaults to 12. The actual number is determined by the model and will not exceed n.
          • +

        thinking_mode boolean (Optional)

        Enables thinking mode. Defaults to true. This parameter is effective only when image set mode is disabled and no image is input. When enabled, the model enhances its inference capabilities to improve output quality, but this increases generation time.

        color_palette array (Optional)

        A custom color theme. An array of objects, each with a hexadecimal color and a ratio. Must include 3 to 10 colors. 8 colors recommended.

        This is available only when image set mode is disabled (enable_sequential=false).

        Properties

        hex string (Required)

        The color value in hexadecimal (HEX) format.

        ratio string (Required)

        The percentage of the color. Must be accurate to two decimal places (such as "25.00%"). The sum of all ratio values must be 100.00%.

        Click to view an input example

        "color_palette": [
+    {
+        "hex": "#C2D1E6",
+        "ratio": "23.51%"
+    },
+    {
+        "hex": "#CDD8E9",
+        "ratio": "20.13%"
+    },
+    {
+        "hex": "#B5C8DB",
+        "ratio": "15.88%"
+    },
+    {
+        "hex": "#C0B5B4",
+        "ratio": "13.27%"
+    },
+    {
+        "hex": "#DAE0EC",
+        "ratio": "10.11%"
+    },
+    {
+        "hex": "#636574",
+        "ratio": "8.93%"
+    },
+    {
+        "hex": "#CACAD2",
+        "ratio": "5.55%"
+    },
+    {
+        "hex": "#CBD4E4",
+        "ratio": "2.62%"
+    }
+]
+

        watermark bool (Optional)

        Adds a watermark label in the bottom-right corner of the image with fixed text "AI Generated".

          +
        • false (default)
          • +
        • true
          • +

        seed integer (optional)

        Random number seed. Valid range: [0,2147483647].

        Using the same seed yields similar outputs. If omitted, the algorithm uses a random seed.

        Note: Image generation is probabilistic. Even with the same seed, results may vary.

        +

        Response parameters

        Successful task execution

        Task data (task status and image URLs) is retained for only 24 hours and then automatically purged. Save generated images promptly.

        {
+    "output": {
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "content": [
+                        {
+                            "image": "https://dashscope-xxx.oss-xxx.aliyuncs.com/xxx.png?Expires=xxx",
+                            "type": "image"
+                        }
+                    ],
+                    "role": "assistant"
+                }
+            }
+        ],
+        "finished": true
+    },
+    "usage": {
+        "image_count": 1,
+        "input_tokens": 10867,
+        "output_tokens": 2,
+        "size": "1488*704",
+        "total_tokens": 10869
+    },
+    "request_id": "71dfc3c6-f796-9972-97e4-bc4efc4faxxx"
+}
+

        Abnormal task execution

        If a task fails, the code and message fields in the response indicate the error cause. See Error codes.

        {
+    "request_id": "a4d78a5f-655f-9639-8437-xxxxxx",
+    "code": "InvalidParameter",
+    "message": "num_images_per_prompt must be 1"
+}
+

        output object

        Task output information.

        Properties

        choices array

        The output content generated by the model.

        Properties

        finish_reason string

        The reason the task stopped. stop indicates natural completion.

        message object

        The message returned by the model.

        Properties

        role string

        The message role. Always assistant.

        content array

        Properties

        type string

        Value: image.

        image string

        The URL of the generated image. Format: PNG.

        The link is valid for 24 hours. Download the image promptly.

        finished boolean

        Indicates whether the task is finished. Default: false.

        usage object

        Usage statistics for the request. Only successful results are counted.

        Properties

        image_count integer

        The number of generated images.

        size string

        The resolution of the generated image. Example: 1376*768.

        input_tokens integer

        The number of input tokens (not billed). Billing is based on the number of images.

        output_tokens integer

        The number of output tokens (not billed). Billing is based on the number of images.

        total_tokens integer

        The total number of tokens (not billed). Billing is based on the number of images.

        request_id string

        Unique request identifier for tracing and troubleshooting.

        code string

        Error code. Returned only for failed requests. See Error codes.

        message string

        Detailed error message. Returned only for failed requests. See Error codes.

        +

        HTTP asynchronous

        +

        Best for long-running tasks. Submit a task, then poll for status and results.

        +

        Step 1: Create a task to get the task ID

        +

        Singapore

        POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation

        Replace {WorkspaceId} with your actual workspace ID.

        Beijing

        POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation

        Replace {WorkspaceId} with your actual workspace ID.

        +

        Request parameters

        Text-to-image

        +

        The wan2.7-image-pro model supports 4K resolution for text-to-image generation only. Image editing and image set generation support up to 2K resolution.

        +
        curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --header "X-DashScope-Async: enable" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"text": "A flower shop with exquisite windows, a beautiful wooden door, and flowers on display"}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "size": "2K",
+            "n": 1,
+            "watermark": false,
+            "thinking_mode": true
+        }
+    }'
+
+

        Image editing

        curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --header "X-DashScope-Async: enable" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"image": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp"},
+                        {"image": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp"},
+                        {"text": "Spray-paint the graffiti from image 2 onto the car in image 1"}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "size": "2K",
+            "n": 1,
+            "watermark": false
+        }
+    }'
+
+

        Interactive editing

        curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --header "X-DashScope-Async: enable" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"image": "https://img.alicdn.com/imgextra/i3/O1CN0157XGE51l6iL9441yX_!!6000000004770-49-tps-1104-1472.webp"},
+                        {"image": "https://img.alicdn.com/imgextra/i3/O1CN01SfG4J41UYn9WNt4X1_!!6000000002530-49-tps-1696-960.webp"},
+                        {"text": "Place the alarm clock from image 1 into the selected area of image 2, and blend the scene and lighting naturally."}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "bbox_list": [[],[[989, 515, 1138, 681]]],
+            "size": "2K",
+            "n": 1,
+            "watermark": false
+        }
+    }'
+
+

        Image set generation

        +

        The wan2.7-image-pro model supports up to 2K resolution for image set generation.

        +
        curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation' \
+    --header 'Content-Type: application/json' \
+    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
+    --header "X-DashScope-Async: enable" \
+    --data '{
+        "model": "wan2.7-image-pro",
+        "input": {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": [
+                        {"text": "A cinematic photo set featuring the same stray orange cat, whose features must remain consistent across all images. First image: In spring, the cat weaves through blooming cherry blossom trees. Second image: In summer, the cat cools off in the shade on an old street. Third image: In autumn, the cat steps on a ground covered in golden fallen leaves. Fourth image: In winter, the cat walks on the snow, leaving footprints."}
+                    ]
+                }
+            ]
+        },
+        "parameters": {
+            "enable_sequential": true,
+            "n": 4,
+            "size": "2K"
+        }
+    }'
+
+
        Headers

        Content-Type string (Required)

        The content type of the request. Must be application/json.

        Authorization string (Required)

        Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.

        X-DashScope-Async string (Required)

        Enables asynchronous processing. HTTP requests support only asynchronous calls. Must be enable.

        ImportantIf this request header is missing, the error "current user api does not support synchronous calls" is returned.

        Request body

        model string (Required)

        The model name. Valid values: wan2.7-image-pro, wan2.7-image.

        input object (Required)

        The input object.

        Properties

        messages array (Required)

        An array of request content. Only single-turn conversations are supported.

        Properties

        role string (Required)

        The message role. Must be user.

        content array (Required)

        An array of message content.

        Properties

        text string

        The text prompt. Supports Chinese and English. Maximum 5,000 characters. Each character, letter, number, or symbol counts as one. Excess characters are truncated.

        image string

        The URL or Base64-encoded string of the input image.

        Image limits:

          +
        • Image format: JPEG, JPG, PNG (alpha channels are not supported), BMP, WEBP.
          • +
        • Image resolution: The width and height must be between 240 and 8,000 pixels. The aspect ratio must be between 1:8 and 8:1.
          • +
        • File size: No more than 20 MB.
          • +

        Image number limits:

          +
        • You can input 0 to 9 images.
          • +
        • When you input multiple images, you must pass multiple image objects in the content array. The order of the objects in the array determines the order of the images.
          • +

        Supported input formats:

          +
        1. +

          Use a publicly accessible URL

          +
            +
          • Supports HTTP or HTTPS protocols.
            • +
          • Example: http://wanx.alicdn.com/material/xxx.jpeg.
            • +
          +
          2. +
        2. +

          Pass a Base64-encoded image string

          +
            +
          • Format: data:{MIME_type};base64,{base64_data}
            • +
          • Example: data:image/jpeg;base64,GDU7MtCZzEbTbmRZ... (This is for illustration only. You must pass the complete string.)
            • +
          • For more information, see Image input methods.
            • +
          +
          3. +

        parameters object (Optional)

        Model parameter settings.

        Properties

        bbox_list List[List[List[int]]] (Optional)

        The bounding box area for interactive editing.

          +
        • The length of the list must match the number of input images. If an image does not require editing, pass an empty list [] in the corresponding position.
          • +
        • Coordinate format: [x1, y1, x2, y2] (top-left x, top-left y, bottom-right x, bottom-right y). Use absolute pixel coordinates of the original image. The top-left coordinate is (0, 0).
          • +
        • A single image supports a maximum of two bounding boxes.
          • +

        Example: Input 3 images, where the second image has no bounding box and the first image has two bounding boxes:

        [
+  [[0, 0, 12, 12], [25, 25, 100, 100]],  # Image 1 (2 boxes)
+  [],                                    # Image 2 (no box)
+  [[10, 10, 50, 50]]                     # Image 3 (1 box)
+]
+

        enable_sequential boolean (Optional)

        Controls the image generation mode:

          +
        • false (default): The default output mode.
          • +
        • true: The image set output mode.
          • +

        size string (Optional)

        The output image resolution. Supports two mutually exclusive methods:

        Model: wan2.7-image-pro
          +
        • +Method 1: Specify the output image resolution (Recommended) +
            +
          • +

            Supports 1K, 2K (default), and 4K specifications.

            +
            • +
          • +

            Scope of application:

            +
              +
            • Text-to-image (no image input, not for image set generation): Supports 1K, 2K, and 4K.
              • +
            • Other scenarios: Supports 1K and 2K.
              • +
            +
            • +
          • +

            Total pixels for each specification: 1K: 1024×1024, 2K: 2048×2048, 4K: 4096×4096

            +
            • +
          • +

            Image aspect ratio:

            +
              +
            • When an image is input: The output aspect ratio matches the input image (the last one if multiple images are input) and is scaled to the selected resolution.
              • +
            • When no image is input: The output is a square image.
              • +
            +
            • +
          +
          • +
        • +Method 2: Specify the width and height in pixels for the generated image +
            +
          • Text-to-image: Total pixels are between 768×768 and 4096×4096. The aspect ratio is between 1:8 and 8:1.
            • +
          • Other scenarios: Total pixels are between 768×768 and 2048×2048. The aspect ratio is between 1:8 and 8:1.
            • +
          +
          • +
        Model: wan2.7-image
          +
        • +Method 1: Specify the output image resolution (Recommended) +
            +
          • Supports 1K and 2K (default) specifications. 4K is not supported.
            • +
          +
          • +
        • +Method 2: Specify the width and height in pixels for the generated image +
            +
          • In all scenarios, the total pixels are between 768×768 and 2048×2048. The aspect ratio is between 1:8 and 8:1.
            • +
          +
          • +
        +

        The pixel values of the output image may have minor differences from the specified values.

        +

        n int (Optional)

        ImportantThe n parameter directly affects cost: unit price × number of successfully generated images. Confirm the model pricing before calling.

          +
        • When image set mode is disabled, this value represents the number of images to generate. The range is 1 to 4. Defaults to 1.
          • +
        • When image set mode is enabled, this value represents the maximum number of images to generate. The range is 1 to 12. Defaults to 12. The actual number is determined by the model and will not exceed n.
          • +

        thinking_mode boolean (Optional)

        Enables thinking mode. Defaults to true. This parameter is effective only when image set mode is disabled and no image is input. When enabled, the model enhances its inference capabilities to improve output quality, but this increases generation time.

        color_palette array (Optional)

        A custom color theme. An array of objects, each with a hexadecimal color and a ratio. Must include 3 to 10 colors. 8 colors recommended.

        This is available only when image set mode is disabled (enable_sequential=false).

        Properties

        hex string (Required)

        The color value in hexadecimal (HEX) format.

        ratio string (Required)

        The percentage of the color. Must be accurate to two decimal places (such as "25.00%"). The sum of all ratio values must be 100.00%.

        Click to view an input example

        "color_palette": [
+    {
+        "hex": "#C2D1E6",
+        "ratio": "23.51%"
+    },
+    {
+        "hex": "#CDD8E9",
+        "ratio": "20.13%"
+    },
+    {
+        "hex": "#B5C8DB",
+        "ratio": "15.88%"
+    },
+    {
+        "hex": "#C0B5B4",
+        "ratio": "13.27%"
+    },
+    {
+        "hex": "#DAE0EC",
+        "ratio": "10.11%"
+    },
+    {
+        "hex": "#636574",
+        "ratio": "8.93%"
+    },
+    {
+        "hex": "#CACAD2",
+        "ratio": "5.55%"
+    },
+    {
+        "hex": "#CBD4E4",
+        "ratio": "2.62%"
+    }
+]
+

        watermark bool (Optional)

        Adds a watermark label in the bottom-right corner of the image with fixed text "AI Generated".

          +
        • false (default)
          • +
        • true
          • +

        seed integer (optional)

        Random number seed. Valid range: [0,2147483647].

        Using the same seed yields similar outputs. If omitted, the algorithm uses a random seed.

        Note: Image generation is probabilistic. Even with the same seed, results may vary.

        +

        Response parameters

        Successful response

        Save the task_id to query the task status and result.

        {
+    "output": {
+        "task_status": "PENDING",
+        "task_id": "0385dc79-5ff8-4d82-bcb6-xxxxxx"
+    },
+    "request_id": "4909100c-7b5a-9f92-bfe5-xxxxxx"
+}
+

        Error response

        Task creation failed. See Error codes.

        {
+    "code": "InvalidApiKey",
+    "message": "Invalid API-key provided.",
+    "request_id": "7438d53d-6eb8-4596-8835-xxxxxx"
+}
+

        output object

        Task output information.

        Properties

        task_id string

        The task ID. Valid for queries for 24 hours.

        task_status string

        The status of the task.

        Enumeration values

          +
        • PENDING
          • +
        • RUNNING
          • +
        • SUCCEEDED
          • +
        • FAILED
          • +
        • CANCELED
          • +
        • UNKNOWN: The task does not exist or its status is unknown.
          • +

        request_id string

        Unique request identifier for tracing and troubleshooting.

        code string

        Error code. Returned only for failed requests. See Error codes.

        message string

        Detailed error message. Returned only for failed requests. See Error codes.

        +

        Step 2: Query the result by task ID

        +

        Singapore

        GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id}

        Beijing

        GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/tasks/{task_id}

        +

        Request parameters

        Query task result

        Replace {task_id} with the task_id value returned by the previous API call. The task_id is valid for queries for 24 hours, Replace {WorkspaceId} with your actual workspace ID.

        curl -X GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id} \
+--header "Authorization: Bearer $DASHSCOPE_API_KEY"
+
        Headers

        Authorization string (Required)

        Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.

        Path parameters

        task_id string (Required)

        The ID of the task.

        +

        Response parameters

        Successful task execution

        Task data (task status and image URLs) is retained for only 24 hours and then automatically purged. Save generated images promptly.

        {
+    "request_id": "810fa5f5-334c-91f3-aaa4-ed89cf0caxxx",
+    "output": {
+        "task_id": "a81ee7cb-014c-473d-b842-76e98311cxxx",
+        "task_status": "SUCCEEDED",
+        "submit_time": "2026-03-26 17:16:01.663",
+        "scheduled_time": "2026-03-26 17:16:01.716",
+        "end_time": "2026-03-26 17:16:22.961",
+        "finished": true,
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-xxx.oss-xxx.aliyuncs.com/xxx.png?Expires=xxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ]
+    },
+    "usage": {
+        "size": "2976*1408",
+        "total_tokens": 11017,
+        "image_count": 1,
+        "output_tokens": 2,
+        "input_tokens": 11015
+    }
+}
+

        Abnormal task execution

        If a task fails, the code and message fields in the response indicate the error cause. See Error codes.

        {
+    "request_id": "a4d78a5f-655f-9639-8437-xxxxxx",
+    "code": "InvalidParameter",
+    "message": "num_images_per_prompt must be 1"
+}
+

        output object

        Task output information.

        Properties

        task_id string

        The task ID. Valid for queries for 24 hours.

        task_status string

        The status of the task.

        Enumeration values

          +
        • PENDING
          • +
        • RUNNING
          • +
        • SUCCEEDED
          • +
        • FAILED
          • +
        • CANCELED
          • +
        • UNKNOWN: The task does not exist or its status is unknown.
          • +
        State transitions during polling:
          +
        • PENDING → RUNNING → SUCCEEDED or FAILED.
          • +
        • The initial query status is usually PENDING or RUNNING.
          • +
        • When the status changes to SUCCEEDED, the response contains the generated image URL.
          • +
        • If the status is FAILED, check the error message and retry the task.
          • +

        submit_time string

        The time when the task was submitted. The time is in UTC+8 and the format is YYYY-MM-DD HH:mm:ss.SSS.

        scheduled_time string

        The time when the task was executed. The time is in UTC+8 and the format is YYYY-MM-DD HH:mm:ss.SSS.

        end_time string

        The time when the task was completed. The time is in UTC+8 and the format is YYYY-MM-DD HH:mm:ss.SSS.

        finished boolean

        Indicates whether the task is finished. Default: false.

        choices array

        The output content generated by the model.

        Properties

        finish_reason string

        The reason the task stopped. stop indicates natural completion.

        message object

        The message returned by the model.

        Properties

        role string

        The message role. Always assistant.

        content array

        Properties

        type string

        Values: text, image.

        text string

        The generated text.

        image string

        The URL of the generated image. Format: PNG.

        The link is valid for 24 hours. Download the image promptly.

        usage object

        Usage statistics for the request. Only successful results are counted.

        Properties

        image_count integer

        The number of generated images.

        size string

        The resolution of the generated image. Example: 1376*768.

        input_tokens integer

        The number of input tokens (not billed). Billing is based on the number of images.

        output_tokens integer

        The number of output tokens (not billed). Billing is based on the number of images.

        total_tokens integer

        The total number of tokens (not billed). Billing is based on the number of images.

        request_id string

        Unique request identifier for tracing and troubleshooting.

        code string

        Error code. Returned only for failed requests. See Error codes.

        message string

        Detailed error message. Returned only for failed requests. See Error codes.

        +

        Python SDK

        +

        SDK parameter names are largely consistent with the HTTP API.

        +

        Image generation tasks can take time, so the SDK wraps the HTTP asynchronous workflow. Both synchronous and asynchronous calls are supported.

        +
        +

        Task duration depends on queue length and service status.

        +
        +

        ImportantMake sure your DashScope Python SDK version is 1.25.15 or later. To update, see Install SDK.

        +

        Both base_url and API key are region-specific. The following example uses the Singapore region:

        +

        Singapore

        https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1

        When calling, replace {WorkspaceId} with your actual workspace ID.

        China (Beijing)

        https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1

        When calling, replace {WorkspaceId} with your actual workspace ID.

        +

        Image editing

        +

        Synchronous call

        Request example 
        import os
+import base64
+import mimetypes
+import urllib.request
+import dashscope
+from dashscope.aigc.image_generation import ImageGeneration
+from dashscope.api_entities.dashscope_response import Message
+
+# The following base_url is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+dashscope.base_http_api_url = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1"
+
+# If you have not configured environment variables, replace the following line with your Model Studio API key: api_key="sk-xxx"
+# The API key varies by region. To obtain an API key, visit: https://www.alibabacloud.com/help/model-studio/get-api-key
+api_key = os.getenv("DASHSCOPE_API_KEY")
+
+# --- Base64 encoding function ---
+# The Base64 encoding format is data:{MIME_type};base64,{base64_data}
+def encode_file(file_path):
+    mime_type, _ = mimetypes.guess_type(file_path)
+    if not mime_type or not mime_type.startswith("image/"):
+        raise ValueError("Unsupported or unrecognized image format")
+    with open(file_path, "rb") as image_file:
+        encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
+    return f"data:{mime_type};base64,{encoded_string}"
+
+"""
+Image input methods:
+The following are three methods for image input. You need to choose only one.
+1. Use a public URL: This method is suitable for publicly accessible images.
+2. Use a local file: This method is suitable for local development and testing.
+3. Use Base64 encoding: This method is suitable for private images or scenarios that require encrypted transmission.
+"""
+# [Method 1] Use a public image URL
+image_1 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp"
+image_2 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp"
+
+# [Method 2] Use a local file (supports absolute and relative paths)
+# image_1 = "file:///path/to/your/car.png"
+# image_2 = "file:///path/to/your/paint.png"
+
+# [Method 3] Use a Base64-encoded image
+# image_1 = encode_file("/path/to/your/car.png")
+# image_2 = encode_file("/path/to/your/paint.png")
+
+message = Message(
+    role="user",
+    content=[
+        {"text": "Spray the graffiti from image 2 onto the car in image 1"},
+        {"image": image_1},
+        {"image": image_2},
+    ],
+)
+print("----sync call, please wait a moment----")
+rsp = ImageGeneration.call(
+    model="wan2.7-image-pro",
+    api_key=api_key,
+    messages=[message],
+    watermark=False,
+    n=1,
+    size="2K",  # wan2.7-image-pro supports 4K resolution only for text-to-image generation. Image editing and multi-image generation support up to 2K resolution.
+)
+
+# Extract the result image URL and save the image to a local file.
+if rsp.status_code == 200:
+    for i, choice in enumerate(rsp.output.choices):
+        for j, content in enumerate(choice["message"]["content"]):
+            if content.get("type") == "image":
+                image_url = content["image"]
+                file_name = f"output_{i}_{j}.png"
+                # The result URL is valid for 24 hours. Please download it promptly.
+                urllib.request.urlretrieve(image_url, file_name)
+                print(f"Image saved to {file_name}")
+else:
+    print(f"Failed: status_code={rsp.status_code}, message={rsp.message}")
+
        Response example
        +

        The URL is valid for 24 hours. Download the image promptly.

        +
        {
+    "status_code": 200,
+    "request_id": "81d868c6-6ce1-92d8-a90d-d2ee71xxxxxx",
+    "code": "",
+    "message": "",
+    "output": {
+        "text": null,
+        "finish_reason": null,
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "audio": null,
+        "finished": true
+    },
+    "usage": {
+        "input_tokens": 18790,
+        "output_tokens": 2,
+        "characters": 0,
+        "image_count": 1,
+        "size": "2985*1405",
+        "total_tokens": 18792
+    }
+}
+

        Asynchronous call

        Request example 
        import os
+import base64
+import mimetypes
+import urllib.request
+import dashscope
+from dashscope.aigc.image_generation import ImageGeneration
+from dashscope.api_entities.dashscope_response import Message
+from http import HTTPStatus
+
+# The following base_url is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+dashscope.base_http_api_url = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1"
+
+# If you have not configured environment variables, replace the following line with your Model Studio API key: api_key="sk-xxx"
+# The API key varies by region. To obtain an API key, visit https://www.alibabacloud.com/help/model-studio/get-api-key
+api_key = os.getenv("DASHSCOPE_API_KEY")
+
+# --- Base64 encoding function ---
+# The Base64 encoding format is data:{MIME_type};base64,{base64_data}
+def encode_file(file_path):
+    mime_type, _ = mimetypes.guess_type(file_path)
+    if not mime_type or not mime_type.startswith("image/"):
+        raise ValueError("Unsupported or unrecognized image format.")
+    with open(file_path, "rb") as image_file:
+        encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
+    return f"data:{mime_type};base64,{encoded_string}"
+
+"""
+Image input methods:
+Three image input methods are provided below. Choose one.
+1. Use a public URL - suitable for publicly accessible images.
+2. Use a local file - suitable for local development and testing.
+3. Use Base64 encoding - suitable for private images or scenarios that require encrypted transmission.
+"""
+# [Method 1] Use a public image URL
+image_1 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp"
+image_2 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp"
+
+# [Method 2] Use a local file (supports absolute and relative paths)
+# image_1 = "file:///path/to/your/car.png"
+# image_2 = "file:///path/to/your/paint.png"
+
+# [Method 3] Use a Base64-encoded image
+# image_1 = encode_file("/path/to/your/car.png")
+# image_2 = encode_file("/path/to/your/paint.png")
+
+# Create an asynchronous task.
+def create_async_task():
+    print("Creating async task...")
+    message = Message(
+        role="user",
+        content=[
+            {"text": "Spray the graffiti from image 2 onto the car in image 1."},
+            {"image": image_1},
+            {"image": image_2},
+        ],
+    )
+    response = ImageGeneration.async_call(
+        model="wan2.7-image-pro",
+        api_key=api_key,
+        messages=[message],
+        watermark=False,
+        n=1,
+        size="2K",  # wan2.7-image-pro supports 4K resolution only for text-to-image generation scenarios. Image editing and collage generation support a maximum resolution of 2K.
+    )
+
+    if response.status_code == 200:
+        print("Task created successfully:", response)
+        return response
+    else:
+        raise Exception(f"Failed to create task: {response.code} - {response.message}")
+
+# Wait for the task to complete.
+def wait_for_completion(task_response):
+    print("Waiting for task completion...")
+    status = ImageGeneration.wait(task=task_response, api_key=api_key)
+
+    if status.output.task_status == "SUCCEEDED":
+        print("Task succeeded!")
+        # Extract the result image URL and save the image to a local file.
+        for i, choice in enumerate(status.output.choices):
+            for j, content in enumerate(choice["message"]["content"]):
+                if content.get("type") == "image":
+                    image_url = content["image"]
+                    file_name = f"output_{i}_{j}.png"
+                    # The result URL is valid for 24 hours. Download the image in a timely manner.
+                    urllib.request.urlretrieve(image_url, file_name)
+                    print(f"Image saved to {file_name}")
+    else:
+        raise Exception(f"Task failed with status: {status.output.task_status}")
+
+# Obtain information about the asynchronous task.
+def fetch_task_status(task):
+    print("Fetching task status...")
+    status = ImageGeneration.fetch(task=task, api_key=api_key)
+
+    if status.status_code == HTTPStatus.OK:
+        print("Task status:", status.output.task_status)
+        print("Response details:", status)
+    else:
+        print(f"Failed to fetch status: {status.code} - {status.message}")
+
+# Cancel the asynchronous task.
+def cancel_task(task):
+    print("Canceling task...")
+    response = ImageGeneration.cancel(task=task, api_key=api_key)
+
+    if response.status_code == HTTPStatus.OK:
+        print("Task canceled successfully:", response.output.task_status)
+    else:
+        print(f"Failed to cancel task: {response.code} - {response.message}")
+
+# Main execution flow.
+if __name__ == "__main__":
+    task = create_async_task()
+    wait_for_completion(task)
+
        Response example
          +
        1. Response example for creating a task
          2. +
        {
+    "status_code": 200,
+    "request_id": "4fb3050f-de57-4a24-84ff-e37ee5xxxxxx",
+    "code": "",
+    "message": "",
+    "output": {
+        "text": null,
+        "finish_reason": null,
+        "choices": null,
+        "audio": null,
+        "task_id": "127ec645-118f-4884-955d-0eba8dxxxxxx",
+        "task_status": "PENDING"
+    },
+    "usage": {
+        "input_tokens": 0,
+        "output_tokens": 0,
+        "characters": 0
+    }
+}
+
          +
        1. +

          Response example for querying a task result

          +
          +

          The URL is valid for 24 hours. Download the image promptly.

          +
          +
          2. +
        {
+    "status_code": 200,
+    "request_id": "3b99aae5-d26f-9059-8dd0-ee9ca4804xxx",
+    "code": null,
+    "message": "",
+    "output": {
+        "text": null,
+        "finish_reason": null,
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "audio": null,
+        "task_id": "127ec645-118f-4884-955d-0eba8dxxxxxx",
+        "task_status": "SUCCEEDED",
+        "submit_time": "2026-03-31 22:58:47.646",
+        "scheduled_time": "2026-03-31 22:58:47.683",
+        "end_time": "2026-03-31 22:58:59.642",
+        "finished": true
+    },
+    "usage": {
+        "input_tokens": 18711,
+        "output_tokens": 2,
+        "characters": 0,
+        "size": "2985*1405",
+        "total_tokens": 18713,
+        "image_count": 1
+    }
+}
+
        +

        Image set generation

        +

        Synchronous call

        Request example 
        import os
+import base64
+import mimetypes
+import urllib.request
+import dashscope
+from dashscope.aigc.image_generation import ImageGeneration
+from dashscope.api_entities.dashscope_response import Message
+
+# The following base_url is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+dashscope.base_http_api_url = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1"
+
+# If you have not configured the environment variable, replace the following line with your Model Studio API key: api_key="sk-xxx"
+# The API key varies by region. To obtain an API key, visit: https://www.alibabacloud.com/help/model-studio/get-api-key
+api_key = os.getenv("DASHSCOPE_API_KEY")
+
+# --- Base64 encoding function ---
+# The Base64 encoding format is data:{MIME_type};base64,{base64_data}
+def encode_file(file_path):
+    mime_type, _ = mimetypes.guess_type(file_path)
+    if not mime_type or not mime_type.startswith("image/"):
+        raise ValueError("Unsupported or unrecognized image format")
+    with open(file_path, "rb") as image_file:
+        encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
+    return f"data:{mime_type};base64,{encoded_string}"
+
+"""
+Description of image input methods (for image-to-image sequence generation):
+Choose one of the following three image input methods:
+1. Use a public URL - Suitable for publicly accessible images.
+2. Use a local file - Suitable for local development and testing.
+3. Use Base64 encoding - Suitable for private images or scenarios that require encrypted transmission.
+"""
+# [Method 1] Use a public image URL
+# image_1 = "https://img.alicdn.com/imgextra/i4/O1CN01IM44WN23dq5uY1yla_!!6000000007279-49-tps-1024-1024.webp"
+
+# [Method 2] Use a local file (supports both absolute and relative paths)
+# image_1 = "file:///path/to/your/image.png"
+
+# [Method 3] Use a Base64-encoded image
+# image_1 = encode_file("/path/to/your/image.png")
+
+message = Message(
+    role="user",
+    content=[
+        {
+            "text": "A cinematic image sequence featuring the same stray orange cat, whose features must be consistent across all images. First image: In spring, the orange cat weaves through blooming cherry blossom trees. Second image: In summer, the orange cat cools off in the shade of a tree on an old street. Third image: In autumn, the orange cat walks on a carpet of golden fallen leaves. Fourth image: In winter, the orange cat leaves footprints as it walks on the snow."
+        }
+        # For image-to-image sequence generation: Uncomment the following lines and comment out the plain text above.
+        # {"text": "Generate a four-seasons image sequence based on the style of the reference image"},
+        # {"image": image_1}
+    ],
+)
+
+print("----sync call, please wait a moment----")
+rsp = ImageGeneration.call(
+    model="wan2.7-image-pro",
+    api_key=api_key,
+    messages=[message],
+    enable_sequential=True,
+    n=4,
+    size="2K",  # wan2.7-image-pro supports 4K resolution only in text-to-image scenarios. Image editing and image sequence generation support a maximum resolution of 2K.
+)
+
+# Extract the resulting image URLs and save the images locally.
+if rsp.status_code == 200:
+    for i, choice in enumerate(rsp.output.choices):
+        for j, content in enumerate(choice["message"]["content"]):
+            if content.get("type") == "image":
+                image_url = content["image"]
+                file_name = f"output_{i}_{j}.png"
+                # The result URL is valid for 24 hours. Download the image promptly.
+                urllib.request.urlretrieve(image_url, file_name)
+                print(f"Image saved to {file_name}")
+else:
+    print(f"Failed: status_code={rsp.status_code}, message={rsp.message}")
+
        Response example
        +

        The URL is valid for 24 hours. Download the image promptly.

        +
        {
+    "status_code": 200,
+    "request_id": "56e318fd-ed60-99e8-8ca1-cdef25ca4xxx",
+    "code": "",
+    "message": "",
+    "output": {
+        "text": null,
+        "finish_reason": null,
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "audio": null,
+        "finished": true
+    },
+    "usage": {
+        "input_tokens": 720,
+        "output_tokens": 11,
+        "characters": 0,
+        "image_count": 4,
+        "size": "2048*2048",
+        "total_tokens": 731
+    }
+}
+

        Asynchronous call

        Request example 
        import os
+import base64
+import mimetypes
+import urllib.request
+import dashscope
+from dashscope.aigc.image_generation import ImageGeneration
+from dashscope.api_entities.dashscope_response import Message
+
+# The following base_url is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+dashscope.base_http_api_url = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1"
+
+# If you have not configured the DASHSCOPE_API_KEY environment variable, replace the following line with your Model Studio API key: api_key="sk-xxx"
+# The API key varies by region. To obtain an API key, visit: https://www.alibabacloud.com/help/model-studio/get-api-key
+api_key = os.getenv("DASHSCOPE_API_KEY")
+
+# --- Base64 encoding function ---
+# The Base64 data URI scheme is data:{MIME_type};base64,{base64_data}
+def encode_file(file_path):
+    mime_type, _ = mimetypes.guess_type(file_path)
+    if not mime_type or not mime_type.startswith("image/"):
+        raise ValueError("Unsupported or unrecognized image format")
+    with open(file_path, "rb") as image_file:
+        encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
+    return f"data:{mime_type};base64,{encoded_string}"
+
+"""
+Description of image input methods (for image-to-image sequence generation):
+The following three image input methods are provided. Choose one of them.
+1. Use a public URL: Suitable for images that are publicly accessible.
+2. Use a local file: Suitable for local development and testing.
+3. Use Base64 encoding: Suitable for private images or scenarios that require encrypted transmission.
+"""
+# [Method 1] Use a public image URL
+# image_1 = "https://img.alicdn.com/imgextra/i4/O1CN01IM44WN23dq5uY1yla_!!6000000007279-49-tps-1024-1024.webp"
+
+# [Method 2] Use a local file (absolute and relative paths are supported)
+# image_1 = "file:///path/to/your/image.png"
+
+# [Method 3] Use a Base64-encoded image
+# image_1 = encode_file("/path/to/your/image.png")
+
+def main():
+    message = Message(
+        role="user",
+        content=[
+            {
+                "text": "A cinematic sequence of images documenting the same stray orange cat, whose features must remain consistent across all images. Image 1: In spring, the cat weaves through blooming cherry blossom trees. Image 2: In summer, the cat cools off in the shade of trees on an old street. Image 3: In autumn, the cat steps on a carpet of golden fallen leaves. Image 4: In winter, the cat walks on the snow, leaving footprints."
+            }
+            # Image-to-image sequence generation scenario: Uncomment the following lines and comment out the plain text above.
+            # {"text": "Generate a sequence of four seasonal images based on the style of the reference image."},
+            # {"image": image_1}
+        ],
+    )
+
+    # Submit an asynchronous task
+    print("Submitting an asynchronous task...")
+    response = ImageGeneration.async_call(
+        model="wan2.7-image-pro",
+        api_key=api_key,
+        messages=[message],
+        enable_sequential=True,
+        n=4,
+        size="2K",  # wan2.7-image-pro supports 4K resolution only in text-to-image scenarios. Image editing and image sequence generation support a maximum resolution of 2K.
+    )
+
+    if response.status_code == 200:
+        print(f"Task submitted successfully. Task ID: {response.output.task_id}")
+
+        # Wait for the task to complete
+        status = ImageGeneration.wait(task=response, api_key=api_key)
+
+        if status.output.task_status == "SUCCEEDED":
+            print("Task completed!")
+            # Extract the result image URLs and save them to a local device.
+            for i, choice in enumerate(status.output.choices):
+                for j, content in enumerate(choice["message"]["content"]):
+                    if content.get("type") == "image":
+                        image_url = content["image"]
+                        file_name = f"output_{i}_{j}.png"
+                        # The result URLs are valid for 24 hours. Download the images in a timely manner.
+                        urllib.request.urlretrieve(image_url, file_name)
+                        print(f"Image saved to {file_name}")
+        else:
+            print(f"Task failed. Status: {status.output.task_status}")
+    else:
+        print(f"Failed to create the task: {response.code} - {response.message}")
+
+if __name__ == "__main__":
+    try:
+        main()
+    except Exception as e:
+        print(f"Error: {e}")
+
        Response example
          +
        1. Response example for creating a task
          2. +
        {
+    "status_code": 200,
+    "request_id": "4fb3050f-de57-4a24-84ff-e37ee5xxxxxx",
+    "code": "",
+    "message": "",
+    "output": {
+        "text": null,
+        "finish_reason": null,
+        "choices": null,
+        "audio": null,
+        "task_id": "77093787-a217-4c29-9cd4-ca7b5ac86xxx",
+        "task_status": "PENDING"
+    },
+    "usage": {
+        "input_tokens": 0,
+        "output_tokens": 0,
+        "characters": 0
+    }
+}
+
          +
        1. +

          Response example for querying a task result

          +
          +

          The URL is valid for 24 hours. Download the image promptly.

          +
          +
          2. +
        {
+    "status_code": 200,
+    "request_id": "56e318fd-ed60-99e8-8ca1-cdef25ca4xxx",
+    "code": "",
+    "message": "",
+    "output": {
+        "text": null,
+        "finish_reason": null,
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "audio": null,
+        "task_id": "77093787-a217-4c29-9cd4-ca7b5ac86xxx",
+        "task_status": "SUCCEEDED",
+        "submit_time": "2026-03-31 23:04:46.166",
+        "scheduled_time": "2026-03-31 23:04:46.208",
+        "end_time": "2026-03-31 23:05:11.664",
+        "finished": true
+    },
+    "usage": {
+        "input_tokens": 720,
+        "output_tokens": 11,
+        "characters": 0,
+        "size": "2048*2048",
+        "total_tokens": 731,
+        "image_count": 4
+    }
+}
+
        +

        Java SDK

        +

        SDK parameter names are largely consistent with the HTTP API.

        +

        Image generation tasks can take time, so the SDK wraps the HTTP asynchronous workflow. Both synchronous and asynchronous calls are supported.

        +

        ImportantMake sure your DashScope Java SDK version is 2.22.13 or later.

        +

        Singapore

        https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1

        When calling, replace {WorkspaceId} with your actual workspace ID.

        China (Beijing)

        https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1

        When calling, replace {WorkspaceId} with your actual workspace ID.

        +

        Image editing

        +

        Synchronous call

        Request example 
        import com.alibaba.dashscope.aigc.imagegeneration.*;
+import com.alibaba.dashscope.exception.ApiException;
+import com.alibaba.dashscope.exception.NoApiKeyException;
+import com.alibaba.dashscope.exception.UploadFileException;
+import com.alibaba.dashscope.utils.Constants;
+import com.alibaba.dashscope.utils.JsonUtils;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * wan2.7-image-pro Image Editing - Synchronous Call Example
+ */
+public class Main {
+
+    static {
+        // The following URL is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+        Constants.baseHttpApiUrl = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1";
+    }
+
+    // If you have not configured an environment variable, replace the following line with your Model Studio API key: apiKey="sk-xxx"
+    // The API key varies by region. To obtain an API key, visit https://www.alibabacloud.com/help/model-studio/get-api-key
+    static String apiKey = System.getenv("DASHSCOPE_API_KEY");
+
+    // --- Base64 encoding function ---
+    // Base64 encoding format: data:{MIME_type};base64,{base64_data}
+    public static String encodeFile(String filePath) throws IOException {
+        byte[] fileContent = Files.readAllBytes(Paths.get(filePath));
+        String base64String = Base64.getEncoder().encodeToString(fileContent);
+        String mimeType = Files.probeContentType(Paths.get(filePath));
+        return "data:" + mimeType + ";base64," + base64String;
+    }
+
+    public static void basicCall() throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        /*
+         * Description of image input methods:
+         * Three image input methods are provided below. Select one.
+         * 1. Use a public URL: Suitable for publicly accessible images.
+         * 2. Use a local file: Suitable for local development and testing.
+         * 3. Use Base64 encoding: Suitable for private images or scenarios that require encrypted transmission.
+         */
+        // Method 1: Use a public image URL.
+        String image1 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp";
+        String image2 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp";
+
+        // Method 2: Use a local file. Both absolute and relative paths are supported.
+        // Format: file:// + file path
+        // String image1 = "file:///path/to/your/car.png";
+        // String image2 = "file:///path/to/your/paint.png";
+
+        // Method 3: Use a Base64-encoded image.
+        // String image1 = encodeFile("/path/to/your/car.png");
+        // String image2 = encodeFile("/path/to/your/paint.png");
+
+        // Build a multi-image input message.
+        ImageGenerationMessage message = ImageGenerationMessage.builder()
+                .role("user")
+                .content(Arrays.asList(
+                        // Multi-image input is supported. You can provide multiple reference images.
+                        Collections.singletonMap("text", "Spray the graffiti from image 2 onto the car in image 1"),
+                        Collections.singletonMap("image", image1),
+                        Collections.singletonMap("image", image2)
+                )).build();
+
+        ImageGenerationParam param = ImageGenerationParam.builder()
+                .apiKey(apiKey)
+                .model("wan2.7-image-pro")
+                .messages(Collections.singletonList(message))
+                .n(1)
+                .size("2K") // For wan2.7-image-pro, only the text-to-image generation scenario supports 4K resolution. Image editing and collage generation support a maximum resolution of 2K.
+                .build();
+
+        ImageGeneration imageGeneration = new ImageGeneration();
+        ImageGenerationResult result = null;
+        try {
+            System.out.println("---sync call for image editing, please wait a moment----");
+            result = imageGeneration.call(param);
+        } catch (ApiException | NoApiKeyException | UploadFileException e) {
+            throw new RuntimeException(e.getMessage());
+        }
+        // Extract the result image URL and save it to a local file.
+        for (int i = 0; i < result.getOutput().getChoices().size(); i++) {
+            List<Map<String, Object>> contents = result.getOutput().getChoices().get(i)
+                    .getMessage().getContent();
+            for (int j = 0; j < contents.size(); j++) {
+                if ("image".equals(contents.get(j).get("type"))) {
+                    String imageUrl = (String) contents.get(j).get("image");
+                    String fileName = "output_" + i + "_" + j + ".png";
+                    // The result URL is valid for 24 hours. Download the image in a timely manner.
+                    try (InputStream in = new URL(imageUrl).openStream()) {
+                        Files.copy(in, Paths.get(fileName), StandardCopyOption.REPLACE_EXISTING);
+                    }
+                    System.out.println("Image saved to " + fileName);
+                }
+            }
+        }
+    }
+
+    public static void main(String[] args) throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        basicCall();
+    }
+}
+
        Response example
        +

        The URL is valid for 24 hours. Save it promptly.

        +
        {
+    "requestId": "1bf6173a-e8de-9f75-94d3-5e618f875xxx",
+    "usage": {
+        "input_tokens": 18790,
+        "output_tokens": 2,
+        "total_tokens": 18792,
+        "image_count": 1,
+        "size": "2985*1405"
+    },
+    "output": {
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "finished": true
+    },
+    "status_code": 200,
+    "code": "",
+    "message": ""
+}
+

        Asynchronous call

        Request example 
        import com.alibaba.dashscope.aigc.imagegeneration.*;
+import com.alibaba.dashscope.exception.ApiException;
+import com.alibaba.dashscope.exception.NoApiKeyException;
+import com.alibaba.dashscope.exception.UploadFileException;
+import com.alibaba.dashscope.utils.Constants;
+import com.alibaba.dashscope.utils.JsonUtils;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * wan2.7-image-pro Image Editing - Asynchronous Invocation Example
+ */
+public class Main {
+
+    static {
+        // The following URL is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+        Constants.baseHttpApiUrl = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1";
+    }
+
+    // If you have not configured an environment variable, replace the following line with your Model Studio API key: apiKey="sk-xxx"
+    // The API key varies by region. To obtain an API key, visit: https://www.alibabacloud.com/help/model-studio/get-api-key
+    static String apiKey = System.getenv("DASHSCOPE_API_KEY");
+
+    // --- Base64 encoding function ---
+    // The Base64 encoding format is data:{MIME_type};base64,{base64_data}
+    public static String encodeFile(String filePath) throws IOException {
+        byte[] fileContent = Files.readAllBytes(Paths.get(filePath));
+        String base64String = Base64.getEncoder().encodeToString(fileContent);
+        String mimeType = Files.probeContentType(Paths.get(filePath));
+        return "data:" + mimeType + ";base64," + base64String;
+    }
+
+    public static void asyncCall() throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        /*
+         * Description of image input methods:
+         * The following three image input methods are provided. You can choose one of them.
+         * 1. Use a public URL - Suitable for publicly accessible images.
+         * 2. Use a local file - Suitable for local development and testing.
+         * 3. Use Base64 encoding - Suitable for scenarios that involve private images or require encrypted transmission.
+         */
+        // [Method 1] Use a public image URL
+        String image1 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/pjeqdf/car.webp";
+        String image2 = "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20251229/xsunlm/paint.webp";
+
+        // [Method 2] Use a local file (supports absolute and relative paths)
+        // Required format: file:// + file path
+        // String image1 = "file:///path/to/your/car.png";
+        // String image2 = "file:///path/to/your/paint.png";
+
+        // [Method 3] Use a Base64-encoded image
+        // String image1 = encodeFile("/path/to/your/car.png");
+        // String image2 = encodeFile("/path/to/your/paint.png");
+
+        // Build a multi-image input message
+        ImageGenerationMessage message = ImageGenerationMessage.builder()
+                .role("user")
+                .content(Arrays.asList(
+                        // Supports multi-image input. You can provide multiple reference images.
+                        Collections.singletonMap("text", "Spray-paint the graffiti from image 2 onto the car in image 1"),
+                        Collections.singletonMap("image", image1),
+                        Collections.singletonMap("image", image2)
+                )).build();
+
+        ImageGenerationParam param = ImageGenerationParam.builder()
+                .apiKey(apiKey)
+                .model("wan2.7-image-pro")
+                .n(1)
+                .size("2K") // The wan2.7-image-pro model supports 4K resolution only for text-to-image generation. For image editing and composite image generation, the maximum supported resolution is 2K.
+                .messages(Arrays.asList(message))
+                .build();
+
+        ImageGeneration imageGeneration = new ImageGeneration();
+        ImageGenerationResult result = null;
+        try {
+            System.out.println("---async call for image editing, creating task----");
+            result = imageGeneration.asyncCall(param);
+        } catch (ApiException | NoApiKeyException | UploadFileException e) {
+            throw new RuntimeException(e.getMessage());
+        }
+        System.out.println("Task creation result:");
+        System.out.println(JsonUtils.toJson(result));
+
+        String taskId = result.getOutput().getTaskId();
+        // Wait for the task to complete
+        waitTask(taskId);
+    }
+
+    public static void waitTask(String taskId) throws ApiException, NoApiKeyException, IOException {
+        ImageGeneration imageGeneration = new ImageGeneration();
+        System.out.println("\n---waiting for task completion----");
+        ImageGenerationResult result = imageGeneration.wait(taskId, apiKey);
+        // Fetch the resulting image URL and save it to a local file
+        for (int i = 0; i < result.getOutput().getChoices().size(); i++) {
+            List<Map<String, Object>> contents = result.getOutput().getChoices().get(i)
+                    .getMessage().getContent();
+            for (int j = 0; j < contents.size(); j++) {
+                if ("image".equals(contents.get(j).get("type"))) {
+                    String imageUrl = (String) contents.get(j).get("image");
+                    String fileName = "output_" + i + "_" + j + ".png";
+                    // The result URL is valid for 24 hours. Download the image in a timely manner.
+                    try (InputStream in = new URL(imageUrl).openStream()) {
+                        Files.copy(in, Paths.get(fileName), StandardCopyOption.REPLACE_EXISTING);
+                    }
+                    System.out.println("Image saved to " + fileName);
+                }
+            }
+        }
+    }
+
+    public static void main(String[] args) throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        asyncCall();
+    }
+}
+
        Response example
          +
        1. Response example for creating a task
          2. +
        {
+    "requestId": "ccf4b2f4-bf30-9e13-9461-3a28c6a7bxxx",
+    "output": {
+        "task_id": "8811b4a4-00ac-4aa2-a2fd-017d3b90cxxx",
+        "task_status": "PENDING"
+    },
+    "status_code": 200,
+    "code": "",
+    "message": ""
+}
+
          +
        1. +

          Response example for querying a task result

          +
          +

          The URL is valid for 24 hours. Save it promptly.

          +
          +
          2. +
        {
+    "requestId": "60a08540-f1c1-9e76-8cd3-d5949db8cxxx",
+    "usage": {
+        "input_tokens": 18711,
+        "output_tokens": 2,
+        "total_tokens": 18713,
+        "image_count": 1,
+        "size": "2985*1405"
+    },
+    "output": {
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "task_id": "8811b4a4-00ac-4aa2-a2fd-017d3b90cxxx",
+        "task_status": "SUCCEEDED",
+        "finished": true,
+        "submit_time": "2026-03-31 19:57:58.840",
+        "scheduled_time": "2026-03-31 19:57:58.877",
+        "end_time": "2026-03-31 19:58:11.563"
+    },
+    "status_code": 200,
+    "code": "",
+    "message": ""
+}
+
        +

        Image set generation

        +

        Synchronous call

        Request example 
        import com.alibaba.dashscope.aigc.imagegeneration.*;
+import com.alibaba.dashscope.exception.ApiException;
+import com.alibaba.dashscope.exception.NoApiKeyException;
+import com.alibaba.dashscope.exception.UploadFileException;
+import com.alibaba.dashscope.utils.Constants;
+import com.alibaba.dashscope.utils.JsonUtils;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * An example of using wan2.7-image-pro for image series generation through synchronous calls in the Singapore region.
+ */
+public class Main {
+
+    static {
+        // The following URL is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+        Constants.baseHttpApiUrl = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1";
+    }
+
+    // If you have not configured the environment variable, replace the following line with your Model Studio API key: apiKey="sk-xxx"
+    // API keys vary by region. To obtain an API key, visit: https://www.alibabacloud.com/help/model-studio/get-api-key
+    static String apiKey = System.getenv("DASHSCOPE_API_KEY");
+
+    // --- Base64 encoding function ---
+    // The format for Base64 encoding is data:{MIME_type};base64,{base64_data}
+    public static String encodeFile(String filePath) throws IOException {
+        byte[] fileContent = Files.readAllBytes(Paths.get(filePath));
+        String base64String = Base64.getEncoder().encodeToString(fileContent);
+        String mimeType = Files.probeContentType(Paths.get(filePath));
+        return "data:" + mimeType + ";base64," + base64String;
+    }
+
+    public static void basicCall() throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        /*
+         * Image input methods (for image-to-image series generation):
+         * Three image input methods are provided below. Choose one.
+         * 1. Public URL: Suitable for images that are already publicly accessible.
+         * 2. Local file: Suitable for local development and testing.
+         * 3. Base64 encoding: Suitable for private images or scenarios that require encrypted transmission.
+         */
+        // Method 1: Use a public image URL
+        // String image1 = "https://img.alicdn.com/imgextra/i4/O1CN01IM44WN23dq5uY1yla_!!6000000007279-49-tps-1024-1024.webp";
+
+        // Method 2: Use a local file (supports both absolute and relative paths)
+        // Format: file:// + file path
+        // String image1 = "file:///path/to/your/image.png";
+
+        // Method 3: Use a Base64-encoded image
+        // String image1 = encodeFile("/path/to/your/image.png");
+
+        // Build the text input message. This supports both text-to-image and image-to-image series generation. This example demonstrates text-to-image series generation.
+        ImageGenerationMessage message = ImageGenerationMessage.builder()
+                .role("user")
+                .content(Collections.singletonList(
+                        Collections.singletonMap("text", "A cinematic image series documenting the same stray orange cat, whose features must remain consistent. First image: In spring, the cat weaves through blooming cherry blossom trees. Second image: In summer, the cat cools off in the shade on an old street. Third image: In autumn, the cat walks on a carpet of golden fallen leaves. Fourth image: In winter, the cat leaves footprints in the snow.")
+                )).build();
+        // For image-to-image series generation, uncomment the following code and comment out the plain text message builder above.
+        // ImageGenerationMessage message = ImageGenerationMessage.builder()
+        //         .role("user")
+        //         .content(Arrays.asList(
+        //                 Collections.singletonMap("text", "Generate a four-season image series based on the style of the reference image."),
+        //                 Collections.singletonMap("image", image1)
+        //         )).build();
+
+        ImageGenerationParam param = ImageGenerationParam.builder()
+                .apiKey(apiKey)
+                .model("wan2.7-image-pro")
+                .messages(Collections.singletonList(message))
+                .enableSequential(true)
+                .n(4)
+                .size("2K") // The wan2.7-image-pro model supports 4K resolution only for text-to-image generation. Image editing and image series generation support a maximum resolution of 2K.
+                .build();
+
+        ImageGeneration imageGeneration = new ImageGeneration();
+        ImageGenerationResult result = null;
+        try {
+            System.out.println("----sync call, please wait a moment----");
+            result = imageGeneration.call(param);
+        } catch (ApiException | NoApiKeyException | UploadFileException e) {
+            throw new RuntimeException(e.getMessage());
+        }
+        // Extract the resulting image URLs and save them to a local directory.
+        for (int i = 0; i < result.getOutput().getChoices().size(); i++) {
+            List<Map<String, Object>> contents = result.getOutput().getChoices().get(i)
+                    .getMessage().getContent();
+            for (int j = 0; j < contents.size(); j++) {
+                if ("image".equals(contents.get(j).get("type"))) {
+                    String imageUrl = (String) contents.get(j).get("image");
+                    String fileName = "output_" + i + "_" + j + ".png";
+                    // The resulting URL is valid for 24 hours. Be sure to download it promptly.
+                    try (InputStream in = new URL(imageUrl).openStream()) {
+                        Files.copy(in, Paths.get(fileName), StandardCopyOption.REPLACE_EXISTING);
+                    }
+                    System.out.println("Image saved to " + fileName);
+                }
+            }
+        }
+    }
+
+    public static void main(String[] args) throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        basicCall();
+    }
+}
+
        Response example
        +

        The URL is valid for 24 hours. Save it promptly.

        +
        {
+    "requestId": "4678c314-b37a-91c9-a2ae-2d3cd54bbxxx",
+    "usage": {
+        "input_tokens": 720,
+        "output_tokens": 11,
+        "total_tokens": 731,
+        "image_count": 4,
+        "size": "2048*2048"
+    },
+    "output": {
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "finished": true
+    },
+    "status_code": 200,
+    "code": "",
+    "message": ""
+}
+

        Asynchronous call

        Request example 
        import com.alibaba.dashscope.aigc.imagegeneration.*;
+import com.alibaba.dashscope.exception.ApiException;
+import com.alibaba.dashscope.exception.NoApiKeyException;
+import com.alibaba.dashscope.exception.UploadFileException;
+import com.alibaba.dashscope.utils.Constants;
+import com.alibaba.dashscope.utils.JsonUtils;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * wan2.7-image-pro Image Set Generation - Asynchronous Invocation Example (Singapore Region)
+ */
+public class Main {
+
+    static {
+        // The following URL is for the Singapore region. Replace {WorkspaceId} with your Bailian workspace ID. The base_url varies by region.
+        Constants.baseHttpApiUrl = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1";
+    }
+
+    // If you have not configured environment variables, replace the following line with your Model Studio API key: apiKey="sk-xxx"
+    // The API key varies by region. To obtain an API key, visit https://www.alibabacloud.com/help/model-studio/get-api-key
+    static String apiKey = System.getenv("DASHSCOPE_API_KEY");
+
+    // --- Base64 encoding function ---
+    // The Base64 encoding format is data:{MIME_type};base64,{base64_data}
+    public static String encodeFile(String filePath) throws IOException {
+        byte[] fileContent = Files.readAllBytes(Paths.get(filePath));
+        String base64String = Base64.getEncoder().encodeToString(fileContent);
+        String mimeType = Files.probeContentType(Paths.get(filePath));
+        return "data:" + mimeType + ";base64," + base64String;
+    }
+
+    public static ImageGenerationResult waitTask(String taskId)
+            throws ApiException, NoApiKeyException {
+        ImageGeneration imageGeneration = new ImageGeneration();
+        return imageGeneration.wait(taskId, apiKey);
+    }
+
+    public static void asyncCall() throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        /*
+         * Description of image input methods (for image-to-image set generation scenarios):
+         * The following three image input methods are provided. You can choose one of them.
+         * 1. Use a public URL - suitable for publicly accessible images.
+         * 2. Use a local file - suitable for local development and testing.
+         * 3. Use Base64 encoding - suitable for private images or scenarios that require encrypted transmission.
+         */
+        // [Method 1] Use a public image URL
+        // String image1 = "https://img.alicdn.com/imgextra/i4/O1CN01IM44WN23dq5uY1yla_!!6000000007279-49-tps-1024-1024.webp";
+
+        // [Method 2] Use a local file (supports absolute and relative paths)
+        // Format: file:// + file path
+        // String image1 = "file:///path/to/your/image.png";
+
+        // [Method 3] Use a Base64-encoded image
+        // String image1 = encodeFile("/path/to/your/image.png");
+
+        // Build the text input message (supports text-to-image set and image-to-image set generation. This example uses text-to-image set generation.)
+        ImageGenerationMessage message = ImageGenerationMessage.builder()
+                .role("user")
+                .content(Collections.singletonList(
+                        Collections.singletonMap("text", "A cinematic image set documenting the same stray orange cat. Its features must be consistent across all images. Image 1: In spring, the orange cat weaves through blooming cherry blossom trees. Image 2: In summer, the orange cat cools off in the shade of a tree on an old street. Image 3: In autumn, the orange cat steps on a carpet of golden fallen leaves. Image 4: In winter, the orange cat leaves footprints as it walks on the snow.")
+                )).build();
+        // For image-to-image set generation scenarios: uncomment the following code and comment out the plain text construction above.
+        // ImageGenerationMessage message = ImageGenerationMessage.builder()
+        //         .role("user")
+        //         .content(Arrays.asList(
+        //                 Collections.singletonMap("text", "Generate an image set of the four seasons based on the style of the reference image."),
+        //                 Collections.singletonMap("image", image1)
+        //         )).build();
+
+        ImageGenerationParam param = ImageGenerationParam.builder()
+                .apiKey(apiKey)
+                .model("wan2.7-image-pro")
+                .messages(Collections.singletonList(message))
+                .enableSequential(true)
+                .n(4)
+                .size("2K") // The wan2.7-image-pro model supports 4K resolution only for text-to-image generation. Image editing and image set generation support a maximum resolution of 2K.
+                .build();
+
+        ImageGeneration imageGeneration = new ImageGeneration();
+        ImageGenerationResult taskResult = null;
+        try {
+            System.out.println("----async call, creating task----");
+            taskResult = imageGeneration.asyncCall(param);
+        } catch (ApiException | NoApiKeyException | UploadFileException e) {
+            throw new RuntimeException(e.getMessage());
+        }
+        System.out.println("Task created: " + JsonUtils.toJson(taskResult));
+
+        // Wait for the task to complete.
+        String taskId = taskResult.getOutput().getTaskId();
+        ImageGenerationResult result = waitTask(taskId);
+        // Fetch the resulting image URLs and save them to a local directory.
+        for (int i = 0; i < result.getOutput().getChoices().size(); i++) {
+            List<Map<String, Object>> contents = result.getOutput().getChoices().get(i)
+                    .getMessage().getContent();
+            for (int j = 0; j < contents.size(); j++) {
+                if ("image".equals(contents.get(j).get("type"))) {
+                    String imageUrl = (String) contents.get(j).get("image");
+                    String fileName = "output_" + i + "_" + j + ".png";
+                    // The result URL is valid for 24 hours. Download the image in a timely manner.
+                    try (InputStream in = new URL(imageUrl).openStream()) {
+                        Files.copy(in, Paths.get(fileName), StandardCopyOption.REPLACE_EXISTING);
+                    }
+                    System.out.println("Image saved to " + fileName);
+                }
+            }
+        }
+    }
+
+    public static void main(String[] args) throws ApiException, NoApiKeyException, UploadFileException, IOException {
+        asyncCall();
+    }
+}
+
        Response example
          +
        1. Response example for creating a task
          2. +
        {
+    "requestId": "7d026dc1-e8c9-9caa-84ac-e82e2da97xxx",
+    "output": {
+        "task_id": "2de18c56-c151-4b80-8105-1d164733exxx",
+        "task_status": "PENDING"
+    },
+    "status_code": 200,
+    "code": "",
+    "message": ""
+}
+
          +
        1. +

          Response example for querying a task result

          +
          +

          The URL is valid for 24 hours. Save it promptly.

          +
          +
          2. +
        {
+    "requestId": "daea7295-4ce0-928a-9a11-4d2bea058xxx",
+    "usage": {
+        "input_tokens": 720,
+        "output_tokens": 11,
+        "total_tokens": 731,
+        "image_count": 4,
+        "size": "2048*2048"
+    },
+    "output": {
+        "choices": [
+            {
+                "finish_reason": "stop",
+                "message": {
+                    "role": "assistant",
+                    "content": [
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        },
+                        {
+                            "image": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxxxxx.png?Expires=xxxxxx",
+                            "type": "image"
+                        }
+                    ]
+                }
+            }
+        ],
+        "task_id": "2de18c56-c151-4b80-8105-1d164733exxx",
+        "task_status": "SUCCEEDED",
+        "finished": true,
+        "submit_time": "2026-03-31 19:49:53.124",
+        "scheduled_time": "2026-03-31 19:49:53.175",
+        "end_time": "2026-03-31 19:50:53.160"
+    },
+    "status_code": 200,
+    "code": "",
+    "message": ""
+}
+
        +

        Billing and rate limiting

        +
          +
        • For the model's free quota and unit price, see Model pricing.
          • +
        • For model rate limiting, see Wanxiang.
          • +
        • Billing details: You are billed based on the number of images successfully generated. Failed calls and processing errors do not incur charges or consume your free quota for new users.
          • +
        +

        Error codes

        +

        If the model call fails and returns an error message, see Error codes for resolution.

        +
        +
        + +
        +
        +
        + +
        +
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + \ No newline at end of file diff --git a/pipeline/provider_docs/bfl__api.bfl.ai_openapi.json b/pipeline/provider_docs/bfl__api.bfl.ai_openapi.json new file mode 100644 index 0000000000000000000000000000000000000000..b9710702ec15366055577b5ee81929370fd1877d --- /dev/null +++ b/pipeline/provider_docs/bfl__api.bfl.ai_openapi.json @@ -0,0 +1 @@ +{"openapi":"3.1.0","info":{"title":"BFL API","description":"Authorize with an API key from your user profile.","version":"0.0.1"},"servers":[{"url":"https://api.bfl.ai","description":"BFL API"}],"paths":{"/v1/finetune_details":{"get":{"tags":["Utility"],"summary":"Finetune Details","description":"Get details about the training parameters and other metadata connected to a specific finetune_id that was created by the user.","operationId":"finetune_details_v1_finetune_details_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"finetune_id","in":"query","required":true,"schema":{"type":"string","title":"Finetune Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinetuneDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"servers":[{"url":"https://api.bfl.ai","description":"BFL Finetune API"}]}},"/v1/my_finetunes":{"get":{"tags":["Utility"],"summary":"My Finetunes","description":"List all finetune_ids created by the user","operationId":"my_finetunes_v1_my_finetunes_get","security":[{"APIKeyHeader":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyFinetunesResponse"}}}}},"servers":[{"url":"https://api.bfl.ai","description":"BFL Finetune API"}]}},"/v1/delete_finetune":{"post":{"tags":["Utility"],"summary":"Delete Finetune","description":"Delete a finetune_id that was created by the user","operationId":"delete_finetune_v1_delete_finetune_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFinetuneInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFinetuneResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"servers":[{"url":"https://api.bfl.ai","description":"BFL Finetune API"}]}},"/v1/flux-pro-1.1":{"post":{"tags":["Models"],"summary":"Generate an image with FLUX1.1 [pro]","description":"Submits an image generation task with FLUX1.1 [pro].","operationId":"flux_pro_1_1_v1_flux_pro_1_1_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FluxPro11Inputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Flux Pro 1 1 V1 Flux Pro 1 1 Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX1.1 [pro]"}}}},"/v1/flux-dev":{"post":{"tags":["Models"],"summary":"Generate an image with FLUX.1 [dev]","description":"Submits an image generation task with FLUX.1 [dev].","operationId":"flux_dev_v1_flux_dev_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FluxDevInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Flux Dev V1 Flux Dev Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.1 [dev]"}}}},"/v1/flux-pro-1.1-ultra":{"post":{"tags":["Models"],"summary":"Generate an image with FLUX1.1 [pro] ultra mode","description":"Submits an image generation task with FLUX1.1 [pro] with ultra mode and optional raw mode.","operationId":"generate_flux_1_1_ultra_v1_flux_pro_1_1_ultra_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FluxUltraInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux 1 1 Ultra V1 Flux Pro 1 1 Ultra Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX1.1 [pro] ultra"}}}},"/v1/flux-pro-1.0-fill":{"post":{"tags":["Models"],"summary":"Inpaint an image with FLUX.1 Fill [pro] using an input image and mask","description":"Submits an image generation task with the FLUX.1 Fill [pro] model using an input image and mask. Mask can be applied to alpha channel or submitted as a separate image.","operationId":"fill_v1_flux_pro_1_0_fill_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FluxProFillInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Fill V1 Flux Pro 1 0 Fill Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.1 Fill [pro]"}}}},"/v1/flux-pro-1.0-expand":{"post":{"tags":["Models"],"summary":"Expand an image with FLUX.1 Expand [pro] by adding pixels on any side","description":"Submits an image expansion task that adds the specified number of pixels to any combination of sides (top, bottom, left, right) while maintaining context.","operationId":"expand_v1_flux_pro_1_0_expand_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FluxProExpandInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Expand V1 Flux Pro 1 0 Expand Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.1 Expand [pro]"}}}},"/v1/flux-pro-1.1-ultra-finetuned":{"post":{"tags":["Models"],"summary":"Generate an image with FLUX 1.1 [pro] finetune with ultra mode.","description":"Submits an image generation task with FLUX 1.1 [pro] finetune with ultra mode.","operationId":"generate_bigblue_finetuned_v1_flux_pro_1_1_ultra_finetuned_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinetuneFluxUltraInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Bigblue Finetuned V1 Flux Pro 1 1 Ultra Finetuned Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"servers":[{"url":"https://api.bfl.ai","description":"BFL Finetune API"}]}},"/v1/flux-2-flex":{"post":{"tags":["Models"],"summary":"Generate or edit an image with FLUX.2 [flex]","description":"Submits an image generation or editing task with FLUX.2 [flex]. Specialized for typography and text rendering, and for preserving small details. Supports text-to-image and image-to-image editing workflows.","operationId":"generate_flux_2_flex_v1_flux_2_flex_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2FlexInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux 2 Flex V1 Flux 2 Flex Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.2 [flex]"},"content":"Best for text and typography in the image. For most use cases, start with FLUX.2 [pro]. See [which model to use](/flux_2/flux2_overview#which-model-to-choose)."}}},"/v1/flux-2-klein-9b":{"post":{"tags":["Models"],"summary":"Generate or edit an image with FLUX.2 [klein] 9B","description":"Submits an image generation or editing task with FLUX.2 [klein] 9B. Sub-second inference with open weights, balancing quality and speed.","operationId":"generate_flux_2_klein_9b_v1_flux_2_klein_9b_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2KleinInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux 2 Klein 9B V1 Flux 2 Klein 9B Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.2 [klein] 9B"},"content":"Fastest and most affordable, with open weights. 9B balances quality and speed; 4B is the fastest. See [which model to use](/flux_2/flux2_overview#which-model-to-choose)."}}},"/v1/flux-2-klein-9b-preview":{"post":{"tags":["Models"],"summary":"Generate or edit an image with FLUX.2 [klein] 9B (preview)","description":"Submits an image generation or editing task with the FLUX.2 [klein] 9B preview endpoint, where our latest quality and speed improvements land first. For stable production use, prefer FLUX.2 [klein] 9B (/flux-2-klein-9b).","operationId":"generate_flux_2_klein_9b_kv_v1_flux_2_klein_9b_preview_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2KleinInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux 2 Klein 9B Kv V1 Flux 2 Klein 9B Preview Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.2 [klein] 9B (preview)"},"content":"Preview endpoint for FLUX.2 [klein] 9B. For stable production use, start with FLUX.2 [klein] 9B. See [which model to use](/flux_2/flux2_overview#which-model-to-choose)."}}},"/v1/flux-2-klein-4b":{"post":{"tags":["Models"],"summary":"Generate or edit an image with FLUX.2 [klein] 4B","description":"Submits an image generation or editing task with FLUX.2 [klein] 4B. The fastest, most lightweight FLUX.2 model, with open weights that run on consumer GPUs.","operationId":"generate_flux_2_klein_4b_v1_flux_2_klein_4b_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2KleinInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux 2 Klein 4B V1 Flux 2 Klein 4B Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.2 [klein] 4B"},"content":"The fastest and most affordable model, with open weights that run on consumer GPUs. 9B trades some speed for higher quality. See [which model to use](/flux_2/flux2_overview#which-model-to-choose)."}}},"/v1/flux-2-max":{"post":{"tags":["Models"],"summary":"Generate or edit an image with FLUX.2 [max]","description":"Submits an image generation or editing task with FLUX.2 [max]. Highest quality FLUX.2 model for image generation and editing, with the strongest editing consistency and prompt following.","operationId":"generate_flux_2_max_v1_flux_2_max_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2Inputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux 2 Max V1 Flux 2 Max Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.2 [max]"},"content":"Highest quality, for the hardest edits and maximum prompt following. For most use cases, start with FLUX.2 [pro]. See [which model to use](/flux_2/flux2_overview#which-model-to-choose)."}}},"/v1/flux-2-pro-preview":{"post":{"tags":["Models"],"summary":"Generate or edit an image with FLUX.2 [pro] (preview)","description":"Submits an image generation or editing task with the FLUX.2 [pro] preview endpoint, where our latest quality and speed improvements land first. For stable production use, prefer FLUX.2 [pro] (/flux-2-pro).","operationId":"generate_flux_2_pro_preview_v1_flux_2_pro_preview_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2Inputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux 2 Pro Preview V1 Flux 2 Pro Preview Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.2 [pro] (preview)"},"content":"Preview endpoint for FLUX.2 [pro]. For stable production use, start with FLUX.2 [pro]. See [which model to use](/flux_2/flux2_overview#which-model-to-choose)."}}},"/v1/flux-2-pro":{"post":{"tags":["Models"],"summary":"Generate or edit an image with FLUX.2 [pro]","description":"Submits an image generation or editing task with FLUX.2 [pro]. This is the recommended default model for image editing and generation. Supports text-to-image and image-to-image editing workflows.","operationId":"generate_flux_2_pro_v1_flux_2_pro_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2Inputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux 2 Pro V1 Flux 2 Pro Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.2 [pro]"},"content":"The recommended default model for most generation and editing. New to FLUX.2? See [which model to use](/flux_2/flux2_overview#which-model-to-choose)."}}},"/v1/flux-3-video":{"post":{"tags":["Models"],"summary":"Generate a video with FLUX 3.","description":"Submits a video generation task to FLUX 3 via the harness. The mode is explicit: t2v (`text-to-video`), i2v (`image-continuation`, keyframes), v2v (`video-continuation`, start_video), or draft_enhance (`draft-enhance`, full-quality render of a prior draft's `draft_cache`); the spelled-out aliases are accepted anywhere the short key is.","operationId":"flux_3_video_v1_flux_3_video_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux3VideoInputsBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Flux 3 Video V1 Flux 3 Video Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/flux-3-image":{"post":{"tags":["Models"],"summary":"Generate an image with FLUX 3.","description":"Submits an image generation task with FLUX 3.","operationId":"flux_3_image_v1_flux_3_image_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux3ImageInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/flux-3-image-klein":{"post":{"tags":["Models"],"summary":"Generate an image with FLUX 3 Image Klein.","description":"Submits a text-to-image or image editing task with FLUX 3 Image Klein.","operationId":"flux_3_image_klein_v1_flux_3_image_klein_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux3ImageKleinInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/flux-tools/video-upscale-v1":{"post":{"tags":["Models"],"summary":"Upscale a video with FLUX 3.","description":"Submits a video upscaling task: 1.5x-3x super-resolution of the source clip (up to 2560x1440 in, 13.75 MP output frames). The upscale covers the first 20 seconds of the source; clips well past that are rejected. `creativity` selects precise source-faithful upscaling (0) or creative detail enhancement (1).","operationId":"generate_flux_tools_video_upscale_v1_v1_flux_tools_video_upscale_v1_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux3VideoUpscaleInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux Tools Video Upscale V1 V1 Flux Tools Video Upscale V1 Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"Video Upscale"},"content":"1.5x-3x video super-resolution. Creative mode enhances detail; precise mode stays faithful to the source."}}},"/v1/flux-tools/video-edit-v1":{"post":{"tags":["Models"],"summary":"Edit a video with FLUX 3.","description":"Submits a video edit task: the supplied clip is transformed according to the edit instruction. Duration, resolution, aspect ratio, and audio follow the source clip; inference controls are pinned server-side.","operationId":"generate_flux_tools_video_edit_v1_v1_flux_tools_video_edit_v1_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux3VideoVE2VNamedInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux Tools Video Edit V1 V1 Flux Tools Video Edit V1 Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/flux-tools/outpainting-v1":{"post":{"tags":["Models"],"summary":"Outpaint or extend an image","description":"Submits an outpainting task. The input image is placed on a (width, height) canvas at the given offset, and the surrounding region is generated by a FLUX outpainting model.","operationId":"generate_flux_tools_outpainting_v1_v1_flux_tools_outpainting_v1_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FluxOutpaintingInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux Tools Outpainting V1 V1 Flux Tools Outpainting V1 Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/flux-tools/vto-v1":{"post":{"tags":["Models"],"summary":"Virtual try-on","description":"Submits a virtual try-on task. Person and garment images are mapped to the underlying input image slots; prompts steer attribute transfer.","operationId":"generate_flux_tools_vto_v1_v1_flux_tools_vto_v1_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2KleinTryonInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux Tools Vto V1 V1 Flux Tools Vto V1 Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/flux-tools/vto-v2":{"post":{"tags":["Models"],"summary":"Virtual try-on (v2)","description":"Submits a virtual try-on task against the v2 model. Identical request shape to /vto-v1, with reference and output resolution supported up to 4MP. Person and garment images are mapped to the underlying input image slots. An edit instruction is generated from the person and garment images, with the supplied prompt used as a fallback.","operationId":"generate_flux_tools_vto_v2_v1_flux_tools_vto_v2_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2KleinTryonInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux Tools Vto V2 V1 Flux Tools Vto V2 Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/flux-tools/erase-v1":{"post":{"tags":["Models"],"summary":"Erase an object from an image","description":"Submits an erase task using an input image and a mask identifying the object or region to remove.","operationId":"generate_flux_tools_erase_v1_v1_flux_tools_erase_v1_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2EraseInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux Tools Erase V1 V1 Flux Tools Erase V1 Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/flux-tools/deblur-v1":{"post":{"tags":["Models"],"summary":"Remove blur from an image","description":"Submits a deblur task. The input image is regenerated by a FLUX blur-removal model to sharpen it while preserving the original scene, objects, composition, and lighting. No prompt needed.","operationId":"generate_flux_tools_deblur_v1_v1_flux_tools_deblur_v1_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flux2DeblurInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux Tools Deblur V1 V1 Flux Tools Deblur V1 Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/flux-kontext-max":{"post":{"tags":["Models"],"summary":"Edit or create an image with FLUX.1 Kontext [max]","description":"Submits an image creation task with FLUX.1 Kontext [max]. For image editing, prefer FLUX.2 [pro] (/flux-2-pro) or FLUX.2 [flex] (/flux-2-flex) which are the recommended default models for editing workflows.","operationId":"generate_flux_kontext_max_v1_flux_kontext_max_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FluxKontextProInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux Kontext Max V1 Flux Kontext Max Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.1 Kontext [max]"},"content":"FLUX.1 Kontext [max] is a legacy editing model. For new integrations, use FLUX.2 [pro] (/flux-2-pro). See [which model to use](/flux_2/flux2_overview#which-model-to-choose)."}}},"/v1/flux-kontext-pro":{"post":{"tags":["Models"],"summary":"Edit or create an image with FLUX.1 Kontext [pro]","description":"Submits an image creation task with FLUX.1 Kontext [pro]. For image editing, prefer FLUX.2 [pro] (/flux-2-pro) or FLUX.2 [flex] (/flux-2-flex) which are the recommended default models for editing workflows.","operationId":"generate_flux_kontext_pro_v1_flux_kontext_pro_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FluxKontextProInputs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponse"},{"$ref":"#/components/schemas/AsyncWebhookResponse"}],"title":"Response Generate Flux Kontext Pro V1 Flux Kontext Pro Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-mint":{"metadata":{"sidebarTitle":"FLUX.1 Kontext [pro]"},"content":"FLUX.1 Kontext [pro] is a legacy editing model. For new integrations, use FLUX.2 [pro] (/flux-2-pro). See [which model to use](/flux_2/flux2_overview#which-model-to-choose)."}}},"/v1/get_result":{"get":{"tags":["Utility"],"summary":"Get Result","description":"An endpoint for getting generation task result.","operationId":"get_result_v1_get_result_get","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/SettledCostResultResponse"},{"$ref":"#/components/schemas/ResultResponse"}],"title":"Response Get Result V1 Get Result Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/credits":{"get":{"summary":"Get the user's credits","description":"Get the user's credits","operationId":"get_credits_v1_credits_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditsResponse"}}}}},"security":[{"APIKeyHeader":[]}]}}},"components":{"schemas":{"AsyncResponse":{"properties":{"id":{"type":"string","title":"Id"},"polling_url":{"type":"string","title":"Polling Url"},"cost":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cost","description":"Cost in credits for this request"},"input_mp":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Input Mp","description":"Input megapixels (2 decimal places)"},"output_mp":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Output Mp","description":"Output megapixels (2 decimal places)"}},"type":"object","required":["id","polling_url"],"title":"AsyncResponse"},"AsyncWebhookResponse":{"properties":{"id":{"type":"string","title":"Id"},"status":{"type":"string","title":"Status"},"webhook_url":{"type":"string","title":"Webhook Url"},"cost":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cost","description":"Cost in credits for this request"},"input_mp":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Input Mp","description":"Input megapixels (2 decimal places)"},"output_mp":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Output Mp","description":"Output megapixels (2 decimal places)"}},"type":"object","required":["id","status","webhook_url"],"title":"AsyncWebhookResponse"},"CreditsResponse":{"properties":{"credits":{"type":"number","title":"Credits","description":"User's current credit balance"}},"type":"object","required":["credits"],"title":"CreditsResponse"},"DeleteFinetuneInputs":{"properties":{"finetune_id":{"type":"string","title":"Finetune Id","description":"Name of the LoRA to delete.","example":"my-finetune"}},"type":"object","required":["finetune_id"],"title":"DeleteFinetuneInputs"},"DeleteFinetuneResponse":{"properties":{"status":{"type":"string","title":"Status","description":"Status of the deletion"},"message":{"type":"string","title":"Message","description":"Message about the deletion"},"deleted_finetune_id":{"type":"string","title":"Deleted Finetune Id","description":"ID of the deleted finetune"},"timestamp":{"type":"string","title":"Timestamp","description":"Timestamp of the deletion"}},"type":"object","required":["status","message","deleted_finetune_id","timestamp"],"title":"DeleteFinetuneResponse"},"FinetuneDetailResponse":{"properties":{"finetune_details":{"additionalProperties":true,"type":"object","title":"Finetune Details","description":"Details about the parameters used for finetuning"}},"type":"object","required":["finetune_details"],"title":"FinetuneDetailResponse"},"FinetuneFluxUltraInput":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"finetune_id":{"type":"string","title":"Finetune Id","description":"Name of the LoRA to use. For LoRAs from other organizations (public or shared), use the format 'org-id/lora-name'.","example":"my-finetune"},"finetune_strength":{"type":"number","maximum":2.0,"minimum":0.0,"title":"Finetune Strength","description":"Strength of the fine-tuned model. 0.0 means no influence, 1.0 means full influence. Allowed values up to 2.0","default":1.2},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt","description":"The prompt to use for image generation.","default":"","example":"A beautiful landscape with mountains and a lake"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility. If not provided, a random seed will be used.","example":42},"aspect_ratio":{"type":"string","title":"Aspect Ratio","description":"Aspect ratio of the image between 21:9 and 9:21","default":"16:9"},"safety_tolerance":{"type":"integer","maximum":6.0,"minimum":0.0,"title":"Safety Tolerance","description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","default":2,"example":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"description":"Output format for the generated image. Can be 'jpeg', 'png', or 'webp'.","default":"jpeg"},"image_prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Prompt","description":"Optional image to remix in base64 format"},"image_prompt_strength":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Image Prompt Strength","description":"Blend between the prompt and the image prompt","default":0.1},"prompt_upsampling":{"type":"boolean","title":"Prompt Upsampling","description":"Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation","default":false},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","required":["finetune_id"],"title":"FinetuneFluxUltraInput"},"Flux2DeblurInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"image":{"type":"string","title":"Image","description":"Base64-encoded input image or HTTP(S) image URL."},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility.","example":42},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"default":"png"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","required":["image"],"title":"Flux2DeblurInputs","description":"Input model for public FLUX.2 deblur.\n\nDeblur takes only an image (no mask, no prompt): the whole image is\nregenerated by a fixed Klein 9B KV BF16 blur-removal LoRA with a fixed\nprompt, so the caller controls nothing but the input image."},"Flux2EraseInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"image":{"type":"string","title":"Image","description":"Base64-encoded input image or HTTP(S) image URL."},"mask":{"type":"string","title":"Mask","description":"Base64-encoded black/white mask or HTTP(S) image URL. White pixels indicate the object to remove; black pixels are preserved. Must have the same dimensions as the input image."},"dilate_pixels":{"type":"integer","maximum":25.0,"minimum":0.0,"title":"Dilate Pixels","description":"Number of pixels to dilate the mask by before removal. Dilation helps cover object edges. Maximum is 25 pixels.","default":10},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility.","example":42},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"default":"png"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","required":["image","mask"],"title":"Flux2EraseInputs","description":"Input model for public FLUX.2 erase."},"Flux2FlexInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Text prompt for image generation.","example":"ein fantastisches bild"},"prompt_upsampling":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Prompt Upsampling","description":"Whether to use prompt upsampling.","default":true},"input_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image","description":"Path to the input image."},"input_image_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 2","description":"Path to the second input image."},"input_image_3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 3","description":"Path to the third input image."},"input_image_4":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 4","description":"Path to the fourth input image."},"input_image_5":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 5","description":"Path to the fifth input image."},"input_image_6":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 6","description":"Path to the sixth input image."},"input_image_7":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 7","description":"Path to the seventh input image."},"input_image_8":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 8","description":"Path to the eighth input image."},"input_image_blob_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image Blob Path","description":"Blob path to the input image."},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility.","example":42},"width":{"anyOf":[{"type":"integer","minimum":64.0},{"type":"null"}],"title":"Width","description":"Width of the image","default":0},"height":{"anyOf":[{"type":"integer","minimum":64.0},{"type":"null"}],"title":"Height","description":"Height of the image","default":0},"guidance":{"anyOf":[{"type":"number","maximum":10.0,"minimum":1.5},{"type":"null"}],"title":"Guidance","description":"Guidance scale for image generation. High guidance scales improve prompt adherence at the cost of reduced realism.","default":5.0,"example":5.0},"steps":{"anyOf":[{"type":"integer","maximum":50.0,"minimum":1.0},{"type":"null"}],"title":"Steps","description":"Number of steps for image generation. Higher steps lead to more detailed and realistic images.","default":50,"example":50},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"default":"jpeg"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","required":["prompt"],"title":"Flux2FlexInputs"},"Flux2Inputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Text prompt for image generation.","example":"ein fantastisches bild"},"disable_pup":{"type":"boolean","title":"Disable Pup","description":"Disable automatic prompt upsampling for this request. FLUX.2 [pro] and [max] apply prompt upsampling by default; set this to true to generate from your prompt exactly as written.","default":false},"input_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image","description":"Path to the input image."},"input_image_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 2","description":"Path to the second input image."},"input_image_3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 3","description":"Path to the third input image."},"input_image_4":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 4","description":"Path to the fourth input image."},"input_image_5":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 5","description":"Path to the fifth input image."},"input_image_6":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 6","description":"Path to the sixth input image."},"input_image_7":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 7","description":"Path to the seventh input image."},"input_image_8":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 8","description":"Path to the eighth input image."},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility.","example":42},"width":{"anyOf":[{"type":"integer","minimum":64.0},{"type":"null"}],"title":"Width","description":"Width of the image","default":0},"height":{"anyOf":[{"type":"integer","minimum":64.0},{"type":"null"}],"title":"Height","description":"Height of the image","default":0},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"default":"jpeg"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","required":["prompt"],"title":"Flux2Inputs"},"Flux2KleinInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Text prompt for image generation.","example":"ein fantastisches bild"},"input_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image","description":"Path to the input image."},"input_image_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 2","description":"Path to the second input image."},"input_image_3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 3","description":"Path to the third input image."},"input_image_4":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 4","description":"Path to the fourth input image."},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility.","example":42},"width":{"anyOf":[{"type":"integer","minimum":64.0},{"type":"null"}],"title":"Width","description":"Width of the image","default":0},"height":{"anyOf":[{"type":"integer","minimum":64.0},{"type":"null"}],"title":"Height","description":"Height of the image","default":0},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"default":"jpeg"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","required":["prompt"],"title":"Flux2KleinInputs","description":"Input model for FLUX.2 Klein (non-base) - like Pro but max 4 images."},"Flux2KleinTryonInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Text prompt for VTO generation.","example":"TRY-ON: The person of image 1 wearing the garments of image 2."},"person":{"type":"string","title":"Person","description":"Person image (maps internally to input_image)."},"garment":{"type":"string","title":"Garment","description":"Image of one more garments (maps internally to input_image_2)."},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility.","example":42},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"default":"jpeg"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","required":["prompt","person","garment"],"title":"Flux2KleinTryonInputs","description":"Input model for FLUX.2 Klein VTO endpoint.\n\nExposes only person/garment image fields for cleaner API ergonomics."},"Flux3ImageInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Free-form prompt describing the image."},"images":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Images","description":"Optional reference image(s) the prompt edits or draws from; each is an http(s) URL or base64, one to 10 total."},"aspect_ratio":{"anyOf":[{"type":"string","enum":["21:9","2:1","16:9","3:2","7:5","4:3","5:4","1:1","4:5","3:4","5:7","2:3","9:16","1:2","9:21"]},{"type":"string","const":"auto"}],"title":"Aspect Ratio","description":"Output aspect ratio. Under `auto` a ratio the prompt asks for wins, otherwise the output keeps the first reference image's framing; without references the prompt decides, else 1:1.","default":"auto"},"resolution":{"type":"string","enum":["768sq","1k","1.5k","2k","4k","match_input"],"title":"Resolution","description":"Image resolution class, an equal-pixel-area tier: `768sq`, `1k` (default), `1.5k`, `2k`, or `4k`. Exact dimensions vary with the aspect ratio. `match_input` (edits only): the output keeps the first reference's own size (shrunk to 4 MP when larger), or its nearest tier when aspect_ratio is set. Ignored when width and height are set.","default":"1k"},"width":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Width","description":"Exact output width in pixels, [256, 6256]; set together with height. Overrides resolution and aspect_ratio."},"height":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Height","description":"Exact output height in pixels, [256, 6256]; width x height at most 16822272 pixels, and at most 4194304 with reference images."},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"grounding":{"type":"boolean","title":"Grounding","description":"When true (default) the prompt may be grounded in external research: web search and image search. When false, both are off.","default":true},"version":{"type":"string","const":"latest","title":"Version","description":"Endpoint version. `latest` (default) serves the current release; dated pinnable release tags are added here as they are published.","default":"latest"}},"additionalProperties":false,"type":"object","required":["prompt"],"title":"Flux3ImageInputs"},"Flux3ImageKleinInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Free-form prompt describing the image."},"images":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Images","description":"Optional reference image(s), each an http(s) URL or base64, one to 10 total. The first is the image being edited and sets the default output size."},"aspect_ratio":{"anyOf":[{"type":"string","enum":["21:9","2:1","16:9","3:2","7:5","4:3","5:4","1:1","4:5","3:4","5:7","2:3","9:16","1:2","9:21"]},{"type":"string","const":"auto"}],"title":"Aspect Ratio","description":"Output aspect ratio, as in flux-3-image. `auto` (default): for edits, the first reference's exact aspect; for text-to-image, a ratio picked from the prompt (prompt rewrite, else ratio keywords, else 16:9) at the requested tier. Ignored when width and height are set.","default":"auto"},"resolution":{"anyOf":[{"type":"string","enum":["768sq","1k","1.5k","2k","4k"]},{"type":"null"}],"title":"Resolution","description":"Equal-area size tier, as in flux-3-image: `768sq`, `1k`, `1.5k`, `2k` or `4k`. Omitted: `1k` for text-to-image; for edits the first reference's own size, or its nearest tier when aspect_ratio is set. Ignored when width and height are set."},"width":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Width","description":"Exact output width in pixels, [64, 6256]; set together with height. Overrides resolution and aspect_ratio."},"height":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Height","description":"Exact output height in pixels, [64, 6256]; width x height at most 16822272 pixels (16.8 MP, the largest 4k bin)."},"seed":{"anyOf":[{"type":"integer","maximum":4294967295.0,"minimum":0.0},{"type":"null"}],"title":"Seed","description":"Seed for reproducibility; random when omitted."},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"output_format":{"type":"string","enum":["jpeg","png"],"title":"Output Format","description":"Output image format: `jpeg` (default) or `png`.","default":"jpeg"},"steps":{"anyOf":[{"type":"integer","maximum":16.0,"minimum":1.0},{"type":"null"}],"title":"Steps","description":"Denoising steps (default 16)."}},"additionalProperties":false,"type":"object","required":["prompt"],"title":"Flux3ImageKleinInputs","description":"FLUX 3 Image Klein: text-to-image, or editing with up to 10 reference images."},"Flux3VideoDraftEnhanceInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"mode":{"type":"string","const":"draft_enhance","title":"Mode"},"draft_cache":{"type":"string","title":"Draft Cache","description":"Encrypted draft-cache bundle from a prior `draft` generation. Primary form: the base64-encoded `.bin` file downloaded from the prior result's `draft_cache` URL. An http(s) URL is also accepted for replays within the download URL's expiry window. The harness is skipped and the original FLUX call is reproduced at full quality; the original inputs are embedded in the bundle."},"resolution":{"type":"string","enum":["hd","fhd","qhd","uhd"],"title":"Resolution","description":"Video resolution class of the enhanced result: `fhd` (default), `qhd`, and `uhd` finish the reproduced generation with the video upsampler at that canvas, `hd` returns it without that pass. The reproduced generation is identical whichever is chosen; only the finishing pass differs.","default":"fhd"},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2}},"additionalProperties":false,"type":"object","required":["mode","draft_cache"],"title":"Draft Enhance","description":"Full-quality render of a prior `draft` generation. The bundle pins the\ngeneration itself -- the original mode, prompt, seed, and conditioning\nmedia -- so `resolution` is the only output choice left to the caller."},"Flux3VideoI2VInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Free-form prompt describing the video."},"aspect_ratio":{"anyOf":[{"type":"string","enum":["21:9","2:1","16:9","4:3","1:1","3:4","9:16","9:21"]},{"type":"string","const":"auto"}],"title":"Aspect Ratio","description":"Output aspect ratio. `auto` lets the harness choose from the prompt and any references.","default":"auto"},"duration":{"anyOf":[{"type":"integer","maximum":20.0,"minimum":5.0},{"type":"string","const":"auto"}],"title":"Duration","description":"Video duration in seconds (any whole second from 5 to 20), or `auto` to fit the content.","default":"auto"},"resolution":{"type":"string","enum":["hd","fhd","qhd","uhd"],"title":"Resolution","description":"Video resolution class: `hd`, or `fhd`/`qhd`/`uhd` for a higher-resolution result finished by the video upsampler. Exact dimensions vary with the aspect ratio.","default":"hd"},"version":{"type":"string","const":"latest","title":"Version","description":"Endpoint version. `latest` (default) serves the current release; dated pinnable release tags are added here as they are published.","default":"latest"},"generate_audio":{"type":"boolean","title":"Generate Audio","description":"Generate synchronized audio alongside the video.","default":true},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"draft":{"type":"boolean","title":"Draft","description":"Draft mode: generate a fast preview and return a `draft_cache` download URL in the result. Download that bundle and pass it back later to render the full-quality version of the same generation.","default":false},"mode":{"type":"string","const":"i2v","title":"Mode"},"keyframes":{"anyOf":[{"type":"string"},{"prefixItems":[{"type":"number"},{"type":"string"}],"type":"array","maxItems":2,"minItems":2},{"items":{"type":"string"},"type":"array"},{"items":{"prefixItems":[{"type":"number"},{"type":"string"}],"type":"array","maxItems":2,"minItems":2},"type":"array"}],"title":"Keyframes","description":"Your images become frames of the video; each is an http(s) URL or base64, one to ten total. Plain images: one starts the video, two start and end it, with more the first starts it, the last ends it, and the rest fall evenly in between (3 or more need a set `duration`). To control the timing yourself, send `[seconds, image]` pairs in time order, e.g. `[[0, \"...\"], [3.5, \"...\"]]`: each image becomes the frame at that second, and with `duration: \"auto\"` the video runs to the last pair's second, rounded up (20s max)."}},"additionalProperties":false,"type":"object","required":["prompt","mode","keyframes"],"title":"Image to Video","description":"Image continuation: your images become frames of the video. One image\nstarts the video; two start and end it; with more, the first starts it,\nthe last ends it, and the rest fall evenly in between. To control the\ntiming yourself, send `[seconds, image]` pairs: each image becomes the\nframe at that second."},"Flux3VideoInputsBody":{"oneOf":[{"$ref":"#/components/schemas/Flux3VideoT2VInputs"},{"$ref":"#/components/schemas/Flux3VideoI2VInputs"},{"$ref":"#/components/schemas/Flux3VideoV2VInputs"},{"$ref":"#/components/schemas/Flux3VideoDraftEnhanceInputs"}],"title":"Flux3VideoInputsBody","description":"Route body wrapper: FastAPI drops the union's discriminator when the\nbare union is the top-level body param, so 422s enumerate every mode\nclass instead of the one the client sent. The RootModel keeps\ndiscrimination inside pydantic; routes unwrap `.root`.","discriminator":{"propertyName":"mode","mapping":{"draft_enhance":"#/components/schemas/Flux3VideoDraftEnhanceInputs","i2v":"#/components/schemas/Flux3VideoI2VInputs","t2v":"#/components/schemas/Flux3VideoT2VInputs","v2v":"#/components/schemas/Flux3VideoV2VInputs"}}},"Flux3VideoT2VInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Free-form prompt describing the video."},"aspect_ratio":{"anyOf":[{"type":"string","enum":["21:9","2:1","16:9","4:3","1:1","3:4","9:16","9:21"]},{"type":"string","const":"auto"}],"title":"Aspect Ratio","description":"Output aspect ratio. `auto` lets the harness choose from the prompt and any references.","default":"auto"},"duration":{"anyOf":[{"type":"integer","maximum":20.0,"minimum":5.0},{"type":"string","const":"auto"}],"title":"Duration","description":"Video duration in seconds (any whole second from 5 to 20), or `auto` to fit the content.","default":"auto"},"resolution":{"type":"string","enum":["hd","fhd","qhd","uhd"],"title":"Resolution","description":"Video resolution class: `hd`, or `fhd`/`qhd`/`uhd` for a higher-resolution result finished by the video upsampler. Exact dimensions vary with the aspect ratio.","default":"hd"},"version":{"type":"string","const":"latest","title":"Version","description":"Endpoint version. `latest` (default) serves the current release; dated pinnable release tags are added here as they are published.","default":"latest"},"generate_audio":{"type":"boolean","title":"Generate Audio","description":"Generate synchronized audio alongside the video.","default":true},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"draft":{"type":"boolean","title":"Draft","description":"Draft mode: generate a fast preview and return a `draft_cache` download URL in the result. Download that bundle and pass it back later to render the full-quality version of the same generation.","default":false},"mode":{"type":"string","const":"t2v","title":"Mode"}},"additionalProperties":false,"type":"object","required":["prompt","mode"],"title":"Text to Video"},"Flux3VideoUpscaleInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"input_video":{"type":"string","title":"Input Video","description":"The clip to upscale: base64-encoded mp4 (max 50MB) or an http(s) URL. The upscale covers the first 20 seconds; a clip slightly over that is upscaled up to the 20 second mark, and one well over is rejected. At most 2560x1440 (3.7 megapixels) per frame: this endpoint upscales toward 4K, so downscale a larger source before submitting it."},"prompt":{"type":"string","title":"Prompt","description":"Optional description of the clip's content, steering the enhanced detail. Leave empty for a neutral upscale.","default":""},"creativity":{"type":"integer","enum":[0,1],"title":"Creativity","description":"Upscale behavior: 0 preserves the source precisely; 1 allows creative detail enhancement.","default":1},"upscale_factor":{"type":"number","maximum":3.0,"minimum":1.5,"title":"Upscale Factor","description":"Output scaling relative to the source resolution, between 1.5 and 3. The output preserves the source aspect ratio and is capped at a 13.75 MP frame: very large sources are upscaled by less than the requested factor.","default":2.0},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive the result callback."},"webhook_secret":{"anyOf":[{"type":"string","format":"password","writeOnly":true},{"type":"null"}],"title":"Webhook Secret","description":"Secret echoed in the webhook signature header."}},"additionalProperties":false,"type":"object","required":["input_video"],"title":"Flux3VideoUpscaleInputs"},"Flux3VideoV2VInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Free-form prompt describing the video."},"aspect_ratio":{"anyOf":[{"type":"string","enum":["21:9","2:1","16:9","4:3","1:1","3:4","9:16","9:21"]},{"type":"string","const":"auto"}],"title":"Aspect Ratio","description":"Output aspect ratio. `auto` lets the harness choose from the prompt and any references.","default":"auto"},"duration":{"anyOf":[{"type":"integer","maximum":15.0,"minimum":5.0},{"type":"string","const":"auto"}],"title":"Duration","description":"Video duration in seconds (any whole second from 5 to 15), or `auto` to fit the content.","default":"auto"},"resolution":{"type":"string","enum":["hd","fhd","qhd","uhd"],"title":"Resolution","description":"Video resolution class: `hd`, or `fhd`/`qhd`/`uhd` for a higher-resolution result finished by the video upsampler. Exact dimensions vary with the aspect ratio.","default":"hd"},"version":{"type":"string","const":"latest","title":"Version","description":"Endpoint version. `latest` (default) serves the current release; dated pinnable release tags are added here as they are published.","default":"latest"},"generate_audio":{"type":"boolean","title":"Generate Audio","description":"Generate synchronized audio alongside the video.","default":true},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"draft":{"type":"boolean","title":"Draft","description":"Draft mode: generate a fast preview and return a `draft_cache` download URL in the result. Download that bundle and pass it back later to render the full-quality version of the same generation.","default":false},"mode":{"type":"string","const":"v2v","title":"Mode"},"start_video":{"type":"string","title":"Start Video","description":"The video to continue, an http(s) URL or base64 mp4; the generated clip carries on from its final frames."}},"additionalProperties":false,"type":"object","required":["prompt","mode","start_video"],"title":"Video Continuation","description":"Video continuation: the generated clip carries on from your video's\nfinal frames."},"Flux3VideoVE2VNamedInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"video":{"type":"string","title":"Video","description":"The video to edit, an http(s) URL or base64-encoded mp4."},"prompt":{"type":"string","maxLength":4096,"minLength":1,"title":"Prompt","description":"Edit instruction, stripped of surrounding whitespace."},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2}},"additionalProperties":false,"type":"object","required":["video","prompt"],"title":"Video Edit","description":"Video edit on a dedicated route: the clip and the instruction.\n\nThe public `/flux-tools/video-edit-v1` body. The route pins the recipe, so\nthe body has no `mode` and no `version` to pick, and every serving control\n-- duration, resolution, aspect ratio, audio, steps, guidance, seed --\nstays server-pinned."},"FluxDevInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Text prompt for image generation.","default":"","example":"ein fantastisches bild"},"image_prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Prompt","description":"Optional base64 encoded image to use as a prompt for generation."},"width":{"type":"integer","multipleOf":32.0,"maximum":1440.0,"minimum":256.0,"title":"Width","description":"Width of the generated image in pixels. Must be a multiple of 32.","default":1024},"height":{"type":"integer","multipleOf":32.0,"maximum":1440.0,"minimum":256.0,"title":"Height","description":"Height of the generated image in pixels. Must be a multiple of 32.","default":768},"steps":{"anyOf":[{"type":"integer","maximum":50.0,"minimum":1.0},{"type":"null"}],"title":"Steps","description":"Number of steps for the image generation process.","default":28,"example":28},"prompt_upsampling":{"type":"boolean","title":"Prompt Upsampling","description":"Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation.","default":false},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility.","example":42},"guidance":{"anyOf":[{"type":"number","maximum":5.0,"minimum":1.5},{"type":"null"}],"title":"Guidance","description":"Guidance scale for image generation. High guidance scales improve prompt adherence at the cost of reduced realism.","default":3.0,"example":3.0},"safety_tolerance":{"type":"integer","maximum":6.0,"minimum":0.0,"title":"Safety Tolerance","description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","default":2,"example":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"description":"Output format for the generated image. Can be 'jpeg', 'png', or 'webp'.","default":"jpeg"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","title":"FluxDevInputs"},"FluxKontextProInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"type":"string","title":"Prompt","description":"Text prompt for image generation.","example":"ein fantastisches bild"},"input_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image","description":"Base64 encoded image or URL to use with Kontext."},"input_image_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 2","description":"Base64 encoded image or URL to use with Kontext. *Experimental Multiref*"},"input_image_3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 3","description":"Base64 encoded image or URL to use with Kontext. *Experimental Multiref*"},"input_image_4":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Image 4","description":"Base64 encoded image or URL to use with Kontext. *Experimental Multiref*"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility.","example":42},"aspect_ratio":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Aspect Ratio","description":"Aspect ratio of the image between 21:9 and 9:21"},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"description":"Output format for the generated image. Can be 'jpeg', 'png', or 'webp'.","default":"png"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"},"prompt_upsampling":{"type":"boolean","title":"Prompt Upsampling","description":"Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation.","default":false},"safety_tolerance":{"type":"integer","maximum":6.0,"minimum":0.0,"title":"Safety Tolerance","description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","default":2,"example":2}},"type":"object","required":["prompt"],"title":"FluxKontextProInputs"},"FluxOutpaintingInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"input_image":{"type":"string","title":"Input Image","description":"Base64-encoded input (reference) image or HTTP(S) image URL."},"width":{"type":"integer","minimum":64.0,"title":"Width","description":"Target output width."},"height":{"type":"integer","minimum":64.0,"title":"Height","description":"Target output height."},"auto_crop":{"type":"boolean","title":"Auto Crop","description":"If True, crop the input image to the canvas bounds when it extends beyond the edges. If False, an error is raised instead.","default":false},"safety_tolerance":{"type":"integer","maximum":7.0,"minimum":0.0,"title":"Safety Tolerance","description":"Harm moderation tolerance from 0 to 7, with 0 the strictest. The route and organization determine the approved maximum and per-category ceilings. Unapproved levels return 422 with approved levels.","default":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"default":"png"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt","description":"Experimental: optional text guidance for the outpainted region. The model may not strictly follow this prompt; the visual content of the input image is the primary signal. Leave unset for default behavior."},"reference_offset_x":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reference Offset X","description":"Left offset (px) of the reference image's top-left corner on the output canvas. Negative values are allowed. None = center horizontally."},"reference_offset_y":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reference Offset Y","description":"Top offset (px) of the reference image's top-left corner on the output canvas. Negative values are allowed. None = center vertically."},"mode":{"type":"string","enum":["high","fast"],"title":"Mode","description":"Quality/speed trade-off. 'high' (default): highest-fidelity results, recommended whenever fine detail, prompt adherence, or consistency with complex content in the source image matters; slower. 'fast': significantly faster and well-suited for naturally extending most scenes (landscapes, backgrounds, textures, products); may produce lower fidelity in the extended region than 'high'.","default":"high"},"disable_pup":{"type":"boolean","title":"Disable Pup","description":"Skip the image-aware prompt upsampler for lower latency. The prompt (or a default extension prompt) is sent directly to the generation model; quality in the extended region may be lower for scenes that benefit from semantic guidance. Applies to both modes.","default":false}},"additionalProperties":false,"type":"object","required":["input_image","width","height"],"title":"FluxOutpaintingInputs","description":"Public contract for ``/v1/flux-tools/outpainting-v1``."},"FluxPro11Inputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt","description":"Text prompt for image generation.","default":"","example":"ein fantastisches bild"},"image_prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Prompt","description":"Optional base64 encoded image to use with Flux Redux."},"width":{"type":"integer","multipleOf":32.0,"maximum":1440.0,"minimum":256.0,"title":"Width","description":"Width of the generated image in pixels. Must be a multiple of 32.","default":1024},"height":{"type":"integer","multipleOf":32.0,"maximum":1440.0,"minimum":256.0,"title":"Height","description":"Height of the generated image in pixels. Must be a multiple of 32.","default":768},"prompt_upsampling":{"type":"boolean","title":"Prompt Upsampling","description":"Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation.","default":false},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility.","example":42},"safety_tolerance":{"type":"integer","maximum":6.0,"minimum":0.0,"title":"Safety Tolerance","description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","default":2,"example":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"description":"Output format for the generated image. Can be 'jpeg', 'png', or 'webp'.","default":"jpeg"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","title":"FluxPro11Inputs"},"FluxProExpandInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"image":{"type":"string","title":"Image","description":"A Base64-encoded string representing the image you wish to expand."},"top":{"anyOf":[{"type":"integer","maximum":2048.0,"minimum":0.0},{"type":"null"}],"title":"Top","description":"Number of pixels to expand at the top of the image","default":0},"bottom":{"anyOf":[{"type":"integer","maximum":2048.0,"minimum":0.0},{"type":"null"}],"title":"Bottom","description":"Number of pixels to expand at the bottom of the image","default":0},"left":{"anyOf":[{"type":"integer","maximum":2048.0,"minimum":0.0},{"type":"null"}],"title":"Left","description":"Number of pixels to expand on the left side of the image","default":0},"right":{"anyOf":[{"type":"integer","maximum":2048.0,"minimum":0.0},{"type":"null"}],"title":"Right","description":"Number of pixels to expand on the right side of the image","default":0},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt","description":"The description of the changes you want to make. This text guides the expansion process, allowing you to specify features, styles, or modifications for the expanded areas.","default":"","example":"ein fantastisches bild"},"steps":{"anyOf":[{"type":"integer","maximum":50.0,"minimum":15.0},{"type":"null"}],"title":"Steps","description":"Number of steps for the image generation process","default":50,"example":50},"prompt_upsampling":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Prompt Upsampling","description":"Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation","default":false},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility"},"guidance":{"anyOf":[{"type":"number","maximum":100.0,"minimum":1.5},{"type":"null"}],"title":"Guidance","description":"Guidance strength for the image generation process","default":60},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"description":"Output format for the generated image. Can be 'jpeg', 'png', or 'webp'.","default":"jpeg"},"safety_tolerance":{"type":"integer","maximum":6.0,"minimum":0.0,"title":"Safety Tolerance","description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","default":2,"example":2},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","required":["image"],"title":"FluxProExpandInputs"},"FluxProFillInputs":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"image":{"type":"string","title":"Image","description":"A Base64-encoded string representing the image you wish to modify. Can contain alpha mask if desired."},"mask":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mask","description":"A Base64-encoded string representing a mask for the areas you want to modify in the image. The mask should be the same dimensions as the image and in black and white. Black areas (0%) indicate no modification, while white areas (100%) specify areas for inpainting. Optional if you provide an alpha mask in the original image. Validation: The endpoint verifies that the dimensions of the mask match the original image."},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt","description":"The description of the changes you want to make. This text guides the inpainting process, allowing you to specify features, styles, or modifications for the masked area.","default":"","example":"ein fantastisches bild"},"steps":{"anyOf":[{"type":"integer","maximum":50.0,"minimum":15.0},{"type":"null"}],"title":"Steps","description":"Number of steps for the image generation process","default":50,"example":50},"prompt_upsampling":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Prompt Upsampling","description":"Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation","default":false},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility"},"guidance":{"anyOf":[{"type":"number","maximum":100.0,"minimum":1.5},{"type":"null"}],"title":"Guidance","description":"Guidance strength for the image generation process","default":60},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"description":"Output format for the generated image. Can be 'jpeg', 'png', or 'webp'.","default":"jpeg"},"safety_tolerance":{"type":"integer","maximum":6.0,"minimum":0.0,"title":"Safety Tolerance","description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","default":2,"example":2},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","required":["image"],"title":"FluxProFillInputs"},"FluxUltraInput":{"properties":{"user":{"anyOf":[{"type":"string","maxLength":256,"minLength":1,"pattern":"^[^\\x00]*$"},{"type":"null"}],"title":"User","description":"Opaque identifier for the end user supplied by the calling platform."},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt","description":"The prompt to use for image generation.","default":"","example":"A beautiful landscape with mountains and a lake"},"prompt_upsampling":{"type":"boolean","title":"Prompt Upsampling","description":"Whether to perform upsampling on the prompt. If active, automatically modifies the prompt for more creative generation.","default":false},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"Optional seed for reproducibility. If not provided, a random seed will be used.","example":42},"aspect_ratio":{"type":"string","title":"Aspect Ratio","description":"Aspect ratio of the image between 21:9 and 9:21","default":"16:9"},"safety_tolerance":{"type":"integer","maximum":6.0,"minimum":0.0,"title":"Safety Tolerance","description":"Tolerance level for input and output moderation. Between 0 and 6, 0 being most strict, 6 being least strict.","default":2,"example":2},"output_format":{"anyOf":[{"$ref":"#/components/schemas/OutputFormat"},{"type":"null"}],"description":"Output format for the generated image. Can be 'jpeg', 'png', or 'webp'.","default":"jpeg"},"raw":{"type":"boolean","title":"Raw","description":"Generate less processed, more natural-looking images","default":false,"example":false},"image_prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Prompt","description":"Optional image to remix in base64 format"},"image_prompt_strength":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Image Prompt Strength","description":"Blend between the prompt and the image prompt","default":0.1},"webhook_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Webhook Url","description":"URL to receive webhook notifications"},"webhook_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Secret","description":"Optional secret for webhook signature verification"}},"type":"object","title":"FluxUltraInput"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"MyFinetunesResponse":{"properties":{"finetunes":{"items":{},"type":"array","title":"Finetunes","description":"List of finetunes created by the user"}},"type":"object","required":["finetunes"],"title":"MyFinetunesResponse"},"OutputFormat":{"type":"string","enum":["jpeg","png","webp"],"title":"OutputFormat"},"ResultResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Task id for retrieving result"},"status":{"$ref":"#/components/schemas/StatusResponse"},"result":{"anyOf":[{},{"type":"null"}],"title":"Result"},"progress":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Progress"},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details"},"preview":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Preview"}},"type":"object","required":["id","status"],"title":"ResultResponse"},"SettledCostResultResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Task id for retrieving result"},"status":{"$ref":"#/components/schemas/StatusResponse"},"result":{"anyOf":[{},{"type":"null"}],"title":"Result"},"progress":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Progress"},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details"},"preview":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Preview"},"cost":{"type":"number","title":"Cost","description":"Settled cost in credits for this request"}},"type":"object","required":["id","status","cost"],"title":"SettledCostResultResponse"},"StatusResponse":{"type":"string","enum":["Task not found","Pending","Reasoning","Generating","Request Moderated","Content Moderated","No Card Generated","Ready","Error"],"title":"StatusResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"x-key"}}},"tags":[{"name":"Models","description":"Generation task endpoints. These endpoints allow you to submit generation tasks."},{"name":"Utility","description":"These utility endpoints allow you to check the results of submitted tasks and to manage your finetunes."}]} \ No newline at end of file diff --git a/pipeline/provider_docs/bfl__docs.bfl.ml_flux_3_flux3_image_layout.md b/pipeline/provider_docs/bfl__docs.bfl.ml_flux_3_flux3_image_layout.md new file mode 100644 index 0000000000000000000000000000000000000000..b35032416e733e4256dadfa07470dbfaacc9db1a --- /dev/null +++ b/pipeline/provider_docs/bfl__docs.bfl.ml_flux_3_flux3_image_layout.md @@ -0,0 +1,243 @@ +> ## Documentation Index +> Fetch the complete documentation index at: https://docs.bfl.ml/llms.txt +> Use this file to discover all available pages before exploring further. + +# FLUX 3 Image Editing + +> Edit an image with a written instruction, combine up to ten references, and use bounding boxes to place elements or target an edit with FLUX 3 Image. + +FLUX 3 Image + +# FLUX 3 Image Editing + +Edit an image with a written instruction, combine up to ten references, and add bounding boxes to place elements or target an edit. + +## Quickstart + +Send an image in `images` and say what to change. This request recolors an owl +and keeps the rest of the photo as it was. Drag the handle to compare: + +Previous clip + +Next clip + +Set `BFL_API_KEY` to a key from the [BFL dashboard](https://dashboard.bfl.ai), then submit: + +```python Python theme={null} +import os +import requests + +response = requests.post( + "https://api.bfl.ai/v1/flux-3-image", + headers={"x-key": os.environ["BFL_API_KEY"]}, + json={ + "prompt": "In this image, change , previously described as \"a short-eared owl in flight with brown and tan mottled feathers and yellow eyes\", to: a short-eared owl in flight with striking snowy white and charcoal grey mottled feathers and bright yellow eyes. Keep everything else in the image — composition, other elements, lighting, background — exactly unchanged.", + "images": ["https://cdn.sanity.io/images/2gpum2i6/production/1731db585c799dbb4e2c48731ea0b5bfc92a47d7-1800x1193.webp"], + }, + timeout=60, +) +response.raise_for_status() +print(response.json()) +``` + +```bash cURL theme={null} +curl --fail-with-body https://api.bfl.ai/v1/flux-3-image \ + -H "x-key: $BFL_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{ + "prompt": "In this image, change , previously described as \"a short-eared owl in flight with brown and tan mottled feathers and yellow eyes\", to: a short-eared owl in flight with striking snowy white and charcoal grey mottled feathers and bright yellow eyes. Keep everything else in the image — composition, other elements, lighting, background — exactly unchanged.", + "images": ["https://cdn.sanity.io/images/2gpum2i6/production/1731db585c799dbb4e2c48731ea0b5bfc92a47d7-1800x1193.webp"] + }' +``` + +`aspect_ratio` defaults to `auto`, so the edit has the same aspect ratio as the +image you send. The output is `1k`. For the same size as the input image, up to 4MP, +set `resolution` to `match_input`. Poll the returned `polling_url` until `status` is `Ready`, then +download the image from `result.sample` within 1 hour. +[FLUX 3 Text to Image](https://docs.bfl.ml/flux_3/flux3_image_generate.md#quickstart) has complete +clients that submit, poll, and save. + +## Edit with an instruction + +These examples call `generate()` from the +[complete clients](https://docs.bfl.ml/flux_3/flux3_image_generate.md#quickstart), which submits a +request, polls until it is ready, and saves the image. + +Send the image in `images` and write the change as an instruction. Name the +element precisely enough that only one thing in the image matches. This +request changes the color of one bird in a flock: + +Previous clip + +Next clip + +```python theme={null} +generate({ + "prompt": "change the color of only one bird in the middle to #e01075", + "images": ["https://cdn.sanity.io/images/2gpum2i6/production/4792198dfeba9223bf3ecf020fed2942de7f0bd7-1800x1200.webp"], +}, name="pink_bird") +``` + +With `aspect_ratio` left at `auto`, the output keeps the aspect ratio of the +image you send. + +You don't have to draw a box for a single edit. Before it generates, FLUX 3 +Image expands your instruction into a detailed prompt, and for many edits it +also finds the element you named and adds a box for it. The expanded prompt, +including any boxes it added, comes back in `result.prompt`. To control exactly +which elements change, use [bounding boxes](https://docs.bfl.ml/flux_3/flux3_image_bounding_boxes.md#edit-an-image). + +## Multi reference + +Refer to each image by its position or by what it shows. "Image 1" is the +first entry in `images`, "image 2" the second, and so on up to ten. Here, +image 1 is the scene and image 2 supplies the object to place in it: + +replace the cartridge from image 1 with the van in image 2, adjust the lighting on the van to integrate well within image 1 + +```python theme={null} +generate({ + "prompt": "replace the cartridge from image 1 with the van in image 2, adjust the lighting on the van to integrate well within image 1", + "images": [ + "https://cdn.sanity.io/images/2gpum2i6/production/ec365238b6efa1b29f573e83b774c6d539408ea8-1800x1200.webp", + "https://cdn.sanity.io/images/2gpum2i6/production/ff3bf81b5a8b38f0d870561217b68a72964259ab-1131x1414.webp", + ], +}, name="turntable_van") +``` + +With `aspect_ratio` at `auto`, the output uses the aspect ratio of the first +image in `images`. The turntable is first, so the result is landscape. For a +different shape, put a different image first or set `aspect_ratio`. + +For product shots, try-ons, and group compositions, say how the images relate: +"the person from image 1 wears the jacket from image 2 and stands in the +kitchen from image 3". + +## Examples + +Each example shows the inputs, the result, and the prompt that produced it. + +### Single Image Reference + +Send one image and write the change as an instruction. Drag the handle to +compare: + +Previous clip + +Next clip + +### Multi Image Reference + +Refer to each image by its position in `images`. The output keeps the +aspect ratio of image 1. + +**Replace an object with a new design** + +use image 2 texture and shape to create a bag, and replace the bag in image 1. use #CC5500, #F5A623 #6B8E23 colors for the new bag. + +**Add elements from several images** + +Use image 1 as the main image. Insert the lake from image 2 on the left side of image 1, and make sure it blends naturally with the surroundings as if it is part of the garden view. Insert the ducks from image 3 into image 1, and make them appear as if they are near the lake on the grass + +**Furnish a room** + +Furnish the exact room in image 1 with the following items: the bed from image 2 on the left side of the room near the wall. on top of the bed the cushion from image 3. on the floor the carpet from image 4 + +### Edit with Bboxes + +Each edit changes one boxed element and anchors the rest. Select an +example, then switch between before and after. + +## Send a request + +Copy a request body from the [bounding box examples](https://docs.bfl.ml/flux_3/flux3_image_bounding_boxes.md#examples) +and paste it where indicated below, including its outer braces. To adapt an edit to your image, update the image URL, element +descriptions, and source and target boxes. + +```python Python theme={null} +import json + +body = r''' +Paste the complete copied JSON body here. +''' +generate(json.loads(body)) +``` + +```bash cURL theme={null} +curl --fail-with-body https://api.bfl.ai/v1/flux-3-image \ + -H "x-key: $BFL_API_KEY" \ + -H "Content-Type: application/json" \ + -d @- <<'EOF' +Paste the copied request body here. +EOF +``` + +`generate()` is defined in the [complete clients](https://docs.bfl.ml/flux_3/flux3_image_generate.md#quickstart). +It submits the request, polls until the image is ready, and saves it. With +cURL, poll the returned `polling_url` until `status` is `Ready`, then download +`result.sample`. + +> **Coordinate conversion and editing tips** +> +> Use the aspect ratio you designed the layout for, because the grid +> stretches with the frame. For edits, `auto` +> follows the first reference; without a reference, it produces a square. +> +> ```python theme={null} +> def to_bbox(left, top, right, bottom, width, height): +> return [round(top / height * 1000), round(left / width * 1000), +> round(bottom / height * 1000), round(right / width * 1000)] +> +> to_bbox(384, 108, 1536, 972, 1920, 1080) # [100, 200, 900, 800] +> ``` +> +> To move or resize an element, use different source and target boxes. +> Use matching boxes to ask for it to stay in place. State additions and +> removals in the written instruction as well as the rows. +> +> Very small boxes can fail. In our tests, a new element in a box about +> 40 × 25 pixels often did not appear, so give new elements a larger box. +> +> Give text its own box and quote the words in `desc`. +> See [Layout prompts](https://docs.bfl.ml/guides/prompting_layout.md) for more examples. + +> **Try drawing a box** +> +> Draw over a marked region, or choose one below the image, then select +> an object. This demo uses saved edits and makes no API requests. +> +> Place an object +> +> Draw over a marked region and choose an object to see a saved edit in that region. +> +> Pre-generated edits +> +> ![A storybook forest clearing](https://docs.bfl.ml/images/flux3/bbox/base.webp) +> +> Reset edits + +> **Pixel-perfect edits** +> +> Pixels outside the boxes usually stay the same. Shadows, reflections, +> or nearby lighting may still change. +> +> Compare each input with its edit. Switch to Changed pixels to see which +> areas the edit touched. + +## Keep exploring + +> **[FLUX 3 Text to Image](https://docs.bfl.ml/flux_3/flux3_image_generate.md)** +> +> Complete clients that submit, poll, and save, plus edits and +> multi-reference requests. + +> **[API reference](https://docs.bfl.ml/api-reference/utility/generate-an-image-with-flux-3.md)** +> +> The full request schema, limits, and response codes. + +> **[Layout prompts](https://docs.bfl.ml/guides/prompting_layout.md)** +> +> How to write the caption and element table for a layout. + + +This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform. \ No newline at end of file diff --git a/pipeline/provider_docs/bytedance__docs.byteplus.com_en_docs_modelark_image-generation-api b/pipeline/provider_docs/bytedance__docs.byteplus.com_en_docs_modelark_image-generation-api new file mode 100644 index 0000000000000000000000000000000000000000..4f52f5de98fac5e971c68ec00af41c82c82b4356 --- /dev/null +++ b/pipeline/provider_docs/bytedance__docs.byteplus.com_en_docs_modelark_image-generation-api @@ -0,0 +1,8 @@ + + BytePlus +
        ModelArk

        ModelArk

        Search
        • Home
          • ModelArkImage generation APIImage generation API
        Copy Page
        Image generation API
        Image generation API
        Copy Page
        Image generation API
        Last updated:  October 17, 2026 07:37:27
        Was this page helpful to you?
        Yes
        Yes
        No
        No
        + \ No newline at end of file diff --git a/pipeline/provider_docs/fetch_log.tsv b/pipeline/provider_docs/fetch_log.tsv new file mode 100644 index 0000000000000000000000000000000000000000..345ede29490070c02e7c03c8bf5d8dc2078da28a --- /dev/null +++ b/pipeline/provider_docs/fetch_log.tsv @@ -0,0 +1,17 @@ +openai 200 890221 302 https://web.archive.org/web/20261030161453/https://developers.openai.com/api/reference/resources/images/methods/edit https://developers.openai.com/api/reference/resources/images/methods/edit +google 200 1446985 302 https://web.archive.org/web/20261030161523/https://ai.google.dev/gemini-api/docs/image-generation https://ai.google.dev/gemini-api/docs/image-generation +google 200 1231239 302 https://web.archive.org/web/20261030161547/https://ai.google.dev/api/generate-content https://ai.google.dev/api/generate-content +bytedance 200 817736 302 https://web.archive.org/web/20261030161617/https://docs.byteplus.com/en/docs/modelark/image-generation-api https://docs.byteplus.com/en/docs/modelark/image-generation-api +meta 200 302822 302 https://web.archive.org/web/20261030161651/https://dev.meta.ai/docs/api-reference/images/schemas https://dev.meta.ai/docs/api-reference/images/schemas +bfl 200 88278 302 https://web.archive.org/web/20261030161805/https://api.bfl.ai/openapi.json https://api.bfl.ai/openapi.json +bfl 200 9629 302 https://web.archive.org/web/20261030161812/https://docs.bfl.ml/flux_3/flux3_image_layout.md https://docs.bfl.ml/flux_3/flux3_image_layout.md +ideogram 200 436993 302 https://web.archive.org/web/20261030161819/https://developer.ideogram.ai/openapi/ideogram-api-v2.json https://api.ideogram.ai/openapi.json +microsoft 200 79286 302 https://web.archive.org/web/20261030161828/https://learn.microsoft.com/en-us/azure/foundry/foundry-models/how-to/use-foundry-models-mai-image https://learn.microsoft.com/en-us/azure/foundry/foundry-models/how-to/use-foundry-models-mai +xai 200 17560 429 https://docs.x.ai/developers/rest-api-reference/inference/images.md +xai 200 16607 429 https://docs.x.ai/developers/model-capabilities/images/generation.md +kling 200 76456 429 https://kling.ai/document-api/api/image/3-0-omni/image-omni +alibaba 200 134009 429 https://www.alibabacloud.com/help/en/model-studio/wan-image-generation-and-editing-api-reference +alibaba 200 137091 429 https://www.alibabacloud.com/help/en/model-studio/wan-image-edit +alibaba 200 98695 429 https://www.alibabacloud.com/help/en/model-studio/qwen-image-generation-and-editing-api-reference +luma 200 46699 429 https://docs.agents.lumalabs.ai/guides/faq/index.md +luma 200 21765 429 https://docs.agents.lumalabs.ai/api/resources/generations/methods/create/index.md diff --git a/pipeline/provider_docs/google__ai.google.dev_api_generate-content b/pipeline/provider_docs/google__ai.google.dev_api_generate-content new file mode 100644 index 0000000000000000000000000000000000000000..d199bfdfb4de9f9b4ee3d28213d5b9c93b59c4b6 --- /dev/null +++ b/pipeline/provider_docs/google__ai.google.dev_api_generate-content @@ -0,0 +1,23490 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Generating content  |  Gemini API  |  Google AI for Developers + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + + +
        + + + + + + + + + + + + + + + + + +
          + +
        • + + + + + + +
          • + +
        +         + +
        +
        +
        + +
        + + +
        +
        + +
        + + + +
        +
        +
        + +         + +
        + + + + + + + + + + + + + + + + + + + + Get API key + + + + Cookbook + + + + Community + + + + + + + + + + + + + + + +
        +
        +
        + + + +
        +
        + + + + +
        + + + + + + + + + + + + +
        + +
        +
        + +
        + + + + + + +         + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + + + +
        +
        + + + + + + + + + + + + + +
        + + + + + + + + + + + + +

        + Generating content + + +

        +
        + + + + + + +
        + + + +

        The Gemini API supports content generation with images, audio, code, tools, and more. For details on each of these features, read on and check out the task-focused sample code, or read the comprehensive guides.

        + +

        Method: models.generateContent

        + + +
        + +
        +
        +
        +

        Generates a model response given an input GenerateContentRequest. Refer to the text generation guide for detailed usage information. Input capabilities differ between models, including tuned models. Refer to the model guide and tuning guide for details.

        +
        +
        +
        +
        +

        Endpoint

        + + + post + + +https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateContent + + +
        + + + +
        +
        +

        Path parameters

        +
        +
        +
        + +model + + +string + +
        +
        +

        Required. The name of the Model to use for generating the completion.

        Format: models/{model}. It takes the form models/{model}.

        +
        +
        +
        +
        +
        +

        Request body

        +

        The request body contains data with the following structure:

        +
        + + +Fields + + +
        +
        +
        + +contents[] + + +object (Content) + +
        +
        +

        Required. The content of the current conversation with the model.

        For single-turn queries, this is a single instance. For multi-turn queries like chat, this is a repeated field that contains the conversation history and the latest request.

        +
        +
        +
        +
        +
        +
        + +tools[] + + +object (Tool) + +
        +
        +

        Optional. A list of Tools the Model may use to generate the next response.

        A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the Model. Supported Tools are Function and codeExecution. Refer to the Function calling and the Code execution guides to learn more.

        +
        +
        +
        +
        +
        +
        + +toolConfig + + +object (ToolConfig) + +
        +
        +

        Optional. Tool configuration for any Tool specified in the request. Refer to the Function calling guide for a usage example.

        +
        +
        +
        +
        +
        +
        + +safetySettings[] + + +object (SafetySetting) + +
        +
        +

        Optional. A list of unique SafetySetting instances for blocking unsafe content.

        This will be enforced on the GenerateContentRequest.contents and GenerateContentResponse.candidates. There should not be more than one setting for each SafetyCategory type. The API will block any contents and responses that fail to meet the thresholds set by these settings. This list overrides the default settings for each SafetyCategory specified in the safetySettings. If there is no SafetySetting for a given SafetyCategory provided in the list, the API will use the default safety setting for that category. Harm categories HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY, HARM_CATEGORY_JAILBREAK are supported. Refer to the guide for detailed information on available safety settings. Also refer to the Safety guidance to learn how to incorporate safety considerations in your AI applications.

        +
        +
        +
        +
        +
        +
        + +continuationToken + + +string (bytes format) + +
        +
        +

        Optional. An opaque continuation token used to resume generation from a previous models.generateContent or models.streamGenerateContent response that stopped with finishReason set to CONTINUATION. Note that contents is mandatory and must identically replicate the prompt and conversation history from the initial request when continuation token is provided in a request.

        A base64-encoded string.

        +
        +
        +
        +
        +
        +
        + +labels + + +map (key: string, value: string) + +
        +
        +

        Optional. Labels with user-defined metadata for the request.

        Optional. Labels must follow standard unified Cloud label requirements: - Label keys must start with a letter. - Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. - International characters are allowed.

        Usage: - Safety identifiers from aggregators: Use the key safety_identifier (e.g. {"safety_identifier": "user_session_123"})

        An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

        +
        +
        +
        +
        +
        +
        + +systemInstruction + + +object (Content) + +
        +
        +

        Optional. Developer set system instruction(s). Currently, text only.

        +
        +
        +
        +
        +
        +
        + +generationConfig + + +object (GenerationConfig) + +
        +
        +

        Optional. Configuration options for model generation and outputs.

        +
        +
        +
        +
        +
        +
        + +cachedContent + + +string + +
        +
        +

        Optional. The name of the content cached to use as context to serve the prediction. Format: cachedContents/{cachedContent}

        +
        +
        +
        +
        +
        +
        + +serviceTier + + +enum (ServiceTier) + +
        +
        +

        Optional. The service tier of the request.

        +
        +
        +
        +
        +
        +
        + +store + + +boolean + +
        +
        +

        Optional. Configures the logging behavior for a given request. If set, it takes precedence over the project-level logging config.

        +
        +
        +
        +
        +
        +
        +
        +

        Example request

        + +
        +

        Text

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+
+client = genai.Client()
+response = client.models.generate_content(
+    model="gemini-3.8-flash",
+    contents="Write a story about a magic backpack.",
+)
+print(response.text)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+
+const response = await ai.models.generateContent({
+  model: 'gemini-3.8-flash',
+  contents: 'Write a story about a magic backpack.',
+});
+console.log(response.text);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+contents := []*genai.Content{
+	genai.NewContentFromText("Write a story about a magic backpack.", genai.RoleUser),
+}
+response, err := client.Models.GenerateContent(ctx, "gemini-3.8-flash", contents, nil)
+if err != nil {
+	log.Fatal(err)
+}
+printResponse(response)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d '{
+      "contents": [{
+        "parts":[{"text": "Write a story about a magic backpack."}]
+        }]
+       }' 2> /dev/null
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+GenerateContentResponse response =
+    client.models.generateContent(
+        "gemini-3.8-flash", "Write a story about a magic backpack.", null);
+
+System.out.println(response.text());
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Image

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+import PIL.Image
+
+client = genai.Client()
+organ = PIL.Image.open(media / "organ.jpg")
+response = client.models.generate_content(
+    model="gemini-3.8-flash",
+    contents=["Tell me about this instrument", organ],
+)
+print(response.text)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+
+const organ = await ai.files.upload({
+  file: path.join(media, 'organ.jpg'),
+});
+
+const response = await ai.models.generateContent({
+  model: 'gemini-3.8-flash',
+  contents: [
+    createUserContent([
+      'Tell me about this instrument',
+      createPartFromUri(organ.uri, organ.mimeType)
+    ]),
+  ],
+});
+console.log(response.text);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+file, err := client.Files.UploadFromPath(
+	ctx,
+	filepath.Join(getMedia(), "organ.jpg"),
+	&genai.UploadFileConfig{
+		MIMEType: "image/jpeg",
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+parts := []*genai.Part{
+	genai.NewPartFromText("Tell me about this instrument"),
+	genai.NewPartFromURI(file.URI, file.MIMEType),
+}
+contents := []*genai.Content{
+	genai.NewContentFromParts(parts, genai.RoleUser),
+}
+
+response, err := client.Models.GenerateContent(ctx, "gemini-3.8-flash", contents, nil)
+if err != nil {
+	log.Fatal(err)
+}
+printResponse(response)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        # Use a temporary file to hold the base64 encoded image data
+TEMP_B64=$(mktemp)
+trap 'rm -f "$TEMP_B64"' EXIT
+base64 $B64FLAGS $IMG_PATH > "$TEMP_B64"
+
+# Use a temporary file to hold the JSON payload
+TEMP_JSON=$(mktemp)
+trap 'rm -f "$TEMP_JSON"' EXIT
+
+cat > "$TEMP_JSON" << EOF
+{
+  "contents": [{
+    "parts":[
+      {"text": "Tell me about this instrument"},
+      {
+        "inline_data": {
+          "mime_type":"image/jpeg",
+          "data": "$(cat "$TEMP_B64")"
+        }
+      }
+    ]
+  }]
+}
+EOF
+
+curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d "@$TEMP_JSON" 2> /dev/null
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+String path = media_path + "organ.jpg";
+byte[] imageData = Files.readAllBytes(Paths.get(path));
+
+Content content =
+    Content.fromParts(
+        Part.fromText("Tell me about this instrument."),
+        Part.fromBytes(imageData, "image/jpeg"));
+
+GenerateContentResponse response =
+    client.models.generateContent("gemini-3.8-flash", content, null);
+
+System.out.println(response.text());
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Audio

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+
+client = genai.Client()
+sample_audio = client.files.upload(file=media / "sample.mp3")
+response = client.models.generate_content(
+    model="gemini-3.8-flash",
+    contents=["Give me a summary of this audio file.", sample_audio],
+)
+print(response.text)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+
+const audio = await ai.files.upload({
+  file: path.join(media, 'sample.mp3'),
+});
+
+const response = await ai.models.generateContent({
+  model: 'gemini-3.8-flash',
+  contents: [
+    createUserContent([
+      'Give me a summary of this audio file.',
+      createPartFromUri(audio.uri, audio.mimeType),
+    ]),
+  ],
+});
+console.log(response.text);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+file, err := client.Files.UploadFromPath(
+	ctx,
+	filepath.Join(getMedia(), "sample.mp3"),
+	&genai.UploadFileConfig{
+		MIMEType: "audio/mpeg",
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+
+parts := []*genai.Part{
+	genai.NewPartFromText("Give me a summary of this audio file."),
+	genai.NewPartFromURI(file.URI, file.MIMEType),
+}
+
+contents := []*genai.Content{
+	genai.NewContentFromParts(parts, genai.RoleUser),
+}
+
+response, err := client.Models.GenerateContent(ctx, "gemini-3.8-flash", contents, nil)
+if err != nil {
+	log.Fatal(err)
+}
+printResponse(response)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        # Use File API to upload audio data to API request.
+MIME_TYPE=$(file -b --mime-type "${AUDIO_PATH}")
+NUM_BYTES=$(wc -c < "${AUDIO_PATH}")
+DISPLAY_NAME=AUDIO
+
+tmp_header_file=upload-header.tmp
+
+# Initial resumable request defining metadata.
+# The upload url is in the response headers dump them to a file.
+curl "${BASE_URL}/upload/v1beta/files?key=${GEMINI_API_KEY}" \
+  -D upload-header.tmp \
+  -H "X-Goog-Upload-Protocol: resumable" \
+  -H "X-Goog-Upload-Command: start" \
+  -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \
+  -H "Content-Type: application/json" \
+  -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null
+
+upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r")
+rm "${tmp_header_file}"
+
+# Upload the actual bytes.
+curl "${upload_url}" \
+  -H "Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Offset: 0" \
+  -H "X-Goog-Upload-Command: upload, finalize" \
+  --data-binary "@${AUDIO_PATH}" 2> /dev/null > file_info.json
+
+file_uri=$(jq ".file.uri" file_info.json)
+echo file_uri=$file_uri
+
+curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d '{
+      "contents": [{
+        "parts":[
+          {"text": "Please describe this file."},
+          {"file_data":{"mime_type": "audio/mpeg", "file_uri": '$file_uri'}}]
+        }]
+       }' 2> /dev/null > response.json
+
+cat response.json
+echo
+
+jq ".candidates[].content.parts[].text" response.json
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Video

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+import time
+
+client = genai.Client()
+# Video clip (CC BY 3.0) from https://peach.blender.org/download/
+myfile = client.files.upload(file=media / "Big_Buck_Bunny.mp4")
+print(f"{myfile=}")
+
+# Poll until the video file is completely processed (state becomes ACTIVE).
+while not myfile.state or myfile.state.name != "ACTIVE":
+  print("Processing video...")
+  print("File state:", myfile.state)
+  time.sleep(5)
+  myfile = client.files.get(name=myfile.name)
+
+response = client.models.generate_content(
+    model="gemini-3.8-flash", contents=[myfile, "Describe this video clip"]
+)
+print(f"{response.text=}")
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+
+let video = await ai.files.upload({
+  file: path.join(media, 'Big_Buck_Bunny.mp4'),
+});
+
+// Poll until the video file is completely processed (state becomes ACTIVE).
+while (!video.state || video.state.toString() !== 'ACTIVE') {
+  console.log('Processing video...');
+  console.log('File state: ', video.state);
+  await sleep(5000);
+  video = await ai.files.get({name: video.name});
+}
+
+const response = await ai.models.generateContent({
+  model: 'gemini-3.8-flash',
+  contents: [
+    createUserContent([
+      'Describe this video clip',
+      createPartFromUri(video.uri, video.mimeType),
+    ]),
+  ],
+});
+console.log(response.text);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+file, err := client.Files.UploadFromPath(
+	ctx,
+	filepath.Join(getMedia(), "Big_Buck_Bunny.mp4"),
+	&genai.UploadFileConfig{
+		MIMEType: "video/mp4",
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+
+// Poll until the video file is completely processed (state becomes ACTIVE).
+for file.State == genai.FileStateUnspecified || file.State != genai.FileStateActive {
+	fmt.Println("Processing video...")
+	fmt.Println("File state:", file.State)
+	time.Sleep(5 * time.Second)
+
+	file, err = client.Files.Get(ctx, file.Name, nil)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+
+parts := []*genai.Part{
+	genai.NewPartFromText("Describe this video clip"),
+	genai.NewPartFromURI(file.URI, file.MIMEType),
+}
+
+contents := []*genai.Content{
+	genai.NewContentFromParts(parts, genai.RoleUser),
+}
+
+response, err := client.Models.GenerateContent(ctx, "gemini-3.8-flash", contents, nil)
+if err != nil {
+	log.Fatal(err)
+}
+printResponse(response)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        # Use File API to upload audio data to API request.
+MIME_TYPE=$(file -b --mime-type "${VIDEO_PATH}")
+NUM_BYTES=$(wc -c < "${VIDEO_PATH}")
+DISPLAY_NAME=VIDEO
+
+# Initial resumable request defining metadata.
+# The upload url is in the response headers dump them to a file.
+curl "${BASE_URL}/upload/v1beta/files?key=${GEMINI_API_KEY}" \
+  -D "${tmp_header_file}" \
+  -H "X-Goog-Upload-Protocol: resumable" \
+  -H "X-Goog-Upload-Command: start" \
+  -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \
+  -H "Content-Type: application/json" \
+  -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null
+
+upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r")
+rm "${tmp_header_file}"
+
+# Upload the actual bytes.
+curl "${upload_url}" \
+  -H "Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Offset: 0" \
+  -H "X-Goog-Upload-Command: upload, finalize" \
+  --data-binary "@${VIDEO_PATH}" 2> /dev/null > file_info.json
+
+file_uri=$(jq ".file.uri" file_info.json)
+echo file_uri=$file_uri
+
+state=$(jq ".file.state" file_info.json)
+echo state=$state
+
+name=$(jq ".file.name" file_info.json)
+echo name=$name
+
+while [[ "($state)" = *"PROCESSING"* ]];
+do
+  echo "Processing video..."
+  sleep 5
+  # Get the file of interest to check state
+  curl https://generativelanguage.googleapis.com/v1beta/files/$name > file_info.json
+  state=$(jq ".file.state" file_info.json)
+done
+
+curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d '{
+      "contents": [{
+        "parts":[
+          {"text": "Transcribe the audio from this video, giving timestamps for salient events in the video. Also provide visual descriptions."},
+          {"file_data":{"mime_type": "video/mp4", "file_uri": '$file_uri'}}]
+        }]
+       }' 2> /dev/null > response.json
+
+cat response.json
+echo
+
+jq ".candidates[].content.parts[].text" response.json
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        PDF

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+
+client = genai.Client()
+sample_pdf = client.files.upload(file=media / "test.pdf")
+response = client.models.generate_content(
+    model="gemini-3.8-flash",
+    contents=["Give me a summary of this document:", sample_pdf],
+)
+print(f"{response.text=}")
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+file, err := client.Files.UploadFromPath(
+	ctx,
+	filepath.Join(getMedia(), "test.pdf"),
+	&genai.UploadFileConfig{
+		MIMEType: "application/pdf",
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+
+parts := []*genai.Part{
+	genai.NewPartFromText("Give me a summary of this document:"),
+	genai.NewPartFromURI(file.URI, file.MIMEType),
+}
+
+contents := []*genai.Content{
+	genai.NewContentFromParts(parts, genai.RoleUser),
+}
+
+response, err := client.Models.GenerateContent(ctx, "gemini-3.8-flash", contents, nil)
+if err != nil {
+	log.Fatal(err)
+}
+printResponse(response)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        MIME_TYPE=$(file -b --mime-type "${PDF_PATH}")
+NUM_BYTES=$(wc -c < "${PDF_PATH}")
+DISPLAY_NAME=TEXT
+
+
+echo $MIME_TYPE
+tmp_header_file=upload-header.tmp
+
+# Initial resumable request defining metadata.
+# The upload url is in the response headers dump them to a file.
+curl "${BASE_URL}/upload/v1beta/files?key=${GEMINI_API_KEY}" \
+  -D upload-header.tmp \
+  -H "X-Goog-Upload-Protocol: resumable" \
+  -H "X-Goog-Upload-Command: start" \
+  -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \
+  -H "Content-Type: application/json" \
+  -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null
+
+upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r")
+rm "${tmp_header_file}"
+
+# Upload the actual bytes.
+curl "${upload_url}" \
+  -H "Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Offset: 0" \
+  -H "X-Goog-Upload-Command: upload, finalize" \
+  --data-binary "@${PDF_PATH}" 2> /dev/null > file_info.json
+
+file_uri=$(jq ".file.uri" file_info.json)
+echo file_uri=$file_uri
+
+# Now generate content using that file
+curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d '{
+      "contents": [{
+        "parts":[
+          {"text": "Can you add a few more lines to this poem?"},
+          {"file_data":{"mime_type": "application/pdf", "file_uri": '$file_uri'}}]
+        }]
+       }' 2> /dev/null > response.json
+
+cat response.json
+echo
+
+jq ".candidates[].content.parts[].text" response.json
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Chat

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+from google.genai import types
+
+client = genai.Client()
+# Pass initial history using the "history" argument
+chat = client.chats.create(
+    model="gemini-3.8-flash",
+    history=[
+        types.Content(role="user", parts=[types.Part(text="Hello")]),
+        types.Content(
+            role="model",
+            parts=[
+                types.Part(
+                    text="Great to meet you. What would you like to know?"
+                )
+            ],
+        ),
+    ],
+)
+response = chat.send_message(message="I have 2 dogs in my house.")
+print(response.text)
+response = chat.send_message(message="How many paws are in my house?")
+print(response.text)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+const chat = ai.chats.create({
+  model: 'gemini-3.8-flash',
+  history: [
+    {
+      role: 'user',
+      parts: [{text: 'Hello'}],
+    },
+    {
+      role: 'model',
+      parts: [{text: 'Great to meet you. What would you like to know?'}],
+    },
+  ],
+});
+
+const response1 = await chat.sendMessage({
+  message: 'I have 2 dogs in my house.',
+});
+console.log('Chat response 1:', response1.text);
+
+const response2 = await chat.sendMessage({
+  message: 'How many paws are in my house?',
+});
+console.log('Chat response 2:', response2.text);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+// Pass initial history using the History field.
+history := []*genai.Content{
+	genai.NewContentFromText("Hello", genai.RoleUser),
+	genai.NewContentFromText("Great to meet you. What would you like to know?", genai.RoleModel),
+}
+
+chat, err := client.Chats.Create(ctx, "gemini-3.8-flash", nil, history)
+if err != nil {
+	log.Fatal(err)
+}
+
+firstResp, err := chat.SendMessage(ctx, genai.Part{Text: "I have 2 dogs in my house."})
+if err != nil {
+	log.Fatal(err)
+}
+fmt.Println(firstResp.Text())
+
+secondResp, err := chat.SendMessage(ctx, genai.Part{Text: "How many paws are in my house?"})
+if err != nil {
+	log.Fatal(err)
+}
+fmt.Println(secondResp.Text())
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        curl https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d '{
+      "contents": [
+        {"role":"user",
+         "parts":[{
+           "text": "Hello"}]},
+        {"role": "model",
+         "parts":[{
+           "text": "Great to meet you. What would you like to know?"}]},
+        {"role":"user",
+         "parts":[{
+           "text": "I have two dogs in my house. How many paws are in my house?"}]},
+      ]
+    }' 2> /dev/null | grep "text"
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+Content userContent = Content.fromParts(Part.fromText("Hello"));
+Content modelContent =
+    Content.builder()
+        .role("model")
+        .parts(
+            Collections.singletonList(
+                Part.fromText("Great to meet you. What would you like to know?")))
+        .build();
+
+Chat chat =
+    client.chats.create(
+        "gemini-3.8-flash",
+        GenerateContentConfig.builder()
+            .systemInstruction(userContent)
+            .systemInstruction(modelContent)
+            .build());
+
+GenerateContentResponse response1 = chat.sendMessage("I have 2 dogs in my house.");
+System.out.println(response1.text());
+
+GenerateContentResponse response2 = chat.sendMessage("How many paws are in my house?");
+System.out.println(response2.text());
+
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Cache

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+from google.genai import types
+
+client = genai.Client()
+document = client.files.upload(file=media / "a11.txt")
+model_name = "gemini-3.8-flash"
+
+cache = client.caches.create(
+    model=model_name,
+    config=types.CreateCachedContentConfig(
+        contents=[document],
+        system_instruction="You are an expert analyzing transcripts.",
+    ),
+)
+print(cache)
+
+response = client.models.generate_content(
+    model=model_name,
+    contents="Please summarize this transcript",
+    config=types.GenerateContentConfig(cached_content=cache.name),
+)
+print(response.text)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+const filePath = path.join(media, 'a11.txt');
+const document = await ai.files.upload({
+  file: filePath,
+  config: {mimeType: 'text/plain'},
+});
+console.log('Uploaded file name:', document.name);
+const modelName = 'gemini-3.8-flash';
+
+const contents = [
+  createUserContent(createPartFromUri(document.uri, document.mimeType)),
+];
+
+const cache = await ai.caches.create({
+  model: modelName,
+  config: {
+    contents: contents,
+    systemInstruction: 'You are an expert analyzing transcripts.',
+  },
+});
+console.log('Cache created:', cache);
+
+const response = await ai.models.generateContent({
+  model: modelName,
+  contents: 'Please summarize this transcript',
+  config: {cachedContent: cache.name},
+});
+console.log('Response text:', response.text);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+modelName := "gemini-3.8-flash"
+document, err := client.Files.UploadFromPath(
+	ctx,
+	filepath.Join(getMedia(), "a11.txt"),
+	&genai.UploadFileConfig{
+		MIMEType: "text/plain",
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+parts := []*genai.Part{
+	genai.NewPartFromURI(document.URI, document.MIMEType),
+}
+contents := []*genai.Content{
+	genai.NewContentFromParts(parts, genai.RoleUser),
+}
+cache, err := client.Caches.Create(ctx, modelName, &genai.CreateCachedContentConfig{
+	Contents: contents,
+	SystemInstruction: genai.NewContentFromText(
+		"You are an expert analyzing transcripts.", genai.RoleUser,
+	),
+})
+if err != nil {
+	log.Fatal(err)
+}
+fmt.Println("Cache created:")
+fmt.Println(cache)
+
+// Use the cache for generating content.
+response, err := client.Models.GenerateContent(
+	ctx,
+	modelName,
+	genai.Text("Please summarize this transcript"),
+	&genai.GenerateContentConfig{
+		CachedContent: cache.Name,
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+printResponse(response)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Tuned Model

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        # With Gemini 2 we're launching a new SDK. See the following doc for details.
+# https://ai.google.dev/gemini-api/docs/migrate
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        JSON Mode

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+from google.genai import types
+from typing_extensions import TypedDict
+
+class Recipe(TypedDict):
+  recipe_name: str
+  ingredients: list[str]
+
+client = genai.Client()
+result = client.models.generate_content(
+    model="gemini-3.8-flash",
+    contents="List a few popular cookie recipes.",
+    config=types.GenerateContentConfig(
+        response_mime_type="application/json", response_schema=list[Recipe]
+    ),
+)
+print(result)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+const response = await ai.models.generateContent({
+  model: 'gemini-3.8-flash',
+  contents: 'List a few popular cookie recipes.',
+  config: {
+    responseMimeType: 'application/json',
+    responseSchema: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          recipeName: {type: 'string'},
+          ingredients: {type: 'array', items: {type: 'string'}},
+        },
+        required: ['recipeName', 'ingredients'],
+      },
+    },
+  },
+});
+console.log(response.text);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+schema := &genai.Schema{
+	Type: genai.TypeArray,
+	Items: &genai.Schema{
+		Type: genai.TypeObject,
+		Properties: map[string]*genai.Schema{
+			"recipe_name": {Type: genai.TypeString},
+			"ingredients": {
+				Type:  genai.TypeArray,
+				Items: &genai.Schema{Type: genai.TypeString},
+			},
+		},
+		Required: []string{"recipe_name"},
+	},
+}
+
+config := &genai.GenerateContentConfig{
+	ResponseMIMEType: "application/json",
+	ResponseSchema:   schema,
+}
+
+response, err := client.Models.GenerateContent(
+	ctx,
+	"gemini-3.8-flash",
+	genai.Text("List a few popular cookie recipes."),
+	config,
+)
+if err != nil {
+	log.Fatal(err)
+}
+printResponse(response)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY" \
+-H 'Content-Type: application/json' \
+-d '{
+    "contents": [{
+      "parts":[
+        {"text": "List 5 popular cookie recipes"}
+        ]
+    }],
+    "generationConfig": {
+        "response_mime_type": "application/json",
+        "response_schema": {
+          "type": "ARRAY",
+          "items": {
+            "type": "OBJECT",
+            "properties": {
+              "recipe_name": {"type":"STRING"},
+            }
+          }
+        }
+    }
+}' 2> /dev/null | head
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+Schema recipeSchema =
+    Schema.builder()
+        .type(Array.class.getSimpleName())
+        .items(
+            Schema.builder()
+                .type(Object.class.getSimpleName())
+                .properties(
+                    Map.of(
+                        "recipe_name",
+                        Schema.builder().type(String.class.getSimpleName()).build(),
+                        "ingredients",
+                        Schema.builder()
+                            .type(Array.class.getSimpleName())
+                            .items(Schema.builder().type(String.class.getSimpleName()).build())
+                            .build()))
+                .required(List.of("recipe_name", "ingredients"))
+                .build())
+        .build();
+
+GenerateContentConfig config =
+    GenerateContentConfig.builder()
+        .responseMimeType("application/json")
+        .responseSchema(recipeSchema)
+        .build();
+
+GenerateContentResponse response =
+    client.models.generateContent(
+        "gemini-3.8-flash", "List a few popular cookie recipes.", config);
+
+System.out.println(response.text());
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Code execution

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+from google.genai import types
+
+client = genai.Client()
+response = client.models.generate_content(
+    model="gemini-3.8-flash",
+    contents=(
+        "Write and execute code that calculates the sum of the first 50"
+        " prime numbers. Ensure that only the executable code and its"
+        " resulting output are generated."
+    ),
+)
+# Each part may contain text, executable code, or an execution result.
+for part in response.candidates[0].content.parts:
+  print(part, "\n")
+
+print("-" * 80)
+# The .text accessor concatenates the parts into a markdown-formatted text.
+print("\n", response.text)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+response, err := client.Models.GenerateContent(
+	ctx,
+	"gemini-3.8-flash",
+	genai.Text(
+		`Write and execute code that calculates the sum of the first 50 prime numbers.
+		 Ensure that only the executable code and its resulting output are generated.`,
+	),
+	&genai.GenerateContentConfig{},
+)
+if err != nil {
+	log.Fatal(err)
+}
+
+// Print the response.
+printResponse(response)
+
+fmt.Println("--------------------------------------------------------------------------------")
+fmt.Println(response.Text())
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+String prompt =
+    """
+    Write and execute code that calculates the sum of the first 50 prime numbers.
+    Ensure that only the executable code and its resulting output are generated.
+    """;
+
+GenerateContentResponse response =
+    client.models.generateContent("gemini-3.8-flash", prompt, null);
+
+for (Part part : response.candidates().get().getFirst().content().get().parts().get()) {
+  System.out.println(part + "\n");
+}
+
+System.out.println("-".repeat(80));
+System.out.println(response.text());
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Function Calling

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+from google.genai import types
+
+client = genai.Client()
+
+def add(a: float, b: float) -> float:
+  """returns a + b."""
+  return a + b
+
+def subtract(a: float, b: float) -> float:
+  """returns a - b."""
+  return a - b
+
+def multiply(a: float, b: float) -> float:
+  """returns a * b."""
+  return a * b
+
+def divide(a: float, b: float) -> float:
+  """returns a / b."""
+  return a / b
+
+# Create a chat session; function calling (via tools) is enabled in the config.
+chat = client.chats.create(
+    model="gemini-3.8-flash",
+    config=types.GenerateContentConfig(
+        tools=[add, subtract, multiply, divide]
+    ),
+)
+response = chat.send_message(
+    message=(
+        "I have 57 cats, each owns 44 mittens, how many mittens is that in"
+        " total?"
+    )
+)
+print(response.text)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+modelName := "gemini-3.8-flash"
+
+// Create the function declarations for arithmetic operations.
+addDeclaration := createArithmeticToolDeclaration("addNumbers", "Return the result of adding two numbers.")
+subtractDeclaration := createArithmeticToolDeclaration("subtractNumbers", "Return the result of subtracting the second number from the first.")
+multiplyDeclaration := createArithmeticToolDeclaration("multiplyNumbers", "Return the product of two numbers.")
+divideDeclaration := createArithmeticToolDeclaration("divideNumbers", "Return the quotient of dividing the first number by the second.")
+
+// Group the function declarations as a tool.
+tools := []*genai.Tool{
+	{
+		FunctionDeclarations: []*genai.FunctionDeclaration{
+			addDeclaration,
+			subtractDeclaration,
+			multiplyDeclaration,
+			divideDeclaration,
+		},
+	},
+}
+
+// Create the content prompt.
+contents := []*genai.Content{
+	genai.NewContentFromText(
+		"I have 57 cats, each owns 44 mittens, how many mittens is that in total?", genai.RoleUser,
+	),
+}
+
+// Set up the generate content configuration with function calling enabled.
+config := &genai.GenerateContentConfig{
+	Tools: tools,
+	ToolConfig: &genai.ToolConfig{
+		FunctionCallingConfig: &genai.FunctionCallingConfig{
+			// The mode equivalent to FunctionCallingConfigMode.ANY in JS.
+			Mode: genai.FunctionCallingConfigModeAny,
+		},
+	},
+}
+
+genContentResp, err := client.Models.GenerateContent(ctx, modelName, contents, config)
+if err != nil {
+	log.Fatal(err)
+}
+
+// Assume the response includes a list of function calls.
+if len(genContentResp.FunctionCalls()) == 0 {
+	log.Println("No function call returned from the AI.")
+	return nil
+}
+functionCall := genContentResp.FunctionCalls()[0]
+log.Printf("Function call: %+v\n", functionCall)
+
+// Marshal the Args map into JSON bytes.
+argsMap, err := json.Marshal(functionCall.Args)
+if err != nil {
+	log.Fatal(err)
+}
+
+// Unmarshal the JSON bytes into the ArithmeticArgs struct.
+var args ArithmeticArgs
+if err := json.Unmarshal(argsMap, &args); err != nil {
+	log.Fatal(err)
+}
+
+// Map the function name to the actual arithmetic function.
+var result float64
+switch functionCall.Name {
+case "addNumbers":
+	result = add(args.FirstParam, args.SecondParam)
+case "subtractNumbers":
+	result = subtract(args.FirstParam, args.SecondParam)
+case "multiplyNumbers":
+	result = multiply(args.FirstParam, args.SecondParam)
+case "divideNumbers":
+	result = divide(args.FirstParam, args.SecondParam)
+default:
+	return fmt.Errorf("unimplemented function: %s", functionCall.Name)
+}
+log.Printf("Function result: %v\n", result)
+
+// Prepare the final result message as content.
+resultContents := []*genai.Content{
+	genai.NewContentFromText("The final result is "+fmt.Sprintf("%v", result), genai.RoleUser),
+}
+
+// Use GenerateContent to send the final result.
+finalResponse, err := client.Models.GenerateContent(ctx, modelName, resultContents, &genai.GenerateContentConfig{})
+if err != nil {
+	log.Fatal(err)
+}
+
+printResponse(finalResponse)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+
+/**
+ * The add function returns the sum of two numbers.
+ * @param {number} a
+ * @param {number} b
+ * @returns {number}
+ */
+function add(a, b) {
+  return a + b;
+}
+
+/**
+ * The subtract function returns the difference (a - b).
+ * @param {number} a
+ * @param {number} b
+ * @returns {number}
+ */
+function subtract(a, b) {
+  return a - b;
+}
+
+/**
+ * The multiply function returns the product of two numbers.
+ * @param {number} a
+ * @param {number} b
+ * @returns {number}
+ */
+function multiply(a, b) {
+  return a * b;
+}
+
+/**
+ * The divide function returns the quotient of a divided by b.
+ * @param {number} a
+ * @param {number} b
+ * @returns {number}
+ */
+function divide(a, b) {
+  return a / b;
+}
+
+const addDeclaration = {
+  name: 'addNumbers',
+  parameters: {
+    type: 'object',
+    description: 'Return the result of adding two numbers.',
+    properties: {
+      firstParam: {
+        type: 'number',
+        description:
+            'The first parameter which can be an integer or a floating point number.',
+      },
+      secondParam: {
+        type: 'number',
+        description:
+            'The second parameter which can be an integer or a floating point number.',
+      },
+    },
+    required: ['firstParam', 'secondParam'],
+  },
+};
+
+const subtractDeclaration = {
+  name: 'subtractNumbers',
+  parameters: {
+    type: 'object',
+    description:
+        'Return the result of subtracting the second number from the first.',
+    properties: {
+      firstParam: {
+        type: 'number',
+        description: 'The first parameter.',
+      },
+      secondParam: {
+        type: 'number',
+        description: 'The second parameter.',
+      },
+    },
+    required: ['firstParam', 'secondParam'],
+  },
+};
+
+const multiplyDeclaration = {
+  name: 'multiplyNumbers',
+  parameters: {
+    type: 'object',
+    description: 'Return the product of two numbers.',
+    properties: {
+      firstParam: {
+        type: 'number',
+        description: 'The first parameter.',
+      },
+      secondParam: {
+        type: 'number',
+        description: 'The second parameter.',
+      },
+    },
+    required: ['firstParam', 'secondParam'],
+  },
+};
+
+const divideDeclaration = {
+  name: 'divideNumbers',
+  parameters: {
+    type: 'object',
+    description:
+        'Return the quotient of dividing the first number by the second.',
+    properties: {
+      firstParam: {
+        type: 'number',
+        description: 'The first parameter.',
+      },
+      secondParam: {
+        type: 'number',
+        description: 'The second parameter.',
+      },
+    },
+    required: ['firstParam', 'secondParam'],
+  },
+};
+
+// Step 1: Call generateContent with function calling enabled.
+const generateContentResponse = await ai.models.generateContent({
+  model: 'gemini-3.8-flash',
+  contents:
+      'I have 57 cats, each owns 44 mittens, how many mittens is that in total?',
+  config: {
+    toolConfig: {
+      functionCallingConfig: {
+        mode: FunctionCallingConfigMode.ANY,
+      },
+    },
+    tools: [
+      {
+        functionDeclarations: [
+          addDeclaration,
+          subtractDeclaration,
+          multiplyDeclaration,
+          divideDeclaration,
+        ],
+      },
+    ],
+  },
+});
+
+// Step 2: Extract the function call.(
+// Assuming the response contains a 'functionCalls' array.
+const functionCall = generateContentResponse.functionCalls &&
+    generateContentResponse.functionCalls[0];
+console.log(functionCall);
+
+// Parse the arguments.
+const args = functionCall.args;
+// Expected args format: { firstParam: number, secondParam: number }
+
+// Step 3: Invoke the actual function based on the function name.
+const functionMapping = {
+  addNumbers: add,
+  subtractNumbers: subtract,
+  multiplyNumbers: multiply,
+  divideNumbers: divide,
+};
+const func = functionMapping[functionCall.name];
+if (!func) {
+  console.error('Unimplemented error:', functionCall.name);
+  return generateContentResponse;
+}
+const resultValue = func(args.firstParam, args.secondParam);
+console.log('Function result:', resultValue);
+
+// Step 4: Use the chat API to send the result as the final answer.
+const chat = ai.chats.create({model: 'gemini-3.8-flash'});
+const chatResponse = await chat.sendMessage({
+  message: 'The final result is ' + resultValue,
+});
+console.log(chatResponse.text);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        
+cat > tools.json << EOF
+{
+  "function_declarations": [
+    {
+      "name": "enable_lights",
+      "description": "Turn on the lighting system."
+    },
+    {
+      "name": "set_light_color",
+      "description": "Set the light color. Lights must be enabled for this to work.",
+      "parameters": {
+        "type": "object",
+        "properties": {
+          "rgb_hex": {
+            "type": "string",
+            "description": "The light color as a 6-digit hex string, e.g. ff0000 for red."
+          }
+        },
+        "required": [
+          "rgb_hex"
+        ]
+      }
+    },
+    {
+      "name": "stop_lights",
+      "description": "Turn off the lighting system."
+    }
+  ]
+} 
+EOF
+
+curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY" \
+  -H 'Content-Type: application/json' \
+  -d @<(echo '
+  {
+    "system_instruction": {
+      "parts": {
+        "text": "You are a helpful lighting system bot. You can turn lights on and off, and you can set the color. Do not perform any other tasks."
+      }
+    },
+    "tools": ['$(cat tools.json)'],
+
+    "tool_config": {
+      "function_calling_config": {"mode": "auto"}
+    },
+
+    "contents": {
+      "role": "user",
+      "parts": {
+        "text": "Turn on the lights please."
+      }
+    }
+  }
+') 2>/dev/null |sed -n '/"content"/,/"finishReason"/p'
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+FunctionDeclaration addFunction =
+    FunctionDeclaration.builder()
+        .name("addNumbers")
+        .parameters(
+            Schema.builder()
+                .type("object")
+                .properties(
+                    Map.of(
+                        "firstParam",
+                            Schema.builder().type("number").description("First number").build(),
+                        "secondParam",
+                            Schema.builder()
+                                .type("number")
+                                .description("Second number")
+                                .build()))
+                .required(Arrays.asList("firstParam", "secondParam"))
+                .build())
+        .build();
+
+FunctionDeclaration subtractFunction =
+    FunctionDeclaration.builder()
+        .name("subtractNumbers")
+        .parameters(
+            Schema.builder()
+                .type("object")
+                .properties(
+                    Map.of(
+                        "firstParam",
+                            Schema.builder().type("number").description("First number").build(),
+                        "secondParam",
+                            Schema.builder()
+                                .type("number")
+                                .description("Second number")
+                                .build()))
+                .required(Arrays.asList("firstParam", "secondParam"))
+                .build())
+        .build();
+
+FunctionDeclaration multiplyFunction =
+    FunctionDeclaration.builder()
+        .name("multiplyNumbers")
+        .parameters(
+            Schema.builder()
+                .type("object")
+                .properties(
+                    Map.of(
+                        "firstParam",
+                            Schema.builder().type("number").description("First number").build(),
+                        "secondParam",
+                            Schema.builder()
+                                .type("number")
+                                .description("Second number")
+                                .build()))
+                .required(Arrays.asList("firstParam", "secondParam"))
+                .build())
+        .build();
+
+FunctionDeclaration divideFunction =
+    FunctionDeclaration.builder()
+        .name("divideNumbers")
+        .parameters(
+            Schema.builder()
+                .type("object")
+                .properties(
+                    Map.of(
+                        "firstParam",
+                            Schema.builder().type("number").description("First number").build(),
+                        "secondParam",
+                            Schema.builder()
+                                .type("number")
+                                .description("Second number")
+                                .build()))
+                .required(Arrays.asList("firstParam", "secondParam"))
+                .build())
+        .build();
+
+GenerateContentConfig config =
+    GenerateContentConfig.builder()
+        .toolConfig(
+            ToolConfig.builder()
+                .functionCallingConfig(FunctionCallingConfig.builder().mode("ANY").build())
+                .build())
+        .tools(
+            Collections.singletonList(
+                Tool.builder()
+                    .functionDeclarations(
+                        Arrays.asList(
+                            addFunction, subtractFunction, divideFunction, multiplyFunction))
+                    .build()))
+        .build();
+
+GenerateContentResponse response =
+    client.models.generateContent(
+        "gemini-3.8-flash",
+        "I have 57 cats, each owns 44 mittens, how many mittens is that in total?",
+        config);
+
+if (response.functionCalls() == null || response.functionCalls().isEmpty()) {
+  System.err.println("No function call received");
+  return null;
+}
+
+var functionCall = response.functionCalls().getFirst();
+String functionName = functionCall.name().get();
+var arguments = functionCall.args();
+
+Map<String, BiFunction<Double, Double, Double>> functionMapping = new HashMap<>();
+functionMapping.put("addNumbers", (a, b) -> a + b);
+functionMapping.put("subtractNumbers", (a, b) -> a - b);
+functionMapping.put("multiplyNumbers", (a, b) -> a * b);
+functionMapping.put("divideNumbers", (a, b) -> b != 0 ? a / b : Double.NaN);
+
+BiFunction<Double, Double, Double> function = functionMapping.get(functionName);
+
+Number firstParam = (Number) arguments.get().get("firstParam");
+Number secondParam = (Number) arguments.get().get("secondParam");
+Double result = function.apply(firstParam.doubleValue(), secondParam.doubleValue());
+
+System.out.println(result);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Generation config

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+from google.genai import types
+
+client = genai.Client()
+response = client.models.generate_content(
+    model="gemini-3.8-flash",
+    contents="Tell me a story about a magic backpack.",
+    config=types.GenerateContentConfig(
+        candidate_count=1,
+        stop_sequences=["x"],
+        max_output_tokens=20,
+        temperature=1.0,
+    ),
+)
+print(response.text)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+
+const response = await ai.models.generateContent({
+  model: 'gemini-3.8-flash',
+  contents: 'Tell me a story about a magic backpack.',
+  config: {
+    candidateCount: 1,
+    stopSequences: ['x'],
+    maxOutputTokens: 20,
+    temperature: 1.0,
+  },
+});
+
+console.log(response.text);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+// Create local variables for parameters.
+candidateCount := int32(1)
+maxOutputTokens := int32(20)
+temperature := float32(1.0)
+
+response, err := client.Models.GenerateContent(
+	ctx,
+	"gemini-3.8-flash",
+	genai.Text("Tell me a story about a magic backpack."),
+	&genai.GenerateContentConfig{
+		CandidateCount:  candidateCount,
+		StopSequences:   []string{"x"},
+		MaxOutputTokens: maxOutputTokens,
+		Temperature:     &temperature,
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+
+printResponse(response)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        curl https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d '{
+        "contents": [{
+            "parts":[
+                {"text": "Explain how AI works"}
+            ]
+        }],
+        "generationConfig": {
+            "stopSequences": [
+                "Title"
+            ],
+            "temperature": 1.0,
+            "maxOutputTokens": 800,
+            "topP": 0.8,
+            "topK": 10
+        }
+    }'  2> /dev/null | grep "text"
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+GenerateContentConfig config =
+    GenerateContentConfig.builder()
+        .candidateCount(1)
+        .stopSequences(List.of("x"))
+        .maxOutputTokens(20)
+        .temperature(1.0F)
+        .build();
+
+GenerateContentResponse response =
+    client.models.generateContent(
+        "gemini-3.8-flash", "Tell me a story about a magic backpack.", config);
+
+System.out.println(response.text());
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Safety Settings

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+from google.genai import types
+
+client = genai.Client()
+unsafe_prompt = (
+    "I support Martians Soccer Club and I think Jupiterians Football Club"
+    " sucks! Write a ironic phrase about them including expletives."
+)
+response = client.models.generate_content(
+    model="gemini-3.8-flash",
+    contents=unsafe_prompt,
+    config=types.GenerateContentConfig(
+        safety_settings=[
+            types.SafetySetting(
+                category="HARM_CATEGORY_HATE_SPEECH",
+                threshold="BLOCK_MEDIUM_AND_ABOVE",
+            ),
+            types.SafetySetting(
+                category="HARM_CATEGORY_HARASSMENT",
+                threshold="BLOCK_ONLY_HIGH",
+            ),
+        ]
+    ),
+)
+try:
+  print(response.text)
+except Exception:
+  print("No information generated by the model.")
+
+print(response.candidates[0].safety_ratings)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+const unsafePrompt =
+    'I support Martians Soccer Club and I think Jupiterians Football Club sucks! Write a ironic phrase about them including expletives.';
+
+const response = await ai.models.generateContent({
+  model: 'gemini-3.8-flash',
+  contents: unsafePrompt,
+  config: {
+    safetySettings: [
+      {
+        category: 'HARM_CATEGORY_HATE_SPEECH',
+        threshold: 'BLOCK_MEDIUM_AND_ABOVE',
+      },
+      {
+        category: 'HARM_CATEGORY_HARASSMENT',
+        threshold: 'BLOCK_ONLY_HIGH',
+      },
+    ],
+  },
+});
+
+try {
+  console.log('Generated text:', response.text);
+} catch (error) {
+  console.log('No information generated by the model.');
+}
+console.log('Safety ratings:', response.candidates[0].safetyRatings);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+unsafePrompt := "I support Martians Soccer Club and I think Jupiterians Football Club sucks! " +
+	"Write a ironic phrase about them including expletives."
+
+config := &genai.GenerateContentConfig{
+	SafetySettings: []*genai.SafetySetting{
+		{
+			Category:  "HARM_CATEGORY_HATE_SPEECH",
+			Threshold: "BLOCK_MEDIUM_AND_ABOVE",
+		},
+		{
+			Category:  "HARM_CATEGORY_HARASSMENT",
+			Threshold: "BLOCK_ONLY_HIGH",
+		},
+	},
+}
+contents := []*genai.Content{
+	genai.NewContentFromText(unsafePrompt, genai.RoleUser),
+}
+response, err := client.Models.GenerateContent(ctx, "gemini-3.8-flash", contents, config)
+if err != nil {
+	log.Fatal(err)
+}
+
+// Print the generated text.
+text := response.Text()
+fmt.Println("Generated text:", text)
+
+// Print the and safety ratings from the first candidate.
+if len(response.Candidates) > 0 {
+	fmt.Println("Finish reason:", response.Candidates[0].FinishReason)
+	safetyRatings, err := json.MarshalIndent(response.Candidates[0].SafetyRatings, "", "  ")
+	if err != nil {
+		return err
+	}
+	fmt.Println("Safety ratings:", string(safetyRatings))
+} else {
+	fmt.Println("No candidate returned.")
+}
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        echo '{
+    "safetySettings": [
+        {"category": "HARM_CATEGORY_HARASSMENT", "threshold": "BLOCK_ONLY_HIGH"},
+        {"category": "HARM_CATEGORY_HATE_SPEECH", "threshold": "BLOCK_MEDIUM_AND_ABOVE"}
+    ],
+    "contents": [{
+        "parts":[{
+            "text": "'I support Martians Soccer Club and I think Jupiterians Football Club sucks! Write a ironic phrase about them.'"}]}]}' > request.json
+
+curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d @request.json 2> /dev/null
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+String unsafePrompt =
+    """
+     I support Martians Soccer Club and I think Jupiterians Football Club sucks!
+     Write a ironic phrase about them including expletives.
+    """;
+
+GenerateContentConfig config =
+    GenerateContentConfig.builder()
+        .safetySettings(
+            Arrays.asList(
+                SafetySetting.builder()
+                    .category("HARM_CATEGORY_HATE_SPEECH")
+                    .threshold("BLOCK_MEDIUM_AND_ABOVE")
+                    .build(),
+                SafetySetting.builder()
+                    .category("HARM_CATEGORY_HARASSMENT")
+                    .threshold("BLOCK_ONLY_HIGH")
+                    .build()))
+        .build();
+
+GenerateContentResponse response =
+    client.models.generateContent("gemini-3.8-flash", unsafePrompt, config);
+
+try {
+  System.out.println(response.text());
+} catch (Exception e) {
+  System.out.println("No information generated by the model");
+}
+
+System.out.println(response.candidates().get().getFirst().safetyRatings());
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        System Instruction

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+from google.genai import types
+
+client = genai.Client()
+response = client.models.generate_content(
+    model="gemini-3.8-flash",
+    contents="Good morning! How are you?",
+    config=types.GenerateContentConfig(
+        system_instruction="You are a cat. Your name is Neko."
+    ),
+)
+print(response.text)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+const response = await ai.models.generateContent({
+  model: 'gemini-3.8-flash',
+  contents: 'Good morning! How are you?',
+  config: {
+    systemInstruction: 'You are a cat. Your name is Neko.',
+  },
+});
+console.log(response.text);
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+// Construct the user message contents.
+contents := []*genai.Content{
+	genai.NewContentFromText("Good morning! How are you?", genai.RoleUser),
+}
+
+// Set the system instruction as a *genai.Content.
+config := &genai.GenerateContentConfig{
+	SystemInstruction: genai.NewContentFromText("You are a cat. Your name is Neko.", genai.RoleUser),
+}
+
+response, err := client.Models.GenerateContent(ctx, "gemini-3.8-flash", contents, config)
+if err != nil {
+	log.Fatal(err)
+}
+printResponse(response)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent?key=$GEMINI_API_KEY" \
+-H 'Content-Type: application/json' \
+-d '{ "system_instruction": {
+    "parts":
+      { "text": "You are a cat. Your name is Neko."}},
+    "contents": {
+      "parts": {
+        "text": "Hello there"}}}'
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+Part textPart = Part.builder().text("You are a cat. Your name is Neko.").build();
+
+Content content = Content.builder().role("system").parts(ImmutableList.of(textPart)).build();
+
+GenerateContentConfig config =
+    GenerateContentConfig.builder().systemInstruction(content).build();
+
+GenerateContentResponse response =
+    client.models.generateContent("gemini-3.8-flash", "Good morning! How are you?", config);
+
+System.out.println(response.text());
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +         +
        +
        +
        +
        +
        +

        Response body

        +

        If successful, the response body contains an instance of GenerateContentResponse.

        +
        +
        +
        +
        +

        Method: models.streamGenerateContent

        + + +
        + +
        +
        +
        +

        Generates a streamed response from the model given an input GenerateContentRequest.

        +
        +
        +
        +
        +

        Endpoint

        + + + post + + +https://generativelanguage.googleapis.com/v1beta/{model=models/*}:streamGenerateContent + + +
        + + + +
        +
        +

        Path parameters

        +
        +
        +
        + +model + + +string + +
        +
        +

        Required. The name of the Model to use for generating the completion.

        Format: models/{model}. It takes the form models/{model}.

        +
        +
        +
        +
        +
        +

        Request body

        +

        The request body contains data with the following structure:

        +
        + + +Fields + + +
        +
        +
        + +contents[] + + +object (Content) + +
        +
        +

        Required. The content of the current conversation with the model.

        For single-turn queries, this is a single instance. For multi-turn queries like chat, this is a repeated field that contains the conversation history and the latest request.

        +
        +
        +
        +
        +
        +
        + +tools[] + + +object (Tool) + +
        +
        +

        Optional. A list of Tools the Model may use to generate the next response.

        A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the Model. Supported Tools are Function and codeExecution. Refer to the Function calling and the Code execution guides to learn more.

        +
        +
        +
        +
        +
        +
        + +toolConfig + + +object (ToolConfig) + +
        +
        +

        Optional. Tool configuration for any Tool specified in the request. Refer to the Function calling guide for a usage example.

        +
        +
        +
        +
        +
        +
        + +safetySettings[] + + +object (SafetySetting) + +
        +
        +

        Optional. A list of unique SafetySetting instances for blocking unsafe content.

        This will be enforced on the GenerateContentRequest.contents and GenerateContentResponse.candidates. There should not be more than one setting for each SafetyCategory type. The API will block any contents and responses that fail to meet the thresholds set by these settings. This list overrides the default settings for each SafetyCategory specified in the safetySettings. If there is no SafetySetting for a given SafetyCategory provided in the list, the API will use the default safety setting for that category. Harm categories HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY, HARM_CATEGORY_JAILBREAK are supported. Refer to the guide for detailed information on available safety settings. Also refer to the Safety guidance to learn how to incorporate safety considerations in your AI applications.

        +
        +
        +
        +
        +
        +
        + +continuationToken + + +string (bytes format) + +
        +
        +

        Optional. An opaque continuation token used to resume generation from a previous models.generateContent or models.streamGenerateContent response that stopped with finishReason set to CONTINUATION. Note that contents is mandatory and must identically replicate the prompt and conversation history from the initial request when continuation token is provided in a request.

        A base64-encoded string.

        +
        +
        +
        +
        +
        +
        + +labels + + +map (key: string, value: string) + +
        +
        +

        Optional. Labels with user-defined metadata for the request.

        Optional. Labels must follow standard unified Cloud label requirements: - Label keys must start with a letter. - Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. - International characters are allowed.

        Usage: - Safety identifiers from aggregators: Use the key safety_identifier (e.g. {"safety_identifier": "user_session_123"})

        An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

        +
        +
        +
        +
        +
        +
        + +systemInstruction + + +object (Content) + +
        +
        +

        Optional. Developer set system instruction(s). Currently, text only.

        +
        +
        +
        +
        +
        +
        + +generationConfig + + +object (GenerationConfig) + +
        +
        +

        Optional. Configuration options for model generation and outputs.

        +
        +
        +
        +
        +
        +
        + +cachedContent + + +string + +
        +
        +

        Optional. The name of the content cached to use as context to serve the prediction. Format: cachedContents/{cachedContent}

        +
        +
        +
        +
        +
        +
        + +serviceTier + + +enum (ServiceTier) + +
        +
        +

        Optional. The service tier of the request.

        +
        +
        +
        +
        +
        +
        + +store + + +boolean + +
        +
        +

        Optional. Configures the logging behavior for a given request. If set, it takes precedence over the project-level logging config.

        +
        +
        +
        +
        +
        +
        +
        +

        Example request

        + +
        +

        Text

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+
+client = genai.Client()
+response = client.models.generate_content_stream(
+    model="gemini-3.8-flash",
+    contents="Write a story about a magic backpack.",
+)
+for chunk in response:
+  print(chunk.text)
+  print("_" * 80)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+
+const response = await ai.models.generateContentStream({
+  model: 'gemini-3.8-flash',
+  contents: 'Write a story about a magic backpack.',
+});
+let text = '';
+for await (const chunk of response) {
+  console.log(chunk.text);
+  text += chunk.text;
+}
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+contents := []*genai.Content{
+	genai.NewContentFromText("Write a story about a magic backpack.", genai.RoleUser),
+}
+for response, err := range client.Models.GenerateContentStream(
+	ctx,
+	"gemini-3.8-flash",
+	contents,
+	nil,
+) {
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Print(response.Candidates[0].Content.Parts[0].Text)
+}
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:streamGenerateContent?alt=sse&key=${GEMINI_API_KEY}" \
+        -H 'Content-Type: application/json' \
+        --no-buffer \
+        -d '{ "contents":[{"parts":[{"text": "Write a story about a magic backpack."}]}]}'
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+ResponseStream<GenerateContentResponse> responseStream =
+    client.models.generateContentStream(
+        "gemini-3.8-flash", "Write a story about a magic backpack.", null);
+
+StringBuilder response = new StringBuilder();
+for (GenerateContentResponse res : responseStream) {
+  System.out.print(res.text());
+  response.append(res.text());
+}
+
+responseStream.close();
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Image

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+import PIL.Image
+
+client = genai.Client()
+organ = PIL.Image.open(media / "organ.jpg")
+response = client.models.generate_content_stream(
+    model="gemini-3.8-flash",
+    contents=["Tell me about this instrument", organ],
+)
+for chunk in response:
+  print(chunk.text)
+  print("_" * 80)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+
+const organ = await ai.files.upload({
+  file: path.join(media, 'organ.jpg'),
+});
+
+const response = await ai.models.generateContentStream({
+  model: 'gemini-3.8-flash',
+  contents: [
+    createUserContent([
+      'Tell me about this instrument',
+      createPartFromUri(organ.uri, organ.mimeType)
+    ]),
+  ],
+});
+let text = '';
+for await (const chunk of response) {
+  console.log(chunk.text);
+  text += chunk.text;
+}
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+file, err := client.Files.UploadFromPath(
+	ctx,
+	filepath.Join(getMedia(), "organ.jpg"),
+	&genai.UploadFileConfig{
+		MIMEType: "image/jpeg",
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+parts := []*genai.Part{
+	genai.NewPartFromText("Tell me about this instrument"),
+	genai.NewPartFromURI(file.URI, file.MIMEType),
+}
+contents := []*genai.Content{
+	genai.NewContentFromParts(parts, genai.RoleUser),
+}
+for response, err := range client.Models.GenerateContentStream(
+	ctx,
+	"gemini-3.8-flash",
+	contents,
+	nil,
+) {
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Print(response.Candidates[0].Content.Parts[0].Text)
+}
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        cat > "$TEMP_JSON" << EOF
+{
+  "contents": [{
+    "parts":[
+      {"text": "Tell me about this instrument"},
+      {
+        "inline_data": {
+          "mime_type":"image/jpeg",
+          "data": "$(cat "$TEMP_B64")"
+        }
+      }
+    ]
+  }]
+}
+EOF
+
+curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:streamGenerateContent?alt=sse&key=$GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d "@$TEMP_JSON" 2> /dev/null
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Java

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        Client client = new Client();
+
+String path = media_path + "organ.jpg";
+byte[] imageData = Files.readAllBytes(Paths.get(path));
+
+Content content =
+    Content.fromParts(
+        Part.fromText("Tell me about this instrument."),
+        Part.fromBytes(imageData, "image/jpeg"));
+
+ResponseStream<GenerateContentResponse> responseStream =
+    client.models.generateContentStream("gemini-3.8-flash", content, null);
+
+StringBuilder response = new StringBuilder();
+for (GenerateContentResponse res : responseStream) {
+  System.out.print(res.text());
+  response.append(res.text());
+}
+
+responseStream.close();
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Audio

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+
+client = genai.Client()
+sample_audio = client.files.upload(file=media / "sample.mp3")
+response = client.models.generate_content_stream(
+    model="gemini-3.8-flash",
+    contents=["Give me a summary of this audio file.", sample_audio],
+)
+for chunk in response:
+  print(chunk.text)
+  print("_" * 80)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+file, err := client.Files.UploadFromPath(
+	ctx,
+	filepath.Join(getMedia(), "sample.mp3"),
+	&genai.UploadFileConfig{
+		MIMEType: "audio/mpeg",
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+
+parts := []*genai.Part{
+	genai.NewPartFromText("Give me a summary of this audio file."),
+	genai.NewPartFromURI(file.URI, file.MIMEType),
+}
+
+contents := []*genai.Content{
+	genai.NewContentFromParts(parts, genai.RoleUser),
+}
+
+for result, err := range client.Models.GenerateContentStream(
+	ctx,
+	"gemini-3.8-flash",
+	contents,
+	nil,
+) {
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Print(result.Candidates[0].Content.Parts[0].Text)
+}
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        # Use File API to upload audio data to API request.
+MIME_TYPE=$(file -b --mime-type "${AUDIO_PATH}")
+NUM_BYTES=$(wc -c < "${AUDIO_PATH}")
+DISPLAY_NAME=AUDIO
+
+tmp_header_file=upload-header.tmp
+
+# Initial resumable request defining metadata.
+# The upload url is in the response headers dump them to a file.
+curl "${BASE_URL}/upload/v1beta/files?key=${GEMINI_API_KEY}" \
+  -D upload-header.tmp \
+  -H "X-Goog-Upload-Protocol: resumable" \
+  -H "X-Goog-Upload-Command: start" \
+  -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \
+  -H "Content-Type: application/json" \
+  -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null
+
+upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r")
+rm "${tmp_header_file}"
+
+# Upload the actual bytes.
+curl "${upload_url}" \
+  -H "Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Offset: 0" \
+  -H "X-Goog-Upload-Command: upload, finalize" \
+  --data-binary "@${AUDIO_PATH}" 2> /dev/null > file_info.json
+
+file_uri=$(jq ".file.uri" file_info.json)
+echo file_uri=$file_uri
+
+curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:streamGenerateContent?alt=sse&key=$GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d '{
+      "contents": [{
+        "parts":[
+          {"text": "Please describe this file."},
+          {"file_data":{"mime_type": "audio/mpeg", "file_uri": '$file_uri'}}]
+        }]
+       }' 2> /dev/null > response.json
+
+cat response.json
+echo
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Video

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+import time
+
+client = genai.Client()
+# Video clip (CC BY 3.0) from https://peach.blender.org/download/
+myfile = client.files.upload(file=media / "Big_Buck_Bunny.mp4")
+print(f"{myfile=}")
+
+# Poll until the video file is completely processed (state becomes ACTIVE).
+while not myfile.state or myfile.state.name != "ACTIVE":
+  print("Processing video...")
+  print("File state:", myfile.state)
+  time.sleep(5)
+  myfile = client.files.get(name=myfile.name)
+
+response = client.models.generate_content_stream(
+    model="gemini-3.8-flash", contents=[myfile, "Describe this video clip"]
+)
+for chunk in response:
+  print(chunk.text)
+  print("_" * 80)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+
+let video = await ai.files.upload({
+  file: path.join(media, 'Big_Buck_Bunny.mp4'),
+});
+
+// Poll until the video file is completely processed (state becomes ACTIVE).
+while (!video.state || video.state.toString() !== 'ACTIVE') {
+  console.log('Processing video...');
+  console.log('File state: ', video.state);
+  await sleep(5000);
+  video = await ai.files.get({name: video.name});
+}
+
+const response = await ai.models.generateContentStream({
+  model: 'gemini-3.8-flash',
+  contents: [
+    createUserContent([
+      'Describe this video clip',
+      createPartFromUri(video.uri, video.mimeType),
+    ]),
+  ],
+});
+let text = '';
+for await (const chunk of response) {
+  console.log(chunk.text);
+  text += chunk.text;
+}
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+file, err := client.Files.UploadFromPath(
+	ctx,
+	filepath.Join(getMedia(), "Big_Buck_Bunny.mp4"),
+	&genai.UploadFileConfig{
+		MIMEType: "video/mp4",
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+
+// Poll until the video file is completely processed (state becomes ACTIVE).
+for file.State == genai.FileStateUnspecified || file.State != genai.FileStateActive {
+	fmt.Println("Processing video...")
+	fmt.Println("File state:", file.State)
+	time.Sleep(5 * time.Second)
+
+	file, err = client.Files.Get(ctx, file.Name, nil)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+
+parts := []*genai.Part{
+	genai.NewPartFromText("Describe this video clip"),
+	genai.NewPartFromURI(file.URI, file.MIMEType),
+}
+
+contents := []*genai.Content{
+	genai.NewContentFromParts(parts, genai.RoleUser),
+}
+
+for result, err := range client.Models.GenerateContentStream(
+	ctx,
+	"gemini-3.8-flash",
+	contents,
+	nil,
+) {
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Print(result.Candidates[0].Content.Parts[0].Text)
+}
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        # Use File API to upload audio data to API request.
+MIME_TYPE=$(file -b --mime-type "${VIDEO_PATH}")
+NUM_BYTES=$(wc -c < "${VIDEO_PATH}")
+DISPLAY_NAME=VIDEO_PATH
+
+# Initial resumable request defining metadata.
+# The upload url is in the response headers dump them to a file.
+curl "${BASE_URL}/upload/v1beta/files?key=${GEMINI_API_KEY}" \
+  -D upload-header.tmp \
+  -H "X-Goog-Upload-Protocol: resumable" \
+  -H "X-Goog-Upload-Command: start" \
+  -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \
+  -H "Content-Type: application/json" \
+  -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null
+
+upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r")
+rm "${tmp_header_file}"
+
+# Upload the actual bytes.
+curl "${upload_url}" \
+  -H "Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Offset: 0" \
+  -H "X-Goog-Upload-Command: upload, finalize" \
+  --data-binary "@${VIDEO_PATH}" 2> /dev/null > file_info.json
+
+file_uri=$(jq ".file.uri" file_info.json)
+echo file_uri=$file_uri
+
+state=$(jq ".file.state" file_info.json)
+echo state=$state
+
+while [[ "($state)" = *"PROCESSING"* ]];
+do
+  echo "Processing video..."
+  sleep 5
+  # Get the file of interest to check state
+  curl https://generativelanguage.googleapis.com/v1beta/files/$name > file_info.json
+  state=$(jq ".file.state" file_info.json)
+done
+
+curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:streamGenerateContent?alt=sse&key=$GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d '{
+      "contents": [{
+        "parts":[
+          {"text": "Please describe this file."},
+          {"file_data":{"mime_type": "video/mp4", "file_uri": '$file_uri'}}]
+        }]
+       }' 2> /dev/null > response.json
+
+cat response.json
+echo
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        PDF

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+
+client = genai.Client()
+sample_pdf = client.files.upload(file=media / "test.pdf")
+response = client.models.generate_content_stream(
+    model="gemini-3.8-flash",
+    contents=["Give me a summary of this document:", sample_pdf],
+)
+
+for chunk in response:
+  print(chunk.text)
+  print("_" * 80)
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+file, err := client.Files.UploadFromPath(
+	ctx,
+	filepath.Join(getMedia(), "test.pdf"),
+	&genai.UploadFileConfig{
+		MIMEType: "application/pdf",
+	},
+)
+if err != nil {
+	log.Fatal(err)
+}
+
+parts := []*genai.Part{
+	genai.NewPartFromText("Give me a summary of this document:"),
+	genai.NewPartFromURI(file.URI, file.MIMEType),
+}
+
+contents := []*genai.Content{
+	genai.NewContentFromParts(parts, genai.RoleUser),
+}
+
+for result, err := range client.Models.GenerateContentStream(
+	ctx,
+	"gemini-3.8-flash",
+	contents,
+	nil,
+) {
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Print(result.Candidates[0].Content.Parts[0].Text)
+}
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        MIME_TYPE=$(file -b --mime-type "${PDF_PATH}")
+NUM_BYTES=$(wc -c < "${PDF_PATH}")
+DISPLAY_NAME=TEXT
+
+
+echo $MIME_TYPE
+tmp_header_file=upload-header.tmp
+
+# Initial resumable request defining metadata.
+# The upload url is in the response headers dump them to a file.
+curl "${BASE_URL}/upload/v1beta/files?key=${GEMINI_API_KEY}" \
+  -D upload-header.tmp \
+  -H "X-Goog-Upload-Protocol: resumable" \
+  -H "X-Goog-Upload-Command: start" \
+  -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \
+  -H "Content-Type: application/json" \
+  -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null
+
+upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r")
+rm "${tmp_header_file}"
+
+# Upload the actual bytes.
+curl "${upload_url}" \
+  -H "Content-Length: ${NUM_BYTES}" \
+  -H "X-Goog-Upload-Offset: 0" \
+  -H "X-Goog-Upload-Command: upload, finalize" \
+  --data-binary "@${PDF_PATH}" 2> /dev/null > file_info.json
+
+file_uri=$(jq ".file.uri" file_info.json)
+echo file_uri=$file_uri
+
+# Now generate content using that file
+curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:streamGenerateContent?alt=sse&key=$GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d '{
+      "contents": [{
+        "parts":[
+          {"text": "Can you add a few more lines to this poem?"},
+          {"file_data":{"mime_type": "application/pdf", "file_uri": '$file_uri'}}]
+        }]
+       }' 2> /dev/null > response.json
+
+cat response.json
+echo
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +
        +

        Chat

        + +
        +

        Python

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        from google import genai
+from google.genai import types
+
+client = genai.Client()
+chat = client.chats.create(
+    model="gemini-3.8-flash",
+    history=[
+        types.Content(role="user", parts=[types.Part(text="Hello")]),
+        types.Content(
+            role="model",
+            parts=[
+                types.Part(
+                    text="Great to meet you. What would you like to know?"
+                )
+            ],
+        ),
+    ],
+)
+response = chat.send_message_stream(message="I have 2 dogs in my house.")
+for chunk in response:
+  print(chunk.text)
+  print("_" * 80)
+response = chat.send_message_stream(
+    message="How many paws are in my house?"
+)
+for chunk in response:
+  print(chunk.text)
+  print("_" * 80)
+
+print(chat.get_history())
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Node.js

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        // Make sure to include the following import:
+// import {GoogleGenAI} from '@google/genai';
+const ai = new GoogleGenAI({apiKey: process.env.GEMINI_API_KEY});
+const chat = ai.chats.create({
+  model: 'gemini-3.8-flash',
+  history: [
+    {
+      role: 'user',
+      parts: [{text: 'Hello'}],
+    },
+    {
+      role: 'model',
+      parts: [{text: 'Great to meet you. What would you like to know?'}],
+    },
+  ],
+});
+
+console.log('Streaming response for first message:');
+const stream1 = await chat.sendMessageStream({
+  message: 'I have 2 dogs in my house.',
+});
+for await (const chunk of stream1) {
+  console.log(chunk.text);
+  console.log('_'.repeat(80));
+}
+
+console.log('Streaming response for second message:');
+const stream2 = await chat.sendMessageStream({
+  message: 'How many paws are in my house?',
+});
+for await (const chunk of stream2) {
+  console.log(chunk.text);
+  console.log('_'.repeat(80));
+}
+
+console.log(chat.getHistory());
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Go

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        ctx := context.Background()
+client, err := genai.NewClient(ctx, &genai.ClientConfig{
+	APIKey:  os.Getenv("GEMINI_API_KEY"),
+	Backend: genai.BackendGeminiAPI,
+})
+if err != nil {
+	log.Fatal(err)
+}
+
+history := []*genai.Content{
+	genai.NewContentFromText("Hello", genai.RoleUser),
+	genai.NewContentFromText("Great to meet you. What would you like to know?", genai.RoleModel),
+}
+chat, err := client.Chats.Create(ctx, "gemini-3.8-flash", nil, history)
+if err != nil {
+	log.Fatal(err)
+}
+
+for chunk, err := range chat.SendMessageStream(ctx, genai.Part{Text: "I have 2 dogs in my house."}) {
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Println(chunk.Text())
+	fmt.Println(strings.Repeat("_", 64))
+}
+
+for chunk, err := range chat.SendMessageStream(ctx, genai.Part{Text: "How many paws are in my house?"}) {
+	if err != nil {
+		log.Fatal(err)
+	}
+	fmt.Println(chunk.Text())
+	fmt.Println(strings.Repeat("_", 64))
+}
+
+fmt.Println(chat.History(false))
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +

        Shell

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
        curl https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:streamGenerateContent?alt=sse&key=$GEMINI_API_KEY \
+    -H 'Content-Type: application/json' \
+    -X POST \
+    -d '{
+      "contents": [
+        {"role":"user",
+         "parts":[{
+           "text": "Hello"}]},
+        {"role": "model",
+         "parts":[{
+           "text": "Great to meet you. What would you like to know?"}]},
+        {"role":"user",
+         "parts":[{
+           "text": "I have two dogs in my house. How many paws are in my house?"}]},
+      ]
+    }' 2> /dev/null | grep "text"
         +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +         +
        +         +
        +
        +
        +
        +
        +

        Response body

        +

        If successful, the response body contains a stream of GenerateContentResponse instances.

        +
        +
        +
        +
        +

        GenerateContentResponse

        + + +
        + +
        +
        +
        +

        Response from the model supporting multiple candidate responses.

        Safety ratings and content filtering are reported for both prompt in GenerateContentResponse.prompt_feedback and for each candidate in finishReason and in safetyRatings. The API: - Returns either all requested candidates or none of them - Returns no candidates at all only if there was something wrong with the prompt (check promptFeedback) - Reports feedback on each candidate in finishReason and safetyRatings.

        +
        +
        + + +Fields + + +
        +
        +
        + +candidates[] + + +object (Candidate) + +
        +
        +

        Candidate responses from the model.

        +
        +
        +
        +
        +
        +
        + +promptFeedback + + +object (PromptFeedback) + +
        +
        +

        Returns the prompt's feedback related to the content filters.

        +
        +
        +
        +
        +
        +
        + +usageMetadata + + +object (UsageMetadata) + +
        +
        +

        Output only. Metadata on the generation requests' token usage.

        +
        +
        +
        +
        +
        +
        + +modelVersion + + +string + +
        +
        +

        Output only. The model version used to generate the response.

        +
        +
        +
        +
        +
        +
        + +responseId + + +string + +
        +
        +

        Output only. responseId is used to identify each response.

        +
        +
        +
        +
        +
        +
        + +modelStatus + + +object (ModelStatus) + +
        +
        +

        Output only. The current model status of this model.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "candidates": [
+    {
+      object (Candidate)
+    }
+  ],
+  "promptFeedback": {
+    object (PromptFeedback)
+  },
+  "usageMetadata": {
+    object (UsageMetadata)
+  },
+  "modelVersion": string,
+  "responseId": string,
+  "modelStatus": {
+    object (ModelStatus)
+  }
+}
        +
        +
        +
        +

        PromptFeedback

        +
        +
        +
        +

        A set of the feedback metadata the prompt specified in GenerateContentRequest.content.

        +
        +
        + + +Fields + + +
        +
        +
        + +blockReason + + +enum (BlockReason) + +
        +
        +

        Optional. If set, the prompt was blocked and no candidates are returned. Rephrase the prompt.

        +
        +
        +
        +
        +
        +
        + +safetyRatings[] + + +object (SafetyRating) + +
        +
        +

        Ratings for safety of the prompt. There is at most one rating per category.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "blockReason": enum (BlockReason),
+  "safetyRatings": [
+    {
+      object (SafetyRating)
+    }
+  ]
+}
        +
        +
        +
        +

        BlockReason

        +
        +

        Specifies the reason why the prompt was blocked.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        BLOCK_REASON_UNSPECIFIEDDefault value. This value is unused.
        SAFETYPrompt was blocked due to safety reasons. Inspect safetyRatings to understand which safety category blocked it.
        OTHERPrompt was blocked due to unknown reasons.
        BLOCKLISTPrompt was blocked due to the terms which are included from the terminology blocklist.
        PROHIBITED_CONTENTPrompt was blocked due to prohibited content.
        IMAGE_SAFETYCandidates blocked due to unsafe image generation content.
        +
        +

        UsageMetadata

        +
        +
        +
        +

        Metadata on the generation request's token usage.

        +
        +
        + + +Fields + + +
        +
        +
        + +promptTokenCount + + +integer + +
        +
        +

        Number of tokens in the prompt. When cachedContent is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.

        +
        +
        +
        +
        +
        +
        + +cachedContentTokenCount + + +integer + +
        +
        +

        Number of tokens in the cached part of the prompt (the cached content)

        +
        +
        +
        +
        +
        +
        + +candidatesTokenCount + + +integer + +
        +
        +

        Total number of tokens across all the generated response candidates.

        +
        +
        +
        +
        +
        +
        + +toolUsePromptTokenCount + + +integer + +
        +
        +

        Output only. Number of tokens present in tool-use prompt(s).

        +
        +
        +
        +
        +
        +
        + +thoughtsTokenCount + + +integer + +
        +
        +

        Output only. Number of tokens of thoughts for thinking models.

        +
        +
        +
        +
        +
        +
        + +totalTokenCount + + +integer + +
        +
        +

        Total token count for the generation request (prompt + tool-use prompt + thoughts + response candidates).

        +
        +
        +
        +
        +
        +
        + +promptTokensDetails[] + + +object (ModalityTokenCount) + +
        +
        +

        Output only. List of modalities that were processed in the request input.

        +
        +
        +
        +
        +
        +
        + +cacheTokensDetails[] + + +object (ModalityTokenCount) + +
        +
        +

        Output only. List of modalities of the cached content in the request input.

        +
        +
        +
        +
        +
        +
        + +candidatesTokensDetails[] + + +object (ModalityTokenCount) + +
        +
        +

        Output only. List of modalities that were returned in the response.

        +
        +
        +
        +
        +
        +
        + +toolUsePromptTokensDetails[] + + +object (ModalityTokenCount) + +
        +
        +

        Output only. List of modalities that were processed for tool-use request inputs.

        +
        +
        +
        +
        +
        +
        + +serviceTier + + +enum (ServiceTier) + +
        +
        +

        Output only. Service tier of the request.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "promptTokenCount": integer,
+  "cachedContentTokenCount": integer,
+  "candidatesTokenCount": integer,
+  "toolUsePromptTokenCount": integer,
+  "thoughtsTokenCount": integer,
+  "totalTokenCount": integer,
+  "promptTokensDetails": [
+    {
+      object (ModalityTokenCount)
+    }
+  ],
+  "cacheTokensDetails": [
+    {
+      object (ModalityTokenCount)
+    }
+  ],
+  "candidatesTokensDetails": [
+    {
+      object (ModalityTokenCount)
+    }
+  ],
+  "toolUsePromptTokensDetails": [
+    {
+      object (ModalityTokenCount)
+    }
+  ],
+  "serviceTier": enum (ServiceTier)
+}
        +
        +
        +
        +

        ModelStatus

        +
        +
        +
        +

        The status of the underlying model. This is used to indicate the stage of the underlying model and the retirement time if applicable.

        +
        +
        + + +Fields + + +
        +
        +
        + +modelStage + + +enum (ModelStage) + +
        +
        +

        The stage of the underlying model.

        +
        +
        +
        +
        +
        +
        + +retirementTime + + +string (Timestamp format) + +
        +
        +

        The time at which the model will be retired.

        Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

        +
        +
        +
        +
        +
        +
        + +message + + +string + +
        +
        +

        A message explaining the model status.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "modelStage": enum (ModelStage),
+  "retirementTime": string,
+  "message": string
+}
        +
        +
        +
        +

        ModelStage

        +
        +

        Defines the stage of the underlying model.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        MODEL_STAGE_UNSPECIFIEDUnspecified model stage.
        UNSTABLE_EXPERIMENTAL

        The underlying model is subject to lots of tunings.

        EXPERIMENTALModels in this stage are for experimental purposes only.
        PREVIEWModels in this stage are more mature than experimental models.
        STABLEModels in this stage are considered stable and ready for production use.
        LEGACYIf the model is on this stage, it means that this model is on the path to deprecation in near future. Only existing customers can use this model.
        DEPRECATED

        Models in this stage are deprecated. These models cannot be used.

        RETIREDModels in this stage are retired. These models cannot be used.
        +
        +
        +

        Candidate

        + + +
        + +
        +
        +
        +

        A response candidate generated from the model.

        +
        +
        + + +Fields + + +
        +
        +
        + +content + + +object (Content) + +
        +
        +

        Output only. Generated content returned from the model.

        +
        +
        +
        +
        +
        +
        + +finishReason + + +enum (FinishReason) + +
        +
        +

        Optional. Output only. The reason why the model stopped generating tokens.

        If empty, the model has not stopped generating tokens.

        +
        +
        +
        +
        +
        +
        + +safetyRatings[] + + +object (SafetyRating) + +
        +
        +

        List of ratings for the safety of a response candidate.

        There is at most one rating per category.

        +
        +
        +
        +
        +
        +
        + +citationMetadata + + +object (CitationMetadata) + +
        +
        +

        Output only. Citation information for model-generated candidate.

        This field may be populated with recitation information for any text included in the content. These are passages that are "recited" from copyrighted material in the foundational LLM's training data.

        +
        +
        +
        +
        +
        +
        + +tokenCount + + +integer + +
        +
        +

        Output only. Token count for this candidate.

        +
        +
        +
        +
        +
        +
        + +groundingAttributions[] + + +object (GroundingAttribution) + +
        +
        +

        Output only. Attribution information for sources that contributed to a grounded answer.

        This field is populated for GenerateAnswer calls.

        +
        +
        +
        +
        +
        +
        + +groundingMetadata + + +object (GroundingMetadata) + +
        +
        +

        Output only. Grounding metadata for the candidate.

        This field is populated for GenerateContent calls.

        +
        +
        +
        +
        +
        +
        + +avgLogprobs + + +number + +
        +
        +

        Output only. Average log probability score of the candidate.

        +
        +
        +
        +
        +
        +
        + +logprobsResult + + +object (LogprobsResult) + +
        +
        +

        Output only. Log-likelihood scores for the response tokens and top tokens

        +
        +
        +
        +
        +
        +
        + +urlContextMetadata + + +object (UrlContextMetadata) + +
        +
        +

        Output only. Metadata related to url context retrieval tool.

        +
        +
        +
        +
        +
        +
        + +continuationToken + + +string (bytes format) + +
        +
        +

        An optional opaque continuation token returned when finishReason is CONTINUATION. Clients can pass this token in a subsequent GenerateContentRequest to continue generation.

        A base64-encoded string.

        +
        +
        +
        +
        +
        +
        + +index + + +integer + +
        +
        +

        Output only. Index of the candidate in the list of response candidates.

        +
        +
        +
        +
        +
        +
        + +finishMessage + + +string + +
        +
        +

        Optional. Output only. Details the reason why the model stopped generating tokens. This is populated only when finishReason is set.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "content": {
+    object (Content)
+  },
+  "finishReason": enum (FinishReason),
+  "safetyRatings": [
+    {
+      object (SafetyRating)
+    }
+  ],
+  "citationMetadata": {
+    object (CitationMetadata)
+  },
+  "tokenCount": integer,
+  "groundingAttributions": [
+    {
+      object (GroundingAttribution)
+    }
+  ],
+  "groundingMetadata": {
+    object (GroundingMetadata)
+  },
+  "avgLogprobs": number,
+  "logprobsResult": {
+    object (LogprobsResult)
+  },
+  "urlContextMetadata": {
+    object (UrlContextMetadata)
+  },
+  "continuationToken": string,
+  "index": integer,
+  "finishMessage": string
+}
        +
        +
        +
        +

        FinishReason

        +
        +

        Defines the reason why the model stopped generating tokens.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        FINISH_REASON_UNSPECIFIEDDefault value. This value is unused.
        STOPNatural stop point of the model or provided stop sequence.
        MAX_TOKENSThe maximum number of tokens as specified in the request was reached.
        SAFETYThe response candidate content was flagged for safety reasons.
        RECITATIONThe response candidate content was flagged for recitation reasons.
        LANGUAGEThe response candidate content was flagged for using an unsupported language.
        OTHERUnknown reason.
        BLOCKLISTToken generation stopped because the content contains forbidden terms.
        PROHIBITED_CONTENTToken generation stopped for potentially containing prohibited content.
        SPIIToken generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).
        MALFORMED_FUNCTION_CALLThe function call generated by the model is invalid.
        IMAGE_SAFETYToken generation stopped because generated images contain safety violations.
        IMAGE_PROHIBITED_CONTENTImage generation stopped because generated images has other prohibited content.
        IMAGE_OTHERImage generation stopped because of other miscellaneous issue.
        NO_IMAGEThe model was expected to generate an image, but none was generated.
        IMAGE_RECITATIONImage generation stopped due to recitation.
        UNEXPECTED_TOOL_CALLModel generated a tool call but no tools were enabled in the request.
        TOO_MANY_TOOL_CALLSModel called too many tools consecutively, thus the system exited execution.
        MISSING_THOUGHT_SIGNATURERequest has at least one thought signature missing.
        MALFORMED_RESPONSEFinished due to malformed response.
        ESCALATIONRequest was filtered by an escalation rule.
        PUP_LIMITED_DISABLEDIndicates that token generation stopped because the user account is limited or disabled due to Prohibited Use Policy (PUP) violations.
        CONTINUATIONToken generation was stopped because the response reached the per-request token limit, but generation is not yet complete. The model response can be continued via a subsequent request using the returned continuationToken. Note, the maxOutputTokens is cumulative across continuation hops and must be monotonically increased or omitted.
        +
        +

        GroundingAttribution

        +
        +
        +
        +

        Attribution for a source that contributed to an answer.

        +
        +
        + + +Fields + + +
        +
        +
        + +sourceId + + +object (AttributionSourceId) + +
        +
        +

        Output only. Identifier for the source contributing to this attribution.

        +
        +
        +
        +
        +
        +
        + +content + + +object (Content) + +
        +
        +

        Grounding source content that makes up this attribution.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "sourceId": {
+    object (AttributionSourceId)
+  },
+  "content": {
+    object (Content)
+  }
+}
        +
        +
        +
        +

        AttributionSourceId

        +
        +
        +
        +

        Identifier for the source contributing to this attribution.

        +
        +
        + + +Fields + + +
        +
        + + +source + + +Union type + + +
        +
        The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +groundingPassage + + +object (GroundingPassageId) + +
        +
        +

        Identifier for an inline passage.

        +
        +
        +
        +
        +
        +
        + +semanticRetrieverChunk + + +object (SemanticRetrieverChunk) + +
        +
        +

        Identifier for a Chunk fetched via Semantic Retriever.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+
+  // source
+  "groundingPassage": {
+    object (GroundingPassageId)
+  },
+  "semanticRetrieverChunk": {
+    object (SemanticRetrieverChunk)
+  }
+  // Union type
+}
        +
        +
        +
        +

        GroundingPassageId

        +
        +
        +
        +

        Identifier for a part within a GroundingPassage.

        +
        +
        + + +Fields + + +
        +
        +
        + +passageId + + +string + +
        +
        +

        Output only. ID of the passage matching the GenerateAnswerRequest's GroundingPassage.id.

        +
        +
        +
        +
        +
        +
        + +partIndex + + +integer + +
        +
        +

        Output only. Index of the part within the GenerateAnswerRequest's GroundingPassage.content.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "passageId": string,
+  "partIndex": integer
+}
        +
        +
        +
        +

        SemanticRetrieverChunk

        +
        +
        +
        +

        Identifier for a Chunk retrieved via Semantic Retriever specified in the GenerateAnswerRequest using SemanticRetrieverConfig.

        +
        +
        + + +Fields + + +
        +
        +
        + +source + + +string + +
        +
        +

        Output only. Name of the source matching the request's SemanticRetrieverConfig.source. Example: corpora/123 or corpora/123/documents/abc

        +
        +
        +
        +
        +
        +
        + +chunk + + +string + +
        +
        +

        Output only. Name of the Chunk containing the attributed text. Example: corpora/123/documents/abc/chunks/xyz

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "source": string,
+  "chunk": string
+}
        +
        +
        +
        +

        GroundingMetadata

        +
        +
        +
        +

        Metadata returned to client when grounding is enabled.

        +
        +
        + + +Fields + + +
        +
        +
        + +groundingChunks[] + + +object (GroundingChunk) + +
        +
        +

        List of supporting references retrieved from specified grounding source. When streaming, this only contains the grounding chunks that have not been included in the grounding metadata of previous responses.

        +
        +
        +
        +
        +
        +
        + +groundingSupports[] + + +object (GroundingSupport) + +
        +
        +

        List of grounding support.

        +
        +
        +
        +
        +
        +
        + +webSearchQueries[] + + +string + +
        +
        +

        Web search queries for the following-up web search.

        +
        +
        +
        +
        +
        +
        + +imageSearchQueries[] + + +string + +
        +
        +

        Image search queries used for grounding.

        +
        +
        +
        +
        +
        +
        + +searchEntryPoint + + +object (SearchEntryPoint) + +
        +
        +

        Optional. Google search entry for the following-up web searches.

        +
        +
        +
        +
        +
        +
        + +retrievalMetadata + + +object (RetrievalMetadata) + +
        +
        +

        Metadata related to retrieval in the grounding flow.

        +
        +
        +
        +
        +
        +
        + +googleMapsWidgetContextToken + + +string + +
        +
        +

        Optional. Resource name of the Google Maps widget context token that can be used with the PlacesContextElement widget in order to render contextual data. Only populated in the case that grounding with Google Maps is enabled.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "groundingChunks": [
+    {
+      object (GroundingChunk)
+    }
+  ],
+  "groundingSupports": [
+    {
+      object (GroundingSupport)
+    }
+  ],
+  "webSearchQueries": [
+    string
+  ],
+  "imageSearchQueries": [
+    string
+  ],
+  "searchEntryPoint": {
+    object (SearchEntryPoint)
+  },
+  "retrievalMetadata": {
+    object (RetrievalMetadata)
+  },
+  "googleMapsWidgetContextToken": string
+}
        +
        +
        +
        +

        SearchEntryPoint

        +
        +
        +
        +

        Google search entry point.

        +
        +
        + + +Fields + + +
        +
        +
        + +renderedContent + + +string + +
        +
        +

        Optional. Web content snippet that can be embedded in a web page or an app webview.

        +
        +
        +
        +
        +
        +
        + +sdkBlob + + +string (bytes format) + +
        +
        +

        Optional. Base64 encoded JSON representing array of <search term, search url> tuple.

        A base64-encoded string.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "renderedContent": string,
+  "sdkBlob": string
+}
        +
        +
        +
        +

        GroundingChunk

        +
        +
        +
        +

        A GroundingChunk represents a segment of supporting evidence that grounds the model's response. It can be a chunk from the web, a retrieved context from a file, or information from Google Maps.

        +
        +
        + + +Fields + + +
        +
        + + +chunk_type + + +Union type + + +
        +
        Chunk type. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +web + + +object (Web) + +
        +
        +

        Grounding chunk from the web.

        +
        +
        +
        +
        +
        +
        + +image + + +object (Image) + +
        +
        +

        Optional. Grounding chunk from image search.

        +
        +
        +
        +
        +
        +
        + +retrievedContext + + +object (RetrievedContext) + +
        +
        +

        Optional. Grounding chunk from context retrieved by the file search tool.

        +
        +
        +
        +
        +
        +
        + +maps + + +object (Maps) + +
        +
        +

        Optional. Grounding chunk from Google Maps.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+
+  // chunk_type
+  "web": {
+    object (Web)
+  },
+  "image": {
+    object (Image)
+  },
+  "retrievedContext": {
+    object (RetrievedContext)
+  },
+  "maps": {
+    object (Maps)
+  }
+  // Union type
+}
        +
        +
        +
        +

        Web

        +
        +
        +
        +

        Chunk from the web.

        +
        +
        + + +Fields + + +
        +
        +
        + +uri + + +string + +
        +
        +

        Output only. URI reference of the chunk.

        +
        +
        +
        +
        +
        +
        + +title + + +string + +
        +
        +

        Output only. Title of the chunk.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "uri": string,
+  "title": string
+}
        +
        +
        +
        +

        Image

        +
        +
        +
        +

        Chunk from image search.

        +
        +
        + + +Fields + + +
        +
        +
        + +sourceUri + + +string + +
        +
        +

        The web page URI for attribution.

        +
        +
        +
        +
        +
        +
        + +imageUri + + +string + +
        +
        +

        The image asset URL.

        +
        +
        +
        +
        +
        +
        + +title + + +string + +
        +
        +

        The title of the web page that the image is from.

        +
        +
        +
        +
        +
        +
        + +domain + + +string + +
        +
        +

        The root domain of the web page that the image is from, e.g. "example.com".

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "sourceUri": string,
+  "imageUri": string,
+  "title": string,
+  "domain": string
+}
        +
        +
        +
        +

        RetrievedContext

        +
        +
        +
        +

        Chunk from context retrieved by the file search tool.

        +
        +
        + + +Fields + + +
        +
        +
        + +customMetadata[] + + +object (CustomMetadata) + +
        +
        +

        Optional. User-provided metadata about the retrieved context.

        +
        +
        +
        +
        +
        +
        + +uri + + +string + +
        +
        +

        Optional. URI reference of the semantic retrieval document.

        +
        +
        +
        +
        +
        +
        + +title + + +string + +
        +
        +

        Optional. Title of the document.

        +
        +
        +
        +
        +
        +
        + +text + + +string + +
        +
        +

        Optional. Text of the chunk.

        +
        +
        +
        +
        +
        +
        + +fileSearchStore + + +string + +
        +
        +

        Optional. Name of the FileSearchStore containing the document. Example: fileSearchStores/123

        +
        +
        +
        +
        +
        +
        + +pageNumber + + +integer + +
        +
        +

        Optional. Page number of the retrieved context, if applicable.

        +
        +
        +
        +
        +
        +
        + +mediaId + + +string + +
        +
        +

        Optional. The media blob resource name for multimodal file search results. Format: fileSearchStores/{file_search_store_id}/media/{blobId}

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "customMetadata": [
+    {
+      object (CustomMetadata)
+    }
+  ],
+  "uri": string,
+  "title": string,
+  "text": string,
+  "fileSearchStore": string,
+  "pageNumber": integer,
+  "mediaId": string
+}
        +
        +
        +
        +

        CustomMetadata

        +
        +
        +
        +

        User provided metadata about the GroundingFact.

        +
        +
        + + +Fields + + +
        +
        +
        + +key + + +string + +
        +
        +

        The key of the metadata.

        +
        +
        +
        +
        +
        + + +value + + +Union type + + +
        +
        The value of the metadata. Can be a string, a list of strings, or a number. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +stringValue + + +string + +
        +
        +

        Optional. The string value of the metadata.

        +
        +
        +
        +
        +
        +
        + +stringListValue + + +object (StringList) + +
        +
        +

        Optional. A list of string values for the metadata.

        +
        +
        +
        +
        +
        +
        + +numericValue + + +number + +
        +
        +

        Optional. The numeric value of the metadata. The expected range for this value depends on the specific key used.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "key": string,
+
+  // value
+  "stringValue": string,
+  "stringListValue": {
+    object (StringList)
+  },
+  "numericValue": number
+  // Union type
+}
        +
        +
        +
        +

        StringList

        +
        +
        +
        +

        A list of string values.

        +
        +
        + + +Fields + + +
        +
        +
        + +values[] + + +string + +
        +
        +

        The string values of the list.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "values": [
+    string
+  ]
+}
        +
        +
        +
        +

        Maps

        +
        +
        +
        +

        A grounding chunk from Google Maps. A Maps chunk corresponds to a single place.

        +
        +
        + + +Fields + + +
        +
        +
        + +uri + + +string + +
        +
        +

        URI reference of the place.

        +
        +
        +
        +
        +
        +
        + +title + + +string + +
        +
        +

        Title of the place.

        +
        +
        +
        +
        +
        +
        + +text + + +string + +
        +
        +

        Text description of the place answer.

        +
        +
        +
        +
        +
        +
        + +placeId + + +string + +
        +
        +

        The ID of the place, in places/{placeId} format. A user can use this ID to look up that place.

        +
        +
        +
        +
        +
        +
        + +placeAnswerSources + + +object (PlaceAnswerSources) + +
        +
        +

        Sources that provide answers about the features of a given place in Google Maps.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "uri": string,
+  "title": string,
+  "text": string,
+  "placeId": string,
+  "placeAnswerSources": {
+    object (PlaceAnswerSources)
+  }
+}
        +
        +
        +
        +

        PlaceAnswerSources

        +
        +
        +
        +

        Collection of sources that provide answers about the features of a given place in Google Maps. Each PlaceAnswerSources message corresponds to a specific place in Google Maps. The Google Maps tool used these sources in order to answer questions about features of the place (e.g: "does Bar Foo have Wifi" or "is Foo Bar wheelchair accessible?"). Currently we only support review snippets as sources.

        +
        +
        + + +Fields + + +
        +
        +
        + +reviewSnippets[] + + +object (ReviewSnippet) + +
        +
        +

        Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "reviewSnippets": [
+    {
+      object (ReviewSnippet)
+    }
+  ]
+}
        +
        +
        +
        +

        ReviewSnippet

        +
        +
        +
        +

        Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

        +
        +
        + + +Fields + + +
        +
        +
        + +reviewId + + +string + +
        +
        +

        The ID of the review snippet.

        +
        +
        +
        +
        +
        +
        + +googleMapsUri + + +string + +
        +
        +

        A link that corresponds to the user review on Google Maps.

        +
        +
        +
        +
        +
        +
        + +title + + +string + +
        +
        +

        Title of the review.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "reviewId": string,
+  "googleMapsUri": string,
+  "title": string
+}
        +
        +
        +
        +

        GroundingSupport

        +
        +
        +
        +

        Grounding support.

        +
        +
        + + +Fields + + +
        +
        +
        + +groundingChunkIndices[] + + +integer + +
        +
        +

        Optional. A list of indices (into 'grounding_chunk' in response.candidate.grounding_metadata) specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. If the response is streaming, the groundingChunkIndices refer to the indices across all responses. It is the client's responsibility to accumulate the grounding chunks from all responses (while maintaining the same order).

        +
        +
        +
        +
        +
        +
        + +confidenceScores[] + + +number + +
        +
        +

        Optional. Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the groundingChunkIndices.

        +
        +
        +
        +
        +
        +
        + +renderedParts[] + + +integer + +
        +
        +

        Output only. Indices into the parts field of the candidate's content. These indices specify which rendered parts are associated with this support source.

        +
        +
        +
        +
        +
        +
        + +segment + + +object (Segment) + +
        +
        +

        Segment of the content this support belongs to.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "groundingChunkIndices": [
+    integer
+  ],
+  "confidenceScores": [
+    number
+  ],
+  "renderedParts": [
+    integer
+  ],
+  "segment": {
+    object (Segment)
+  }
+}
        +
        +
        +
        +

        Segment

        +
        +
        +
        +

        Segment of the content.

        +
        +
        + + +Fields + + +
        +
        +
        + +partIndex + + +integer + +
        +
        +

        The index of a Part object within its parent Content object.

        +
        +
        +
        +
        +
        +
        + +startIndex + + +integer + +
        +
        +

        Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.

        +
        +
        +
        +
        +
        +
        + +endIndex + + +integer + +
        +
        +

        End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.

        +
        +
        +
        +
        +
        +
        + +text + + +string + +
        +
        +

        The text corresponding to the segment from the response.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "partIndex": integer,
+  "startIndex": integer,
+  "endIndex": integer,
+  "text": string
+}
        +
        +
        +
        +

        RetrievalMetadata

        +
        +
        +
        +

        Metadata related to retrieval in the grounding flow.

        +
        +
        + + +Fields + + +
        +
        +
        + +googleSearchDynamicRetrievalScore + + +number + +
        +
        +

        Optional. Score indicating how likely information from google search could help answer the prompt. The score is in the range [0, 1], where 0 is the least likely and 1 is the most likely. This score is only populated when google search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger google search.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "googleSearchDynamicRetrievalScore": number
+}
        +
        +
        +
        +

        LogprobsResult

        +
        +
        +
        +

        Logprobs Result

        +
        +
        + + +Fields + + +
        +
        +
        + +topCandidates[] + + +object (TopCandidates) + +
        +
        +

        Length = total number of decoding steps.

        +
        +
        +
        +
        +
        +
        + +chosenCandidates[] + + +object (Candidate) + +
        +
        +

        Length = total number of decoding steps. The chosen candidates may or may not be in topCandidates.

        +
        +
        +
        +
        +
        +
        + +logProbabilitySum + + +number + +
        +
        +

        Sum of log probabilities for all tokens.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "topCandidates": [
+    {
+      object (TopCandidates)
+    }
+  ],
+  "chosenCandidates": [
+    {
+      object (Candidate)
+    }
+  ],
+  "logProbabilitySum": number
+}
        +
        +
        +
        +

        TopCandidates

        +
        +
        +
        +

        Candidates with top log probabilities at each decoding step.

        +
        +
        + + +Fields + + +
        +
        +
        + +candidates[] + + +object (Candidate) + +
        +
        +

        Sorted by log probability in descending order.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "candidates": [
+    {
+      object (Candidate)
+    }
+  ]
+}
        +
        +
        +
        +

        Candidate

        +
        +
        +
        +

        Candidate for the logprobs token and score.

        +
        +
        + + +Fields + + +
        +
        +
        + +token + + +string + +
        +
        +

        The candidate’s token string value.

        +
        +
        +
        +
        +
        +
        + +tokenId + + +integer + +
        +
        +

        The candidate’s token id value.

        +
        +
        +
        +
        +
        +
        + +logProbability + + +number + +
        +
        +

        The candidate's log probability.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "token": string,
+  "tokenId": integer,
+  "logProbability": number
+}
        +
        +
        +
        +

        UrlContextMetadata

        +
        +
        +
        +

        Metadata related to url context retrieval tool.

        +
        +
        + + +Fields + + +
        +
        +
        + +urlMetadata[] + + +object (UrlMetadata) + +
        +
        +

        List of url context.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "urlMetadata": [
+    {
+      object (UrlMetadata)
+    }
+  ]
+}
        +
        +
        +
        +

        UrlMetadata

        +
        +
        +
        +

        Context of the a single url retrieval.

        +
        +
        + + +Fields + + +
        +
        +
        + +retrievedUrl + + +string + +
        +
        +

        Retrieved url by the tool.

        +
        +
        +
        +
        +
        +
        + +urlRetrievalStatus + + +enum (UrlRetrievalStatus) + +
        +
        +

        Status of the url retrieval.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "retrievedUrl": string,
+  "urlRetrievalStatus": enum (UrlRetrievalStatus)
+}
        +
        +
        +
        +

        UrlRetrievalStatus

        +
        +

        Status of the url retrieval.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        URL_RETRIEVAL_STATUS_UNSPECIFIEDDefault value. This value is unused.
        URL_RETRIEVAL_STATUS_SUCCESSUrl retrieval is successful.
        URL_RETRIEVAL_STATUS_ERRORUrl retrieval is failed due to error.
        URL_RETRIEVAL_STATUS_PAYWALLUrl retrieval is failed because the content is behind paywall.
        URL_RETRIEVAL_STATUS_UNSAFEUrl retrieval is failed because the content is unsafe.
        +
        +
        +

        CitationMetadata

        + + +
        + +
        +
        +
        +

        A collection of source attributions for a piece of content.

        +
        +
        + + +Fields + + +
        +
        +
        + +citationSources[] + + +object (CitationSource) + +
        +
        +

        Citations to sources for a specific response.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "citationSources": [
+    {
+      object (CitationSource)
+    }
+  ]
+}
        +
        +
        +
        +

        CitationSource

        +
        +
        +
        +

        A citation to a source for a portion of a specific response.

        +
        +
        + + +Fields + + +
        +
        +
        + +startIndex + + +integer + +
        +
        +

        Optional. Start of segment of the response that is attributed to this source.

        Index indicates the start of the segment, measured in bytes.

        +
        +
        +
        +
        +
        +
        + +endIndex + + +integer + +
        +
        +

        Optional. End of the attributed segment, exclusive.

        +
        +
        +
        +
        +
        +
        + +uri + + +string + +
        +
        +

        Optional. URI that is attributed as a source for a portion of the text.

        +
        +
        +
        +
        +
        +
        + +license + + +string + +
        +
        +

        Optional. License for the GitHub project that is attributed as a source for segment.

        License info is required for code citations.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "startIndex": integer,
+  "endIndex": integer,
+  "uri": string,
+  "license": string
+}
        +
        +
        +
        +
        +

        HarmCategory

        + + +
        +
        +

        The category of a rating.

        These categories cover various kinds of harms that developers may wish to adjust.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        HARM_CATEGORY_UNSPECIFIEDCategory is unspecified.
        HARM_CATEGORY_DEROGATORY

        PaLM - Negative or harmful comments targeting identity and/or protected attribute. DEPRECATED: PaLM-only category, not supported by Gemini models.

        HARM_CATEGORY_TOXICITY

        PaLM - Content that is rude, disrespectful, or profane. DEPRECATED: PaLM-only category, not supported by Gemini models.

        HARM_CATEGORY_VIOLENCE

        PaLM - Describes scenarios depicting violence against an individual or group, or general descriptions of gore. DEPRECATED: PaLM-only category, not supported by Gemini models.

        HARM_CATEGORY_SEXUAL

        PaLM - Contains references to sexual acts or other lewd content. DEPRECATED: PaLM-only category, not supported by Gemini models.

        HARM_CATEGORY_MEDICAL

        PaLM - Promotes unchecked medical advice. DEPRECATED: PaLM-only category, not supported by Gemini models.

        HARM_CATEGORY_DANGEROUS

        PaLM - Dangerous content that promotes, facilitates, or encourages harmful acts. DEPRECATED: PaLM-only category, not supported by Gemini models.

        HARM_CATEGORY_HARASSMENTGemini - Harassment content.
        HARM_CATEGORY_HATE_SPEECHGemini - Hate speech and content.
        HARM_CATEGORY_SEXUALLY_EXPLICITGemini - Sexually explicit content.
        HARM_CATEGORY_DANGEROUS_CONTENTGemini - Dangerous content.
        HARM_CATEGORY_CIVIC_INTEGRITY

        Gemini - Content that may be used to harm civic integrity. DEPRECATED: use enableEnhancedCivicAnswers instead.

        HARM_CATEGORY_JAILBREAKGemini - Prompts attempting to bypass or subvert the model's safety guidelines (jailbreak attempts).
        +
        +
        +

        ModalityTokenCount

        + + +
        + +
        +
        +
        +

        Represents token counting info for a single modality.

        +
        +
        + + +Fields + + +
        +
        +
        + +modality + + +enum (Modality) + +
        +
        +

        The modality associated with this token count.

        +
        +
        +
        +
        +
        +
        + +tokenCount + + +integer + +
        +
        +

        Number of tokens.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "modality": enum (Modality),
+  "tokenCount": integer
+}
        +
        +
        +
        +

        Modality

        +
        +

        Content Part modality

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        MODALITY_UNSPECIFIEDUnspecified modality.
        TEXTPlain text.
        IMAGEImage.
        VIDEOVideo.
        AUDIOAudio.
        DOCUMENTDocument, e.g. PDF.
        +
        +
        +

        SafetyRating

        + + +
        + +
        +
        +
        +

        Safety rating for a piece of content.

        The safety rating contains the category of harm and the harm probability level in that category for a piece of content. Content is classified for safety across a number of harm categories and the probability of the harm classification is included here.

        +
        +
        + + +Fields + + +
        +
        +
        + +category + + +enum (HarmCategory) + +
        +
        +

        Required. The category for this rating.

        +
        +
        +
        +
        +
        +
        + +probability + + +enum (HarmProbability) + +
        +
        +

        Required. The probability of harm for this content.

        +
        +
        +
        +
        +
        +
        + +blocked + + +boolean + +
        +
        +

        Was this content blocked because of this rating?

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "category": enum (HarmCategory),
+  "probability": enum (HarmProbability),
+  "blocked": boolean
+}
        +
        +
        +
        +

        HarmProbability

        +
        +

        The probability that a piece of content is harmful.

        The classification system gives the probability of the content being unsafe. This does not indicate the severity of harm for a piece of content.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        HARM_PROBABILITY_UNSPECIFIEDProbability is unspecified.
        NEGLIGIBLEContent has a negligible chance of being unsafe.
        LOWContent has a low chance of being unsafe.
        MEDIUMContent has a medium chance of being unsafe.
        HIGHContent has a high chance of being unsafe.
        +
        +
        +

        SafetySetting

        + + +
        + +
        +
        +
        +

        Safety setting, affecting the safety-blocking behavior.

        Passing a safety setting for a category changes the allowed probability that content is blocked.

        +
        +
        + + +Fields + + +
        +
        +
        + +category + + +enum (HarmCategory) + +
        +
        +

        Required. The category for this setting.

        +
        +
        +
        +
        +
        +
        + +threshold + + +enum (HarmBlockThreshold) + +
        +
        +

        Required. Controls the probability threshold at which harm is blocked.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "category": enum (HarmCategory),
+  "threshold": enum (HarmBlockThreshold)
+}
        +
        +
        +
        +

        HarmBlockThreshold

        +
        +

        Block at and beyond a specified harm probability.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        HARM_BLOCK_THRESHOLD_UNSPECIFIEDThreshold is unspecified.
        BLOCK_LOW_AND_ABOVEContent with NEGLIGIBLE will be allowed.
        BLOCK_MEDIUM_AND_ABOVEContent with NEGLIGIBLE and LOW will be allowed.
        BLOCK_ONLY_HIGHContent with NEGLIGIBLE, LOW, and MEDIUM will be allowed.
        BLOCK_NONEAll content will be allowed.
        OFFTurn off the safety filter.
        +
        +
        +

        ServiceTier

        + + +
        +
        +

        Service tier of the request.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        unspecifiedDefault service tier, which is standard.
        standardStandard service tier.
        flexFlex service tier.
        priorityPriority service tier.
        +
        +
        +

        Content

        + + +
        + +
        +
        +
        +

        The base structured datatype containing multi-part content of a message.

        A Content includes a role field designating the producer of the Content and a parts field containing multi-part data that contains the content of the message turn.

        +
        +
        + + +Fields + + +
        +
        +
        + +parts[] + + +object (Part) + +
        +
        +

        Ordered Parts that constitute a single message. Parts may have different MIME types.

        +
        +
        +
        +
        +
        +
        + +role + + +string + +
        +
        +

        Optional. The producer of the content. Must be either 'user' or 'model'.

        Useful to set for multi-turn conversations, otherwise can be left blank or unset.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "parts": [
+    {
+      object (Part)
+    }
+  ],
+  "role": string
+}
        +
        +
        +
        +

        Part

        +
        +
        +
        +

        A datatype containing media that is part of a multi-part Content message.

        A Part consists of data which has an associated datatype. A Part can only contain one of the accepted types in Part.data.

        A Part must have a fixed IANA MIME type identifying the type and subtype of the media if the inlineData field is filled with raw bytes.

        +
        +
        + + +Fields + + +
        +
        +
        + +thought + + +boolean + +
        +
        +

        Optional. Indicates if the part is thought from the model.

        +
        +
        +
        +
        +
        +
        + +thoughtSignature + + +string (bytes format) + +
        +
        +

        Optional. An opaque signature for the thought so it can be reused in subsequent requests.

        A base64-encoded string.

        +
        +
        +
        +
        +
        +
        + +partMetadata + + +object (Struct format) + +
        +
        +

        Custom metadata associated with the Part. Agents using genai.Part as content representation may need to keep track of the additional information. For example it can be name of a file/source from which the Part originates or a way to multiplex multiple Part streams.

        +
        +
        +
        +
        +
        +
        + +mediaResolution + + +object (MediaResolution) + +
        +
        +

        Optional. Media resolution for the input media.

        +
        +
        +
        +
        +
        +
        + +mediaProcessing + + +enum (MediaProcessing) + +
        +
        +

        Optional. How the model processes this part's media for understanding. Only meaningful for video parts (inlineData or fileData with video mime). Non-video parts ignore this field.

        +
        +
        +
        +
        +
        +
        + +audioTranscription + + +object (AudioTranscription) + +
        +
        +

        Optional. Audio (input or output) transcription. This is only set when this Part contains audio data.

        +
        +
        +
        +
        +
        +
        + +speechMetadata + + +object (SpeechMetadata) + +
        +
        +

        Optional. Metadata applied to text parts to customize how they should be spoken or synthesized, such as specifying speaker identity or speaking style.

        +
        +
        +
        +
        +
        + + +data + + +Union type + + +
        +
        The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +text + + +string + +
        +
        +

        Inline text.

        +
        +
        +
        +
        +
        +
        + +inlineData + + +object (Blob) + +
        +
        +

        Inline media bytes.

        +
        +
        +
        +
        +
        +
        + +functionCall + + +object (FunctionCall) + +
        +
        +

        A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name with the arguments and their values.

        +
        +
        +
        +
        +
        +
        + +functionResponse + + +object (FunctionResponse) + +
        +
        +

        The result output of a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model.

        +
        +
        +
        +
        +
        +
        + +fileData + + +object (FileData) + +
        +
        +

        URI based data.

        +
        +
        +
        +
        +
        +
        + +executableCode + + +object (ExecutableCode) + +
        +
        +

        Code generated by the model that is meant to be executed.

        +
        +
        +
        +
        +
        +
        + +codeExecutionResult + + +object (CodeExecutionResult) + +
        +
        +

        Result of executing the ExecutableCode.

        +
        +
        +
        +
        +
        +
        + +toolCall + + +object (ToolCall) + +
        +
        +

        Server-side tool call. This field is populated when the model predicts a tool invocation that should be executed on the server. The client is expected to echo this message back to the API.

        +
        +
        +
        +
        +
        +
        + +toolResponse + + +object (ToolResponse) + +
        +
        +

        The output from a server-side ToolCall execution. This field is populated by the client with the results of executing the corresponding ToolCall.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        + + +metadata + + +Union type + + +
        +
        Controls extra preprocessing of data. Set this when inline_data or file_data is present to configure per-part static media preprocessing. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +videoMetadata + + +object (VideoMetadata) + +
        +
        +

        Optional. Video metadata. The metadata should only be specified while the video data is presented in inlineData or fileData.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "thought": boolean,
+  "thoughtSignature": string,
+  "partMetadata": {
+    object
+  },
+  "mediaResolution": {
+    object (MediaResolution)
+  },
+  "mediaProcessing": enum (MediaProcessing),
+  "audioTranscription": {
+    object (AudioTranscription)
+  },
+  "speechMetadata": {
+    object (SpeechMetadata)
+  },
+
+  // data
+  "text": string,
+  "inlineData": {
+    object (Blob)
+  },
+  "functionCall": {
+    object (FunctionCall)
+  },
+  "functionResponse": {
+    object (FunctionResponse)
+  },
+  "fileData": {
+    object (FileData)
+  },
+  "executableCode": {
+    object (ExecutableCode)
+  },
+  "codeExecutionResult": {
+    object (CodeExecutionResult)
+  },
+  "toolCall": {
+    object (ToolCall)
+  },
+  "toolResponse": {
+    object (ToolResponse)
+  }
+  // Union type
+
+  // metadata
+  "videoMetadata": {
+    object (VideoMetadata)
+  }
+  // Union type
+}
        +
        +
        +
        +

        Blob

        +
        +
        +
        +

        Raw media bytes.

        Text should not be sent as raw bytes, use the 'text' field.

        +
        +
        + + +Fields + + +
        +
        +
        + +mimeType + + +string + +
        +
        +

        The IANA standard MIME type of the source data. Examples of supported types: - Images: image/png, image/jpeg, image/jpg, image/webp, image/heic, image/heif, image/gif, image/avif - Audio: audio/*, video/audio/s16le, video/audio/wav - Video: video/* - Text: text/plain, text/html, text/css, text/javascript, text/x-typescript, text/csv, text/markdown, text/x-python, text/xml, text/rtf, video/text/timestamp - Applications: application/x-javascript, application/x-typescript, application/x-python-code, application/json, application/x-ipynb+json, application/rtf, application/pdf For additional context, see Supported file formats. //

        +
        +
        +
        +
        +
        +
        + +data + + +string (bytes format) + +
        +
        +

        Raw bytes for media formats.

        A base64-encoded string.

        +
        +
        +
        +
        +
        +
        + +displayName + + +string + +
        +
        +

        Optional. Specifies the name used to refer to this blob to the model (e.g. "my_blob.png"). Used as the blob reference identifier when verbalizationMode is set to REFERENCE_ONLY.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "mimeType": string,
+  "data": string,
+  "displayName": string
+}
        +
        +
        +
        +

        FunctionCall

        +
        +
        +
        +

        A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name with the arguments and their values.

        +
        +
        + + +Fields + + +
        +
        +
        + +id + + +string + +
        +
        +

        Optional. Unique identifier of the function call. If populated, the client to execute the functionCall and return the response with the matching id.

        +
        +
        +
        +
        +
        +
        + +name + + +string + +
        +
        +

        Required. The name of the function to call. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 128.

        +
        +
        +
        +
        +
        +
        + +args + + +object (Struct format) + +
        +
        +

        Optional. The function parameters and values in JSON object format.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "id": string,
+  "name": string,
+  "args": {
+    object
+  }
+}
        +
        +
        +
        +

        FunctionResponse

        +
        +
        +
        +

        The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of aFunctionCall made based on model prediction.

        +
        +
        + + +Fields + + +
        +
        +
        + +id + + +string + +
        +
        +

        Optional. The identifier of the function call this response is for. Populated by the client to match the corresponding function call id.

        +
        +
        +
        +
        +
        +
        + +name + + +string + +
        +
        +

        Required. The name of the function to call. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 128.

        +
        +
        +
        +
        +
        +
        + +response + + +object (Struct format) + +
        +
        +

        Required. The function response in JSON object format. Callers can use any keys of their choice that fit the function's syntax to return the function output, e.g. "output", "result", etc. In particular, if the function call failed to execute, the response can have an "error" key to return error details to the model.

        Multimedia can be included by using a subobject containing a single "$ref" key whose value is the inlineData.display_name of a FunctionResponsePart holding the multimedia. See https://ai.google.dev/gemini-api/docs/function-calling#multimodal.

        +
        +
        +
        +
        +
        +
        + +parts[] + + +object (FunctionResponsePart) + +
        +
        +

        Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

        +
        +
        +
        +
        +
        +
        + +willContinue + + +boolean + +
        +
        +

        Optional. Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty response with willContinue=False to signal that the function call is finished. This may still trigger the model generation. To avoid triggering the generation and finish the function call, additionally set scheduling to SILENT.

        +
        +
        +
        +
        +
        +
        + +scheduling + + +enum (Scheduling) + +
        +
        +

        Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "id": string,
+  "name": string,
+  "response": {
+    object
+  },
+  "parts": [
+    {
+      object (FunctionResponsePart)
+    }
+  ],
+  "willContinue": boolean,
+  "scheduling": enum (Scheduling)
+}
        +
        +
        +
        +

        FunctionResponsePart

        +
        +
        +
        +

        A datatype containing media that is part of a FunctionResponse message.

        A FunctionResponsePart consists of data which has an associated datatype. A FunctionResponsePart can only contain one of the accepted types in FunctionResponsePart.data.

        A FunctionResponsePart must have a fixed IANA MIME type identifying the type and subtype of the media if the inlineData field is filled with raw bytes.

        +
        +
        + + +Fields + + +
        +
        + + +data + + +Union type + + +
        +
        The data of the function response part. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +inlineData + + +object (FunctionResponseBlob) + +
        +
        +

        Inline media bytes.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+
+  // data
+  "inlineData": {
+    object (FunctionResponseBlob)
+  }
+  // Union type
+}
        +
        +
        +
        +

        FunctionResponseBlob

        +
        +
        +
        +

        Raw media bytes for function response.

        Text should not be sent as raw bytes, use the 'FunctionResponse.response' field.

        +
        +
        + + +Fields + + +
        +
        +
        + +mimeType + + +string + +
        +
        +

        The IANA standard MIME type of the source data. Examples: - image/png - image/jpeg If an unsupported MIME type is provided, an error will be returned. For a complete list of supported types, see Supported file formats.

        +
        +
        +
        +
        +
        +
        + +data + + +string (bytes format) + +
        +
        +

        Raw bytes for media formats.

        A base64-encoded string.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "mimeType": string,
+  "data": string
+}
        +
        +
        +
        +

        Scheduling

        +
        +

        Specifies how the response should be scheduled in the conversation.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        SCHEDULING_UNSPECIFIEDThis value is unused.
        SILENTOnly add the result to the conversation context, do not interrupt or trigger generation.
        WHEN_IDLEAdd the result to the conversation context, and prompt to generate output without interrupting ongoing generation.
        INTERRUPTAdd the result to the conversation context, interrupt ongoing generation and prompt to generate output.
        +
        +

        FileData

        +
        +
        +
        +

        URI based data.

        +
        +
        + + +Fields + + +
        +
        +
        + +mimeType + + +string + +
        +
        +

        Optional. The IANA standard MIME type of the source data.

        +
        +
        +
        +
        +
        +
        + +fileUri + + +string + +
        +
        +

        Required. URI.

        +
        +
        +
        +
        +
        +
        + +displayName + + +string + +
        +
        +

        Optional. Specifies the name used to refer to this file to the model (e.g. "my_file.pdf"). Used as the file reference identifier when verbalizationMode is set to REFERENCE_ONLY.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "mimeType": string,
+  "fileUri": string,
+  "displayName": string
+}
        +
        +
        +
        +

        ExecutableCode

        +
        +
        +
        +

        Code generated by the model that is meant to be executed, and the result returned to the model.

        Only generated when using the CodeExecution tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated.

        +
        +
        + + +Fields + + +
        +
        +
        + +id + + +string + +
        +
        +

        Optional. Unique identifier of the ExecutableCode part. The server returns the CodeExecutionResult with the matching id.

        +
        +
        +
        +
        +
        +
        + +language + + +enum (Language) + +
        +
        +

        Required. Programming language of the code.

        +
        +
        +
        +
        +
        +
        + +code + + +string + +
        +
        +

        Required. The code to be executed.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "id": string,
+  "language": enum (Language),
+  "code": string
+}
        +
        +
        +
        +

        Language

        +
        +

        Supported programming languages for the generated code.

        +
        +
        + ++++ + + + + + + + + + + + + + + + +
        Enums
        LANGUAGE_UNSPECIFIEDUnspecified language. This value should not be used.
        PYTHONPython >= 3.10, with numpy and simpy available. Python is the default language.
        +
        +

        CodeExecutionResult

        +
        +
        +
        +

        Result of executing the ExecutableCode.

        Generated only when the CodeExecution tool is used.

        +
        +
        + + +Fields + + +
        +
        +
        + +id + + +string + +
        +
        +

        Optional. The identifier of the ExecutableCode part this result is for. Only populated if the corresponding ExecutableCode has an id.

        +
        +
        +
        +
        +
        +
        + +outcome + + +enum (Outcome) + +
        +
        +

        Required. Outcome of the code execution.

        +
        +
        +
        +
        +
        +
        + +output + + +string + +
        +
        +

        Optional. Contains stdout when code execution is successful, stderr or other description otherwise.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "id": string,
+  "outcome": enum (Outcome),
+  "output": string
+}
        +
        +
        +
        +

        Outcome

        +
        +

        Enumeration of possible outcomes of the code execution.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        OUTCOME_UNSPECIFIEDUnspecified status. This value should not be used.
        OUTCOME_OKCode execution completed successfully. output contains the stdout, if any.
        OUTCOME_FAILEDCode execution failed. output contains the stderr and stdout, if any.
        OUTCOME_DEADLINE_EXCEEDEDCode execution ran for too long, and was cancelled. There may or may not be a partial output present.
        +
        +

        ToolCall

        +
        +
        +
        +

        A predicted server-side ToolCall returned from the model. This message contains information about a tool that the model wants to invoke. The client is NOT expected to execute this ToolCall. Instead, the client should pass this ToolCall back to the API in a subsequent turn within a Content message, along with the corresponding ToolResponse.

        +
        +
        + + +Fields + + +
        +
        +
        + +id + + +string + +
        +
        +

        Optional. Unique identifier of the tool call. The server returns the tool response with the matching id.

        +
        +
        +
        +
        +
        +
        + +toolName + + +string + +
        +
        +

        Optional. The name of the tool that was called.

        +
        +
        +
        +
        +
        +
        + +toolType + + +enum (ToolType) + +
        +
        +

        Required. The type of tool that was called.

        +
        +
        +
        +
        +
        +
        + +args + + +object (Struct format) + +
        +
        +

        Optional. The tool call arguments. Example: {"arg1" : "value1", "arg2" : "value2" , ...}

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "id": string,
+  "toolName": string,
+  "toolType": enum (ToolType),
+  "args": {
+    object
+  }
+}
        +
        +
        +
        +

        ToolType

        +
        +

        The type of tool in the function call.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        TOOL_TYPE_UNSPECIFIEDUnspecified tool type.
        GOOGLE_SEARCH_WEBGoogle search tool, maps to Tool.google_search.search_types.web_search.
        GOOGLE_SEARCH_IMAGEImage search tool, maps to Tool.google_search.search_types.image_search.
        URL_CONTEXTURL context tool, maps to Tool.url_context.
        GOOGLE_MAPSGoogle maps tool, maps to Tool.google_maps.
        +
        +

        ToolResponse

        +
        +
        +
        +

        The output from a server-side ToolCall execution. This message contains the results of a tool invocation that was initiated by a ToolCall from the model. The client should pass this ToolResponse back to the API in a subsequent turn within a Content message, along with the corresponding ToolCall.

        +
        +
        + + +Fields + + +
        +
        +
        + +id + + +string + +
        +
        +

        Optional. The identifier of the tool call this response is for.

        +
        +
        +
        +
        +
        +
        + +toolType + + +enum (ToolType) + +
        +
        +

        Required. The type of tool that was called, matching the toolType in the corresponding ToolCall.

        +
        +
        +
        +
        +
        +
        + +response + + +object (Struct format) + +
        +
        +

        Optional. The tool response.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "id": string,
+  "toolType": enum (ToolType),
+  "response": {
+    object
+  }
+}
        +
        +
        +
        +

        VideoMetadata

        +
        +
        +
        +

        Metadata describes the input video content. Set this in Part.video_metadata or FunctionResponsePart.video_metadata when inlineData or fileData contains video to configure static video preprocessing (such as time clipping, frame rate, maximum frame count, or extracted content layers).

        +
        +
        + + +Fields + + +
        +
        +
        + +startOffset + + +string (Duration format) + +
        +
        +

        Optional. The start offset of the video.

        A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

        +
        +
        +
        +
        +
        +
        + +endOffset + + +string (Duration format) + +
        +
        +

        Optional. The end offset of the video.

        A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

        +
        +
        +
        +
        +
        +
        + +fps + + +number + +
        +
        +

        Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "startOffset": string,
+  "endOffset": string,
+  "fps": number
+}
        +
        +
        +
        +

        MediaResolution

        +
        +
        +
        +

        Media resolution for tokenization.

        +
        +
        + + +Fields + + +
        +
        + + +value + + +Union type + + +
        +
        The media resolution level. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +level + + +enum (Level) + +
        +
        +

        The tokenization quality used for given media. for Gemini API support .

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+
+  // value
+  "level": enum (Level)
+  // Union type
+}
        +
        +
        +
        +

        Level

        +
        +

        The media resolution level.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        MEDIA_RESOLUTION_UNSPECIFIEDMedia resolution has not been set.
        MEDIA_RESOLUTION_LOWMedia resolution set to low.
        MEDIA_RESOLUTION_MEDIUMMedia resolution set to medium.
        MEDIA_RESOLUTION_HIGHMedia resolution set to high.
        MEDIA_RESOLUTION_ULTRA_HIGHMedia resolution set to ultra high.
        +
        +

        MediaProcessing

        +
        +

        How the model processes input media for understanding.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + +
        Enums
        MEDIA_PROCESSING_UNSPECIFIEDDefaults to model-specific processing.
        STATICFixed-rate frame extraction. All frames placed in context.
        AGENTICModel-driven dynamic navigation. Recommended for most use cases.
        +
        +

        AudioTranscription

        +
        +
        +
        +

        The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speakerLabel.

        +
        +
        + + +Fields + + +
        +
        +
        + +text + + +string + +
        +
        +

        Required. The transcription text of this audio segment.

        +
        +
        +
        +
        +
        +
        + +speakerLabel + + +string + +
        +
        +

        Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set.

        +
        +
        +
        +
        +
        +
        + +words[] + + +object (WordInfo) + +
        +
        +

        Optional. Detailed word-level transcriptions and timing details. Present when wordTimestamp is set.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "text": string,
+  "speakerLabel": string,
+  "words": [
+    {
+      object (WordInfo)
+    }
+  ]
+}
        +
        +
        +
        +

        WordInfo

        +
        +
        +
        +

        Information about a single recognized word.

        +
        +
        + + +Fields + + +
        +
        +
        + +word + + +string + +
        +
        +

        Required. Transcript of the word.

        +
        +
        +
        +
        +
        +
        + +startOffset + + +string (Duration format) + +
        +
        +

        Optional. Start offset in time of the word relative to the start of the audio.

        A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

        +
        +
        +
        +
        +
        +
        + +endOffset + + +string (Duration format) + +
        +
        +

        Optional. End offset in time of the word relative to the start of the audio.

        A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "word": string,
+  "startOffset": string,
+  "endOffset": string
+}
        +
        +
        +
        +

        SpeechMetadata

        +
        +
        +
        +

        Speech metadata for text parts.

        +
        +
        + + +Fields + + +
        +
        +
        + +speaker + + +string + +
        +
        +

        Optional. Optional speaker name for multi-speaker synthesis.

        +
        +
        +
        +
        +
        +
        + +style + + +string + +
        +
        +

        Optional. Optional style instruction for the speech synthesis.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "speaker": string,
+  "style": string
+}
        +
        +
        +
        +
        +

        Environment

        + + +
        + +
        +
        +
        +

        An execution environment for an agent.

        +
        +
        + + +Fields + + +
        +
        +
        + +id + + +string + +
        +
        +

        Required. Output only. The ID of the environment.

        +
        +
        +
        +
        +
        +
        + +sources[] + + +object (Source) + +
        +
        +

        Sources to be mounted into the environment.

        +
        +
        +
        +
        +
        +
        + +created + + +string + +
        +
        +

        Output only. The time at which the environment was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

        +
        +
        +
        +
        +
        +
        + +updated + + +string + +
        +
        +

        Output only. The time at which the environment was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

        +
        +
        +
        +
        +
        +
        + +lastAccessed + + +string + +
        +
        +

        Output only. The time at which the environment was last accessed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

        +
        +
        +
        +
        +
        +
        + +status + + +enum (Status) + +
        +
        +

        Output only. The status of the environment container.

        +
        +
        +
        +
        +
        +
        + +fileCount + + +string (int64 format) + +
        +
        +

        Output only. The number of files in the environment, output only.

        +
        +
        +
        +
        +
        +
        + +sizeBytes + + +string (int64 format) + +
        +
        +

        Output only. The total size of the environment files in bytes, output only.

        +
        +
        +
        +
        +
        + + +network + + +Union type + + +
        +
        Network configuration for the environment. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +networkAllowlist + + +object (EnvironmentNetworkEgressAllowlist) + +
        +
        +

        Allow only specific domains.

        +
        +
        +
        +
        +
        +
        + +networkMode + + +enum (NetworkMode) + +
        +
        +

        Network egress mode.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "id": string,
+  "sources": [
+    {
+      object (Source)
+    }
+  ],
+  "created": string,
+  "updated": string,
+  "lastAccessed": string,
+  "status": enum (Status),
+  "fileCount": string,
+  "sizeBytes": string,
+
+  // network
+  "networkAllowlist": {
+    object (EnvironmentNetworkEgressAllowlist)
+  },
+  "networkMode": enum (NetworkMode)
+  // Union type
+}
        +
        +
        +
        +

        Status

        +
        +

        Status of the environment.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + +
        Enums
        STATUS_UNSPECIFIED
        ACTIVE
        EXPIRED
        +
        +
        +

        NetworkMode

        + + +
        +
        +

        Network egress mode for non-allowlist configurations.

        +
        +
        + ++++ + + + + + + + + + + + + + + + +
        Enums
        NETWORK_MODE_UNSPECIFIEDDefault value. Unused.
        DISABLEDAll network egress is blocked.
        +
        +
        +

        Schema

        + + +
        + +
        +
        +
        +

        The Schema object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an OpenAPI 3.0 schema object.

        +
        +
        + + +Fields + + +
        +
        +
        + +type + + +enum (Type) + +
        +
        +

        Required. Data type.

        +
        +
        +
        +
        +
        +
        + +format + + +string + +
        +
        +

        Optional. The format of the data. Any value is allowed, but most do not trigger any special functionality.

        +
        +
        +
        +
        +
        +
        + +title + + +string + +
        +
        +

        Optional. The title of the schema.

        +
        +
        +
        +
        +
        +
        + +description + + +string + +
        +
        +

        Optional. A brief description of the parameter. This could contain examples of use. Parameter description may be formatted as Markdown.

        +
        +
        +
        +
        +
        +
        + +nullable + + +boolean + +
        +
        +

        Optional. Indicates if the value may be null.

        +
        +
        +
        +
        +
        +
        + +enum[] + + +string + +
        +
        +

        Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

        +
        +
        +
        +
        +
        +
        + +maxItems + + +string (int64 format) + +
        +
        +

        Optional. Maximum number of the elements for Type.ARRAY.

        +
        +
        +
        +
        +
        +
        + +minItems + + +string (int64 format) + +
        +
        +

        Optional. Minimum number of the elements for Type.ARRAY.

        +
        +
        +
        +
        +
        +
        + +properties + + +map (key: string, value: object (Schema)) + +
        +
        +

        Optional. Properties of Type.OBJECT.

        An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

        +
        +
        +
        +
        +
        +
        + +required[] + + +string + +
        +
        +

        Optional. Required properties of Type.OBJECT.

        +
        +
        +
        +
        +
        +
        + +minProperties + + +string (int64 format) + +
        +
        +

        Optional. Minimum number of the properties for Type.OBJECT.

        +
        +
        +
        +
        +
        +
        + +maxProperties + + +string (int64 format) + +
        +
        +

        Optional. Maximum number of the properties for Type.OBJECT.

        +
        +
        +
        +
        +
        +
        + +minLength + + +string (int64 format) + +
        +
        +

        Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING

        +
        +
        +
        +
        +
        +
        + +maxLength + + +string (int64 format) + +
        +
        +

        Optional. Maximum length of the Type.STRING

        +
        +
        +
        +
        +
        +
        + +pattern + + +string + +
        +
        +

        Optional. Pattern of the Type.STRING to restrict a string to a regular expression.

        +
        +
        +
        +
        +
        +
        + +example + + +value (Value format) + +
        +
        +

        Optional. Example of the object. Will only populated when the object is the root.

        +
        +
        +
        +
        +
        +
        + +anyOf[] + + +object (Schema) + +
        +
        +

        Optional. The value should be validated against any (one or more) of the subschemas in the list.

        +
        +
        +
        +
        +
        +
        + +propertyOrdering[] + + +string + +
        +
        +

        Optional. The order of the properties. Not a standard field in open api spec. Used to determine the order of the properties in the response.

        +
        +
        +
        +
        +
        +
        + +default + + +value (Value format) + +
        +
        +

        Optional. Default value of the field. Per JSON Schema, this field is intended for documentation generators and doesn't affect validation. Thus it's included here and ignored so that developers who send schemas with a default field don't get unknown-field errors.

        +
        +
        +
        +
        +
        +
        + +items + + +object (Schema) + +
        +
        +

        Optional. Schema of the elements of Type.ARRAY.

        +
        +
        +
        +
        +
        +
        + +minimum + + +number + +
        +
        +

        Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER

        +
        +
        +
        +
        +
        +
        + +maximum + + +number + +
        +
        +

        Optional. Maximum value of the Type.INTEGER and Type.NUMBER

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "type": enum (Type),
+  "format": string,
+  "title": string,
+  "description": string,
+  "nullable": boolean,
+  "enum": [
+    string
+  ],
+  "maxItems": string,
+  "minItems": string,
+  "properties": {
+    string: {
+      object (Schema)
+    },
+    ...
+  },
+  "required": [
+    string
+  ],
+  "minProperties": string,
+  "maxProperties": string,
+  "minLength": string,
+  "maxLength": string,
+  "pattern": string,
+  "example": value,
+  "anyOf": [
+    {
+      object (Schema)
+    }
+  ],
+  "propertyOrdering": [
+    string
+  ],
+  "default": value,
+  "items": {
+    object (Schema)
+  },
+  "minimum": number,
+  "maximum": number
+}
        +
        +
        +
        +

        Type

        +
        +

        Type contains the list of OpenAPI data types as defined by https://spec.openapis.org/oas/v3.0.3#data-types

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        TYPE_UNSPECIFIEDNot specified, should not be used.
        STRINGString type.
        NUMBERNumber type.
        INTEGERInteger type.
        BOOLEANBoolean type.
        ARRAYArray type.
        OBJECTObject type.
        NULLNull type.
        +
        +
        +

        Tool

        + + +
        + +
        +
        +
        +

        Tool details that the model may use to generate response.

        A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

        +
        +
        + + +Fields + + +
        +
        +
        + +functionDeclarations[] + + +object (FunctionDeclaration) + +
        +
        +

        Optional. A list of FunctionDeclarations available to the model that can be used for function calling.

        The model or system does not execute the function. Instead the defined function may be returned as a FunctionCall with arguments to the client side for execution. The model may decide to call a subset of these functions by populating FunctionCall in the response. The next conversation turn may contain a FunctionResponse with the Content.role "function" generation context for the next model turn.

        +
        +
        +
        +
        +
        +
        + +googleSearchRetrieval + + +object (GoogleSearchRetrieval) + +
        +
        +

        Optional. Retrieval tool that is powered by Google search.

        +
        +
        +
        +
        +
        +
        + +codeExecution + + +object (CodeExecution) + +
        +
        +

        Optional. Enables the model to execute code as part of generation.

        +
        +
        +
        + +
        +
        +
        + +computerUse + + +object (ComputerUse) + +
        +
        +

        Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.

        +
        +
        +
        +
        +
        +
        + +urlContext + + +object (UrlContext) + +
        +
        +

        Optional. Tool to support URL context retrieval.

        +
        +
        +
        + +
        +
        +
        + +mcpServers[] + + +object (McpServer) + +
        +
        +

        Optional. MCP Servers to connect to.

        +
        +
        +
        +
        +
        +
        + +googleMaps + + +object (GoogleMaps) + +
        +
        +

        Optional. Tool that allows grounding the model's response with geospatial context related to the user's query.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "functionDeclarations": [
+    {
+      object (FunctionDeclaration)
+    }
+  ],
+  "googleSearchRetrieval": {
+    object (GoogleSearchRetrieval)
+  },
+  "codeExecution": {
+    object (CodeExecution)
+  },
+  "googleSearch": {
+    object (GoogleSearch)
+  },
+  "computerUse": {
+    object (ComputerUse)
+  },
+  "urlContext": {
+    object (UrlContext)
+  },
+  "fileSearch": {
+    object (FileSearch)
+  },
+  "mcpServers": [
+    {
+      object (McpServer)
+    }
+  ],
+  "googleMaps": {
+    object (GoogleMaps)
+  }
+}
        +
        +
        +
        +

        FunctionDeclaration

        +
        +
        +
        +

        Structured representation of a function declaration as defined by the OpenAPI 3.03 specification. Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client.

        +
        +
        + + +Fields + + +
        +
        +
        + +name + + +string + +
        +
        +

        Required. The name of the function. Must be a-z, A-Z, 0-9, or contain underscores, colons, dots, and dashes, with a maximum length of 128.

        +
        +
        +
        +
        +
        +
        + +description + + +string + +
        +
        +

        Required. A brief description of the function.

        +
        +
        +
        +
        +
        +
        + +behavior + + +enum (Behavior) + +
        +
        +

        Optional. Specifies the function Behavior. Currently only supported by the BidiGenerateContent method.

        +
        +
        +
        +
        +
        +
        + +parameters + + +object (Schema) + +
        +
        +

        Optional. Describes the parameters to this function. Reflects the Open API 3.03 Parameter Object string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter.

        +
        +
        +
        +
        +
        +
        + +parametersJsonSchema + + +value (Value format) + +
        +
        +

        Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example:

        +
        {
+  "type": "object",
+  "properties": {
+    "name": { "type": "string" },
+    "age": { "type": "integer" }
+  },
+  "additionalProperties": false,
+  "required": ["name", "age"],
+  "propertyOrdering": ["name", "age"]
+}
+
         +

        This field is mutually exclusive with parameters.

        +
        +
        +
        +
        +
        +
        + +response + + +object (Schema) + +
        +
        +

        Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.

        +
        +
        +
        +
        +
        +
        + +responseJsonSchema + + +value (Value format) + +
        +
        +

        Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function.

        This field is mutually exclusive with response.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "name": string,
+  "description": string,
+  "behavior": enum (Behavior),
+  "parameters": {
+    object (Schema)
+  },
+  "parametersJsonSchema": value,
+  "response": {
+    object (Schema)
+  },
+  "responseJsonSchema": value
+}
        +
        +
        +
        +

        Behavior

        +
        +

        Defines the function behavior. Defaults to BLOCKING.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + +
        Enums
        UNSPECIFIEDThis value is unused.
        BLOCKINGIf set, the system will wait to receive the function response before continuing the conversation.
        NON_BLOCKINGIf set, the system will not wait to receive the function response. Instead, it will attempt to handle function responses as they become available while maintaining the conversation between the user and the model.
        +
        +

        GoogleSearchRetrieval

        +
        +
        +
        +

        Tool to retrieve public web data for grounding, powered by Google.

        +
        +
        + + +Fields + + +
        +
        +
        + +dynamicRetrievalConfig + + +object (DynamicRetrievalConfig) + +
        +
        +

        Specifies the dynamic retrieval configuration for the given source.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "dynamicRetrievalConfig": {
+    object (DynamicRetrievalConfig)
+  }
+}
        +
        +
        +
        +

        DynamicRetrievalConfig

        +
        +
        +
        +

        Describes the options to customize dynamic retrieval.

        +
        +
        + + +Fields + + +
        +
        +
        + +mode + + +enum (Mode) + +
        +
        +

        The mode of the predictor to be used in dynamic retrieval.

        +
        +
        +
        +
        +
        +
        + +dynamicThreshold + + +number + +
        +
        +

        The threshold to be used in dynamic retrieval. If not set, a system default value is used.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "mode": enum (Mode),
+  "dynamicThreshold": number
+}
        +
        +
        +
        +

        Mode

        +
        +

        The mode of the predictor to be used in dynamic retrieval.

        +
        +
        + ++++ + + + + + + + + + + + + + + + +
        Enums
        MODE_UNSPECIFIEDAlways trigger retrieval.
        MODE_DYNAMICRun retrieval only when system decides it is necessary.
        +
        +

        CodeExecution

        +

        This type has no fields.

        +
        +
        +
        +

        Tool that executes code generated by the model, and automatically returns the result to the model.

        See also ExecutableCode and CodeExecutionResult which are only generated when using this tool.

        +
        +
        +
        +

        GoogleSearch

        +
        +
        +
        +

        GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.

        +
        +
        + + +Fields + + +
        +
        +
        + +timeRangeFilter + + +object (Interval) + +
        +
        +

        Optional. Filter search results to a specific time range. If customers set a start time, they must set an end time (and vice versa).

        +
        +
        +
        +
        +
        +
        + +searchTypes + + +object (SearchTypes) + +
        +
        +

        Optional. The set of search types to enable. If not set, web search is enabled by default.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "timeRangeFilter": {
+    object (Interval)
+  },
+  "searchTypes": {
+    object (SearchTypes)
+  }
+}
        +
        +
        +
        +

        Interval

        +
        +
        +
        +

        Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).

        The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.

        +
        +
        + + +Fields + + +
        +
        +
        + +startTime + + +string (Timestamp format) + +
        +
        +

        Optional. Inclusive start of the interval.

        If specified, a Timestamp matching this interval will have to be the same or after the start.

        Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

        +
        +
        +
        +
        +
        +
        + +endTime + + +string (Timestamp format) + +
        +
        +

        Optional. Exclusive end of the interval.

        If specified, a Timestamp matching this interval will have to be before the end.

        Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "startTime": string,
+  "endTime": string
+}
        +
        +
        +
        +

        SearchTypes

        +
        +
        +
        +

        Different types of search that can be enabled on the GoogleSearch tool.

        +
        +
        + + +Fields + + + + +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "webSearch": {
+    object (WebSearch)
+  },
+  "imageSearch": {
+    object (ImageSearch)
+  }
+}
        +
        +
        +
        +

        WebSearch

        +

        This type has no fields.

        +
        +
        +
        +

        Standard web search for grounding and related configurations.

        +
        +
        +
        +

        ImageSearch

        +

        This type has no fields.

        +
        +
        +
        +

        Image search for grounding and related configurations.

        +
        +
        +
        +

        ComputerUse

        +
        +
        +
        +

        Computer Use tool type.

        +
        +
        + + +Fields + + +
        +
        +
        + +environment + + +enum (Environment) + +
        +
        +

        Required. The environment being operated.

        +
        +
        +
        +
        +
        +
        + +excludedPredefinedFunctions[] + + +string + +
        +
        +

        Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.

        +
        +
        +
        +
        +
        +
        + +enablePromptInjectionDetection + + +boolean + +
        +
        +

        Optional. Whether enable the prompt injection detection check on computer-use request.

        +
        +
        +
        +
        +
        +
        + +disabledSafetyPolicies[] + + +enum (SafetyPolicy) + +
        +
        +

        Optional. Disabled safety policies for computer use.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "environment": enum (Environment),
+  "excludedPredefinedFunctions": [
+    string
+  ],
+  "enablePromptInjectionDetection": boolean,
+  "disabledSafetyPolicies": [
+    enum (SafetyPolicy)
+  ]
+}
        +
        +
        +
        +

        Environment

        +
        +

        Represents the environment being operated, such as a web browser.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        ENVIRONMENT_UNSPECIFIEDDefaults to browser.
        ENVIRONMENT_BROWSEROperates in a web browser.
        ENVIRONMENT_MOBILEOperates in a mobile environment.
        ENVIRONMENT_DESKTOPOperates in a desktop environment.
        +
        +

        SafetyPolicy

        +
        +

        Predefined safety policies for computer use.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        SAFETY_POLICY_UNSPECIFIEDUnspecified safety policy.
        FINANCIAL_TRANSACTIONSSafety policy for financial transactions.
        SENSITIVE_DATA_MODIFICATIONSafety policy for sensitive data modification.
        COMMUNICATION_TOOLSafety policy for communication tools (e.g. Gmail, Chat, Meet).
        ACCOUNT_CREATIONSafety policy for account creation.
        DATA_MODIFICATIONSafety policy for data modification.
        LEGAL_TERMS_AND_AGREEMENTSSafety policy for legal terms and agreements.
        +
        +

        UrlContext

        +

        This type has no fields.

        +
        +
        +
        +

        Tool to support URL context retrieval.

        +
        +
        +
        +

        FileSearch

        +
        +
        +
        +

        The FileSearch tool that retrieves knowledge from Semantic Retrieval corpora. Files are imported to Semantic Retrieval corpora using the ImportFile API.

        +
        +
        + + +Fields + + +
        +
        +
        + +fileSearchStoreNames[] + + +string + +
        +
        +

        Required. The names of the fileSearchStores to retrieve from. Example: fileSearchStores/my-file-search-store-123

        +
        +
        +
        +
        +
        +
        + +metadataFilter + + +string + +
        +
        +

        Optional. Metadata filter to apply to the semantic retrieval documents and chunks.

        +
        +
        +
        +
        +
        +
        + +topK + + +integer + +
        +
        +

        Optional. The number of semantic retrieval chunks to retrieve.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "fileSearchStoreNames": [
+    string
+  ],
+  "metadataFilter": string,
+  "topK": integer
+}
        +
        +
        +
        +

        McpServer

        +
        +
        +
        +

        A MCPServer is a server that can be called by the model to perform actions. It is a server that implements the MCP protocol.

        +
        +
        + + +Fields + + +
        +
        +
        + +name + + +string + +
        +
        +

        The name of the MCPServer.

        +
        +
        +
        +
        +
        + + +transport + + +Union type + + +
        +
        The transport to use to connect to the MCPServer. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +streamableHttpTransport + + +object (StreamableHttpTransport) + +
        +
        +

        A transport that can stream HTTP requests and responses.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "name": string,
+
+  // transport
+  "streamableHttpTransport": {
+    object (StreamableHttpTransport)
+  }
+  // Union type
+}
        +
        +
        +
        +

        StreamableHttpTransport

        +
        +
        +
        +

        A transport that can stream HTTP requests and responses.

        +
        +
        + + +Fields + + +
        +
        +
        + +url + + +string + +
        +
        +

        The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"

        +
        +
        +
        +
        +
        +
        + +headers + + +map (key: string, value: string) + +
        +
        +

        Optional: Fields for authentication headers, timeouts, etc., if needed.

        An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

        +
        +
        +
        +
        +
        +
        + +timeout + + +string (Duration format) + +
        +
        +

        HTTP timeout for regular operations.

        A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

        +
        +
        +
        +
        +
        +
        + +sseReadTimeout + + +string (Duration format) + +
        +
        +

        Timeout for SSE read operations.

        A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

        +
        +
        +
        +
        +
        +
        + +terminateOnClose + + +boolean + +
        +
        +

        Whether to close the client session when the transport closes.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "url": string,
+  "headers": {
+    string: string,
+    ...
+  },
+  "timeout": string,
+  "sseReadTimeout": string,
+  "terminateOnClose": boolean
+}
        +
        +
        +
        +

        GoogleMaps

        +
        +
        +
        +

        The GoogleMaps Tool that provides geospatial context for the user's query.

        +
        +
        + + +Fields + + +
        +
        +
        + +enableWidget + + +boolean + +
        +
        +

        Optional. Whether to return a widget context token in the GroundingMetadata of the response. Developers can use the widget context token to render a Google Maps widget with geospatial context related to the places that the model references in the response.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "enableWidget": boolean
+}
        +
        +
        +
        +
        +

        REST Resource: auth_tokens

        + + +
        + +
        +

        Resource: AuthToken

        +
        +
        +
        +

        A request to create an ephemeral authentication token.

        +
        +
        + + +Fields + + +
        +
        +
        + +name + + +string + +
        +
        +

        Output only. Identifier. The token itself.

        +
        +
        +
        +
        +
        +
        + +expireTime + + +string (Timestamp format) + +
        +
        +

        Optional. Input only. Immutable. An optional time after which, when using the resulting token, messages in BidiGenerateContent sessions will be rejected. (Gemini may preemptively close the session after this time.)

        If not set then this defaults to 30 minutes in the future. If set, this value must be less than 20 hours in the future.

        Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

        +
        +
        +
        +
        +
        +
        + +newSessionExpireTime + + +string (Timestamp format) + +
        +
        +

        Optional. Input only. Immutable. The time after which new Live API sessions using the token resulting from this request will be rejected.

        If not set this defaults to 60 seconds in the future. If set, this value must be less than 20 hours in the future.

        Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

        +
        +
        +
        +
        +
        +
        + +fieldMask + + +string (FieldMask format) + +
        +
        +

        Optional. Input only. Immutable. If fieldMask is empty, and bidiGenerateContentSetup is not present, then the effective BidiGenerateContentSetup message is taken from the Live API connection.

        If fieldMask is empty, and bidiGenerateContentSetup is present, then the effective BidiGenerateContentSetup message is taken entirely from bidiGenerateContentSetup in this request. The setup message from the Live API connection is ignored.

        If fieldMask is not empty, then the corresponding fields from bidiGenerateContentSetup will overwrite the fields from the setup message in the Live API connection.

        This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

        +
        +
        +
        +
        +
        + + +config + + +Union type + + +
        +
        The method-specific configuration for the resulting token. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +bidiGenerateContentSetup + + +object (BidiGenerateContentSetup) + +
        +
        +

        Optional. Input only. Immutable. Configuration specific to BidiGenerateContent.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        + +uses + + +integer + +
        +
        +

        Optional. Input only. Immutable. The number of times the token can be used. If this value is zero then no limit is applied. Resuming a Live API session does not count as a use. If unspecified, the default is 1.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "name": string,
+  "expireTime": string,
+  "newSessionExpireTime": string,
+  "fieldMask": string,
+
+  // config
+  "bidiGenerateContentSetup": {
+    object (BidiGenerateContentSetup)
+  }
+  // Union type
+  "uses": integer
+}
        +
        +
        +
        +
        +
        +

        BidiGenerateContentSetup

        +
        +
        +
        +

        Message to be sent in the first (and only in the first) BidiGenerateContentClientMessage. Contains configuration that will apply for the duration of the streaming RPC.

        Clients should wait for a BidiGenerateContentSetupComplete message before sending any additional messages.

        +
        +
        + + +Fields + + +
        +
        +
        + +model + + +string + +
        +
        +

        Required. The model's resource name. This serves as an ID for the Model to use.

        Format: models/{model}

        +
        +
        +
        +
        +
        +
        + +generationConfig + + +object (GenerationConfig) + +
        +
        +

        Optional. Generation config.

        The following fields are not supported:

        +
          +
        • responseLogprobs
          • +
        • responseMimeType
          • +
        • logprobs
          • +
        • responseSchema
          • +
        • responseJsonSchema
          • +
        • stop_sequence
          • +
        • skipResponseCache
          • +
        • routing_config
          • +
        • audio_timestamp
          • +
        +
        +
        +
        +
        +
        +
        + +systemInstruction + + +object (Content) + +
        +
        +

        Optional. The user provided system instructions for the model.

        Note: Only text should be used in parts and content in each part will be in a separate paragraph.

        +
        +
        +
        +
        +
        +
        + +tools[] + + +object (Tool) + +
        +
        +

        Optional. A list of Tools the model may use to generate the next response.

        A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

        +
        +
        +
        +
        +
        +
        + +realtimeInputConfig + + +object (RealtimeInputConfig) + +
        +
        +

        Optional. Configures the handling of realtime input.

        +
        +
        +
        +
        +
        +
        + +sessionResumption + + +object (SessionResumptionConfig) + +
        +
        +

        Optional. Configures session resumption mechanism.

        If included, the server will send SessionResumptionUpdate messages.

        +
        +
        +
        +
        +
        +
        + +contextWindowCompression + + +object (ContextWindowCompressionConfig) + +
        +
        +

        Optional. Configures a context window compression mechanism.

        If included, the server will automatically reduce the size of the context when it exceeds the configured length.

        +
        +
        +
        +
        +
        +
        + +inputAudioTranscription + + +object (AudioTranscriptionConfig) + +
        +
        +

        Optional. If set, enables transcription of voice input. The transcription aligns with the input audio language, if configured.

        +
        +
        +
        +
        +
        +
        + +outputAudioTranscription + + +object (AudioTranscriptionConfig) + +
        +
        +

        Optional. If set, enables transcription of the model's audio output. The transcription aligns with the language code specified for the output audio, if configured.

        +
        +
        +
        +
        +
        +
        + +historyConfig + + +object (HistoryConfig) + +
        +
        +

        Optional. Configures the exchange of history between the client and the server.

        +
        +
        +
        +
        +
        +
        + +labels + + +map (key: string, value: string) + +
        +
        +

        Optional. Labels with user-defined metadata for the request.

        Optional. Labels must follow standard unified Cloud label requirements: - Label keys must start with a letter. - Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. - International characters are allowed.

        Usage: - Safety identifiers from aggregators: Use the key safety_identifier (e.g. {"safety_identifier": "user_session_123"})

        An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "model": string,
+  "generationConfig": {
+    object (GenerationConfig)
+  },
+  "systemInstruction": {
+    object (Content)
+  },
+  "tools": [
+    {
+      object (Tool)
+    }
+  ],
+  "realtimeInputConfig": {
+    object (RealtimeInputConfig)
+  },
+  "sessionResumption": {
+    object (SessionResumptionConfig)
+  },
+  "contextWindowCompression": {
+    object (ContextWindowCompressionConfig)
+  },
+  "inputAudioTranscription": {
+    object (AudioTranscriptionConfig)
+  },
+  "outputAudioTranscription": {
+    object (AudioTranscriptionConfig)
+  },
+  "historyConfig": {
+    object (HistoryConfig)
+  },
+  "labels": {
+    string: string,
+    ...
+  }
+}
        +
        +
        +
        +
        +
        +

        GenerationConfig

        +
        +
        +
        +

        Configuration options for model generation and outputs. Not all parameters are configurable for every model.

        +
        +
        + + +Fields + + +
        +
        +
        + +stopSequences[] + + +string + +
        +
        +

        Optional. The set of character sequences (up to 5) that will stop output generation. If specified, the API will stop at the first appearance of a stop_sequence. The stop sequence will not be included as part of the response.

        +
        +
        +
        +
        +
        +
        + +responseMimeType + + +string + +
        +
        +

        Optional. MIME type of the generated candidate text. Supported MIME types are: text/plain: (default) Text output. application/json: JSON response in the response candidates. text/x.enum: ENUM as a string response in the response candidates. Refer to the docs for a list of all supported text MIME types.

        +
        +
        +
        +
        +
        +
        + +responseSchema
        (deprecated)         +         + +object (Schema) + +
        +
        + +

        Optional. Output schema of the generated candidate text. Schemas must be a subset of the OpenAPI schema and can be objects, primitives or arrays.

        If set, a compatible responseMimeType must also be set. Compatible MIME types: application/json: Schema for JSON response. Refer to the JSON text generation guide for more details.

        Deprecated. Use responseFormat instead.

        +
        +
        +
        +
        +
        +
        + +_responseJsonSchema
        (deprecated)         +         + +value (Value format) + +
        +
        + +

        Optional. Output schema of the generated response. This is an alternative to responseSchema that accepts JSON Schema.

        If set, responseSchema must be omitted, but responseMimeType is required.

        While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported:

        +
          +
        • $id
          • +
        • $defs
          • +
        • $ref
          • +
        • $anchor
          • +
        • type
          • +
        • format
          • +
        • title
          • +
        • description
          • +
        • enum (for strings and numbers)
          • +
        • items
          • +
        • prefixItems
          • +
        • minItems
          • +
        • maxItems
          • +
        • minimum
          • +
        • maximum
          • +
        • anyOf
          • +
        • oneOf (interpreted the same as anyOf)
          • +
        • properties
          • +
        • additionalProperties
          • +
        • required
          • +

        The non-standard propertyOrdering property may also be set.

        Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If $ref is set on a sub-schema, no other properties, except for than those starting as a $, may be set.

        Deprecated. Use responseFormat instead.

        +
        +
        +
        +
        +
        +
        + +responseJsonSchema + + +value (Value format) + +
        +
        +

        Optional. An internal detail. Use responseJsonSchema rather than this field.

        +
        +
        +
        +
        +
        +
        + +responseModalities[] + + +enum (Modality) + +
        +
        +

        Optional. The requested modalities of the response. Represents the set of modalities that the model can return, and should be expected in the response. This is an exact match to the modalities of the response.

        A model may have multiple combinations of supported modalities. If the requested modalities do not match any of the supported combinations, an error will be returned.

        An empty list is equivalent to requesting only text.

        +
        +
        +
        +
        +
        +
        + +candidateCount + + +integer + +
        +
        +

        Optional. Number of generated responses to return. If unset, this will default to 1. Please note that this doesn't work for previous generation models (Gemini 1.0 family)

        +
        +
        +
        +
        +
        +
        + +maxOutputTokens + + +integer + +
        +
        +

        Optional. The maximum number of tokens to include in a response candidate.

        Note: The default value varies by model, see the Model.output_token_limit attribute of the Model returned from the getModel function.

        +
        +
        +
        +
        +
        +
        + +temperature + + +number + +
        +
        +

        Optional. Controls the randomness of the output.

        Note: The default value varies by model, see the Model.temperature attribute of the Model returned from the getModel function.

        Values can range from [0.0, 2.0].

        This field is no longer supported and is silently ignored on Gemini 3.6 Flash and newer models.

        +
        +
        +
        +
        +
        +
        + +topP + + +number + +
        +
        +

        Optional. The maximum cumulative probability of tokens to consider when sampling.

        The model uses combined Top-k and Top-p (nucleus) sampling.

        Tokens are sorted based on their assigned probabilities so that only the most likely tokens are considered. Top-k sampling directly limits the maximum number of tokens to consider, while Nucleus sampling limits the number of tokens based on the cumulative probability.

        Note: The default value varies by Model and is specified by theModel.top_p attribute returned from the getModel function. An empty topK attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting topK on requests.

        This field is no longer supported and is silently ignored on Gemini 3.6 Flash and newer models.

        +
        +
        +
        +
        +
        +
        + +topK + + +integer + +
        +
        +

        Optional. The maximum number of tokens to consider when sampling.

        Gemini models use Top-p (nucleus) sampling or a combination of Top-k and nucleus sampling. Top-k sampling considers the set of topK most probable tokens. Models running with nucleus sampling don't allow topK setting.

        Note: The default value varies by Model and is specified by theModel.top_p attribute returned from the getModel function. An empty topK attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting topK on requests.

        This field is no longer supported and is silently ignored on Gemini 3.6 Flash and newer models.

        +
        +
        +
        +
        +
        +
        + +seed + + +integer + +
        +
        +

        Optional. Seed used in decoding. If not set, the request uses a randomly generated seed.

        +
        +
        +
        +
        +
        +
        + +presencePenalty + + +number + +
        +
        +

        Optional. Presence penalty applied to the next token's logprobs if the token has already been seen in the response.

        This penalty is binary on/off and not dependant on the number of times the token is used (after the first). Use frequencyPenalty for a penalty that increases with each use.

        A positive penalty will discourage the use of tokens that have already been used in the response, increasing the vocabulary.

        A negative penalty will encourage the use of tokens that have already been used in the response, decreasing the vocabulary.

        +
        +
        +
        +
        +
        +
        + +frequencyPenalty + + +number + +
        +
        +

        Optional. Frequency penalty applied to the next token's logprobs, multiplied by the number of times each token has been seen in the respponse so far.

        A positive penalty will discourage the use of tokens that have already been used, proportional to the number of times the token has been used: The more a token is used, the more difficult it is for the model to use that token again increasing the vocabulary of responses.

        Caution: A negative penalty will encourage the model to reuse tokens proportional to the number of times the token has been used. Small negative values will reduce the vocabulary of a response. Larger negative values will cause the model to start repeating a common token until it hits the maxOutputTokens limit.

        +
        +
        +
        +
        +
        +
        + +responseLogprobs + + +boolean + +
        +
        +

        Optional. If true, export the logprobs results in response.

        +
        +
        +
        +
        +
        +
        + +logprobs + + +integer + +
        +
        +

        Optional. Only valid if responseLogprobs=True. This sets the number of top logprobs, including the chosen candidate, to return at each decoding step in the Candidate.logprobs_result. The number must be in the range of [0, 20].

        +
        +
        +
        +
        +
        +
        + +enableEnhancedCivicAnswers + + +boolean + +
        +
        +

        Optional. Enables enhanced civic answers. It may not be available for all models.

        +
        +
        +
        +
        +
        +
        + +speechConfig + + +object (SpeechConfig) + +
        +
        +

        Optional. The speech generation config.

        +
        +
        +
        +
        +
        +
        + +thinkingConfig + + +object (ThinkingConfig) + +
        +
        +

        Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.

        +
        +
        +
        +
        +
        +
        + +imageConfig + + +object (ImageConfig) + +
        +
        +

        Optional. Config for image generation. An error will be returned if this field is set for models that don't support these config options.

        +
        +
        +
        +
        +
        +
        + +mediaResolution + + +enum (MediaResolution) + +
        +
        +

        Optional. If specified, the media resolution specified will be used.

        +
        +
        +
        +
        +
        +
        + +enableAffectiveDialog + + +boolean + +
        +
        +

        Optional. If enabled, the model will detect emotions and adapt its responses accordingly.

        +
        +
        +
        +
        +
        +
        + +responseFormat + + +object (ResponseFormatConfig) + +
        +
        +

        Optional. Configuration for the response output format. Allows specifying output configuration per modality (text, audio, image) in a flat structure.

        +
        +
        +
        +
        +
        +
        + +translationConfig + + +object (TranslationConfig) + +
        +
        +

        Optional. Config for translation.

        +
        +
        +
        +
        +
        +
        + +audioTranscriptionConfig + + +object (AudioTranscriptionConfig) + +
        +
        +

        Optional. Config for audio transcription (speech recognition).

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "stopSequences": [
+    string
+  ],
+  "responseMimeType": string,
+  "responseSchema": {
+    object (Schema)
+  },
+  "_responseJsonSchema": value,
+  "responseJsonSchema": value,
+  "responseModalities": [
+    enum (Modality)
+  ],
+  "candidateCount": integer,
+  "maxOutputTokens": integer,
+  "temperature": number,
+  "topP": number,
+  "topK": integer,
+  "seed": integer,
+  "presencePenalty": number,
+  "frequencyPenalty": number,
+  "responseLogprobs": boolean,
+  "logprobs": integer,
+  "enableEnhancedCivicAnswers": boolean,
+  "speechConfig": {
+    object (SpeechConfig)
+  },
+  "thinkingConfig": {
+    object (ThinkingConfig)
+  },
+  "imageConfig": {
+    object (ImageConfig)
+  },
+  "mediaResolution": enum (MediaResolution),
+  "enableAffectiveDialog": boolean,
+  "responseFormat": {
+    object (ResponseFormatConfig)
+  },
+  "translationConfig": {
+    object (TranslationConfig)
+  },
+  "audioTranscriptionConfig": {
+    object (AudioTranscriptionConfig)
+  }
+}
        +
        +
        +
        +
        +
        +

        Modality

        +
        +

        Supported modalities of the response.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        MODALITY_UNSPECIFIEDDefault value.
        TEXTIndicates the model should return text.
        IMAGEIndicates the model should return images.
        AUDIOIndicates the model should return audio.
        +
        +
        +
        +

        SpeechConfig

        +
        +
        +
        +

        Config for speech generation and transcription.

        +
        +
        + + +Fields + + +
        +
        +
        + +voiceConfig + + +object (VoiceConfig) + +
        +
        +

        The configuration in case of single-voice output.

        +
        +
        +
        +
        +
        +
        + +multiSpeakerVoiceConfig + + +object (MultiSpeakerVoiceConfig) + +
        +
        +

        Optional. The configuration for the multi-speaker setup. It is mutually exclusive with the voiceConfig field.

        +
        +
        +
        +
        +
        +
        + +languageCode + + +string + +
        +
        +

        Optional. The IETF BCP-47 language code that the user configured the app to use. Used for speech recognition and synthesis.

        Valid values are: de-DE, en-AU, en-GB, en-IN, en-US, es-US, fr-FR, hi-IN, pt-BR, ar-XA, es-ES, fr-CA, id-ID, it-IT, ja-JP, tr-TR, vi-VN, bn-IN, gu-IN, kn-IN, ml-IN, mr-IN, ta-IN, te-IN, nl-NL, ko-KR, cmn-CN, pl-PL, ru-RU, and th-TH.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "voiceConfig": {
+    object (VoiceConfig)
+  },
+  "multiSpeakerVoiceConfig": {
+    object (MultiSpeakerVoiceConfig)
+  },
+  "languageCode": string
+}
        +
        +
        +
        +
        +
        +

        VoiceConfig

        +
        +
        +
        +

        The configuration for the voice to use.

        +
        +
        + + +Fields + + +
        +
        + + +voice_config + + +Union type + + +
        +
        The configuration for the speaker to use. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +prebuiltVoiceConfig + + +object (PrebuiltVoiceConfig) + +
        +
        +

        The configuration for the prebuilt voice to use.

        +
        +
        +
        +
        +
        +
        + +voice + + +string + +
        +
        +

        Optional. The speaker identifier for synthesis. Supported formats:

        +
          +
        • Speaker name for prebuilt voices (for example, Orus or Kore).
          • +
        • Voice ID for stored voices (for example, voice_xxx).
          • +
        • Voice replication key (for example, voicekey_xxx).
          • +
        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+
+  // voice_config
+  "prebuiltVoiceConfig": {
+    object (PrebuiltVoiceConfig)
+  },
+  "voice": string
+  // Union type
+}
        +
        +
        +
        +
        +
        +

        PrebuiltVoiceConfig

        +
        +
        +
        +

        The configuration for the prebuilt speaker to use.

        +
        +
        + + +Fields + + +
        +
        +
        + +voiceName + + +string + +
        +
        +

        Optional. The name of the preset voice to use.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "voiceName": string
+}
        +
        +
        +
        +
        +
        +

        MultiSpeakerVoiceConfig

        +
        +
        +
        +

        The configuration for the multi-speaker setup.

        +
        +
        + + +Fields + + +
        +
        +
        + +speakerVoiceConfigs[] + + +object (SpeakerVoiceConfig) + +
        +
        +

        Required. All the enabled speaker voices.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "speakerVoiceConfigs": [
+    {
+      object (SpeakerVoiceConfig)
+    }
+  ]
+}
        +
        +
        +
        +
        +
        +

        SpeakerVoiceConfig

        +
        +
        +
        +

        The configuration for a single speaker in a multi speaker setup.

        +
        +
        + + +Fields + + +
        +
        +
        + +speaker + + +string + +
        +
        +

        Required. The name of the speaker to use. Should be the same as in the prompt.

        +
        +
        +
        +
        +
        +
        + +voiceConfig + + +object (VoiceConfig) + +
        +
        +

        Required. The configuration for the voice to use.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "speaker": string,
+  "voiceConfig": {
+    object (VoiceConfig)
+  }
+}
        +
        +
        +
        +
        +
        +

        ThinkingConfig

        +
        +
        +
        +

        Config for thinking features.

        +
        +
        + + +Fields + + +
        +
        +
        + +includeThoughts + + +boolean + +
        +
        +

        Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.

        +
        +
        +
        +
        +
        +
        + +thinkingBudget + + +integer + +
        +
        +

        The number of thoughts tokens that the model should generate.

        +
        +
        +
        +
        +
        +
        + +thinkingLevel + + +enum (ThinkingLevel) + +
        +
        +

        Optional. Controls the maximum depth of the model's internal reasoning process before it produces a response. The default value is model-dependent. Refer to the Thinking levels guide for more details. Recommended for Gemini 3 or later models. Use with earlier models results in an error.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "includeThoughts": boolean,
+  "thinkingBudget": integer,
+  "thinkingLevel": enum (ThinkingLevel)
+}
        +
        +
        +
        +
        +
        +

        ThinkingLevel

        +
        +

        Allow user to specify how much to think using enum instead of integer budget.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        THINKING_LEVEL_UNSPECIFIEDDefault value.
        MINIMALLittle to no thinking.
        LOWLow thinking level.
        MEDIUMMedium thinking level.
        HIGHHigh thinking level.
        +
        +
        +
        +

        ImageConfig

        +
        +
        +
        +

        Config for image generation features.

        +
        +
        + + +Fields + + +
        +
        +
        + +aspectRatio + + +string + +
        +
        +

        Optional. The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 1:4, 4:1, 1:8, 8:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, or 21:9.

        If not specified, the model will choose a default aspect ratio based on any reference images provided.

        +
        +
        +
        +
        +
        +
        + +imageSize + + +string + +
        +
        +

        Optional. Specifies the size of generated images. Supported values are 512, 1K, 2K, 4K. If not specified, the model will use default value 1K.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "aspectRatio": string,
+  "imageSize": string
+}
        +
        +
        +
        +
        +
        +

        MediaResolution

        +
        +

        Media resolution for the input media.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        MEDIA_RESOLUTION_UNSPECIFIEDMedia resolution has not been set.
        MEDIA_RESOLUTION_LOWMedia resolution set to low (64 tokens).
        MEDIA_RESOLUTION_MEDIUMMedia resolution set to medium (256 tokens).
        MEDIA_RESOLUTION_HIGHMedia resolution set to high (zoomed reframing with 256 tokens).
        +
        +
        +
        +

        ResponseFormatConfig

        +
        +
        +
        +

        Configuration for the response output format. This is a flat object where each optional sub-field configures a specific output modality.

        +
        +
        + + +Fields + + +
        +
        +
        + +text + + +object (TextResponseFormat) + +
        +
        +

        Optional. Text output format configuration.

        +
        +
        +
        +
        +
        +
        + +audio + + +object (AudioResponseFormat) + +
        +
        +

        Optional. Audio output format configuration.

        +
        +
        +
        +
        +
        +
        + +image + + +object (ImageResponseFormat) + +
        +
        +

        Optional. Image output format configuration.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "text": {
+    object (TextResponseFormat)
+  },
+  "audio": {
+    object (AudioResponseFormat)
+  },
+  "image": {
+    object (ImageResponseFormat)
+  }
+}
        +
        +
        +
        +
        +
        +

        TextResponseFormat

        +
        +
        +
        +

        Configuration for text output format.

        +
        +
        + + +Fields + + +
        +
        +
        + +mimeType + + +enum (MimeType) + +
        +
        +

        Optional. The MIME type of the text output.

        +
        +
        +
        +
        +
        +
        + +schema + + +value (Value format) + +
        +
        +

        Optional. The JSON schema that the output should conform to. Only applicable when mimeType is APPLICATION_JSON.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "mimeType": enum (MimeType),
+  "schema": value
+}
        +
        +
        +
        +
        +
        +

        MimeType

        +
        +

        Supported MIME types for text output.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + +
        Enums
        MIME_TYPE_UNSPECIFIEDDefault value. This value is unused.
        APPLICATION_JSONJSON output format.
        TEXT_PLAINPlain text output format.
        +
        +
        +
        +

        AudioResponseFormat

        +
        +
        +
        +

        Configuration for audio output format.

        +
        +
        + + +Fields + + +
        +
        +
        + +mimeType + + +enum (MimeType) + +
        +
        +

        Optional. The MIME type of the audio output.

        +
        +
        +
        +
        +
        +
        + +delivery + + +enum (Delivery) + +
        +
        +

        Optional. The delivery mode for the audio output.

        +
        +
        +
        +
        +
        +
        + +sampleRate + + +integer + +
        +
        +

        Optional. Sample rate in Hz.

        +
        +
        +
        +
        +
        +
        + +bitRate + + +integer + +
        +
        +

        Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "mimeType": enum (MimeType),
+  "delivery": enum (Delivery),
+  "sampleRate": integer,
+  "bitRate": integer
+}
        +
        +
        +
        +
        +
        +

        MimeType

        +
        +

        Supported MIME types for audio output.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        MIME_TYPE_UNSPECIFIEDDefault value. This value is unused.
        AUDIO_MP3MP3 audio format.
        AUDIO_OGG_OPUSOGG Opus audio format.
        AUDIO_L16Raw PCM (L16) audio format.
        AUDIO_WAVWAV audio format.
        AUDIO_ALAWA-law audio format.
        AUDIO_MULAWMu-law audio format.
        +
        +
        +
        +

        Delivery

        +
        +

        Delivery mode for audio output.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + +
        Enums
        DELIVERY_UNSPECIFIEDDefault value. This value is unused.
        INLINEAudio data is returned inline in the response.
        URIAudio data is returned as a URI.
        +
        +
        +
        +

        ImageResponseFormat

        +
        +
        +
        +

        Configuration for image output format.

        +
        +
        + + +Fields + + +
        +
        +
        + +mimeType + + +enum (MimeType) + +
        +
        +

        Optional. The MIME type of the image output.

        +
        +
        +
        +
        +
        +
        + +delivery + + +enum (Delivery) + +
        +
        +

        Optional. The delivery mode for the image output.

        +
        +
        +
        +
        +
        +
        + +aspectRatio + + +enum (AspectRatio) + +
        +
        +

        Optional. The aspect ratio for the image output.

        +
        +
        +
        +
        +
        +
        + +imageSize + + +enum (ImageSize) + +
        +
        +

        Optional. The size of the image output.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "mimeType": enum (MimeType),
+  "delivery": enum (Delivery),
+  "aspectRatio": enum (AspectRatio),
+  "imageSize": enum (ImageSize)
+}
        +
        +
        +
        +
        +
        +

        MimeType

        +
        +

        Supported MIME types for image output.

        +
        +
        + ++++ + + + + + + + + + + + + + + + +
        Enums
        MIME_TYPE_UNSPECIFIEDDefault value. This value is unused.
        IMAGE_JPEGJPEG image format.
        +
        +
        +
        +

        Delivery

        +
        +

        Delivery mode for image output.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + +
        Enums
        DELIVERY_UNSPECIFIEDDefault value. This value is unused.
        INLINEImage data is returned inline in the response.
        URIImage data is returned as a URI.
        +
        +
        +
        +

        AspectRatio

        +
        +

        Supported aspect ratios for image output.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        ASPECT_RATIO_UNSPECIFIEDDefault value. This value is unused.
        ASPECT_RATIO_ONE_BY_ONE1:1 aspect ratio.
        ASPECT_RATIO_TWO_BY_THREE2:3 aspect ratio.
        ASPECT_RATIO_THREE_BY_TWO3:2 aspect ratio.
        ASPECT_RATIO_THREE_BY_FOUR3:4 aspect ratio.
        ASPECT_RATIO_FOUR_BY_THREE4:3 aspect ratio.
        ASPECT_RATIO_FOUR_BY_FIVE4:5 aspect ratio.
        ASPECT_RATIO_FIVE_BY_FOUR5:4 aspect ratio.
        ASPECT_RATIO_NINE_BY_SIXTEEN9:16 aspect ratio.
        ASPECT_RATIO_SIXTEEN_BY_NINE16:9 aspect ratio.
        ASPECT_RATIO_TWENTY_ONE_BY_NINE21:9 aspect ratio.
        ASPECT_RATIO_ONE_BY_EIGHT1:8 aspect ratio.
        ASPECT_RATIO_EIGHT_BY_ONE8:1 aspect ratio.
        ASPECT_RATIO_ONE_BY_FOUR1:4 aspect ratio.
        ASPECT_RATIO_FOUR_BY_ONE4:1 aspect ratio.
        +
        +
        +
        +

        ImageSize

        +
        +

        Supported image sizes for image output.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        IMAGE_SIZE_UNSPECIFIEDDefault value. This value is unused.
        IMAGE_SIZE_FIVE_TWELVE512px image size.
        IMAGE_SIZE_ONE_K1K image size.
        IMAGE_SIZE_TWO_K2K image size.
        IMAGE_SIZE_FOUR_K4K image size.
        +
        +
        +
        +

        TranslationConfig

        +
        +
        +
        +

        Config for translation features.

        +
        +
        + + +Fields + + +
        +
        +
        + +targetLanguageCode + + +string + +
        +
        +

        Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr").

        +
        +
        +
        +
        +
        +
        + +echoTargetLanguage + + +boolean + +
        +
        +

        Optional. If true, the model will generate audio when the target language is spoken, essentially it will parrot the input. If false, we will not produce audio for the target language.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "targetLanguageCode": string,
+  "echoTargetLanguage": boolean
+}
        +
        +
        +
        +
        +
        +

        AudioTranscriptionConfig

        +
        +
        +
        +

        The audio transcription configuration.

        +
        +
        + + +Fields + + +
        +
        +
        + +languageCodes[] + + +string + +
        +
        +

        Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection.

        +
        +
        +
        +
        +
        +
        + +adaptationPhrases[]
        (deprecated)         +         + +string + +
        +
        + +

        Optional. A list of phrases used for speech adaptation, which biases the ASR model to improve recognition of these specific terms.

        +
        +
        +
        +
        +
        +
        + +customVocabulary[] + + +string + +
        +
        +

        Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms (product names, proper nouns, jargon).

        +
        +
        +
        +
        +
        +
        + +wordTimestamp + + +boolean + +
        +
        +

        Optional. Configures word-level timestamp generation.

        +
        +
        +
        +
        +
        +
        + +diarization + + +boolean + +
        +
        +

        Optional. Configures speaker diarization.

        +
        +
        +
        +
        +
        +
        + +mode + + +enum (Mode) + +
        +
        +

        Optional. Configures transcription mode. Supported values: VERBATIM, SMART. If unspecified, defaults to VERBATIM transcription. In SMART mode, the model performs disfluency removal (eliminating filler words, repetitions, and false starts), light grammatical cleanup, automatic formatting (paragraphs, bullet points, numbered lists), and minor user edits (inline self-corrections). Timestamps and diarization are incompatible with mode SMART.

        +
        +
        +
        +
        +
        + + +language_config + + +Union type + + +
        +
        Deprecated: Use top-level language_codes instead. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +languageAuto
        (deprecated)         +         + +object (LanguageAuto) + +
        +
        + +

        Optional. The model will detect the language automatically.

        +
        +
        +
        +
        +
        +
        + +languageHints
        (deprecated)         +         + +object (LanguageHints) + +
        +
        + +

        Optional. Specifies one or more languages in the audio.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "languageCodes": [
+    string
+  ],
+  "adaptationPhrases": [
+    string
+  ],
+  "customVocabulary": [
+    string
+  ],
+  "wordTimestamp": boolean,
+  "diarization": boolean,
+  "mode": enum (Mode),
+
+  // language_config
+  "languageAuto": {
+    object (LanguageAuto)
+  },
+  "languageHints": {
+    object (LanguageHints)
+  }
+  // Union type
+}
        +
        +
        +
        +
        +
        +

        LanguageAuto

        +

        This type has no fields.

        +
        +
        +
        + +
        +
        +

        Indicates the language of the audio should be automatically detected.

        +
        +
        +
        +
        +
        +

        LanguageHints

        +
        +
        +
        + +
        +
        +

        Provides hints to the model about possible languages present in the audio.

        +
        +
        + + +Fields + + +
        +
        +
        + +languageCodes[]
        (deprecated)         +         + +string + +
        +
        + +

        Required. BCP-47 language codes.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "languageCodes": [
+    string
+  ]
+}
        +
        +
        +
        +
        +
        +

        Mode

        +
        +

        Transcription mode.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + +
        Enums
        MODE_UNSPECIFIEDUnspecified transcription mode.
        VERBATIMVerbatim transcription mode.
        SMARTSmart transcription mode.
        +
        +
        +
        +

        RealtimeInputConfig

        +
        +
        +
        +

        Configures the realtime input behavior in BidiGenerateContent.

        +
        +
        + + +Fields + + +
        +
        +
        + +automaticActivityDetection + + +object (AutomaticActivityDetection) + +
        +
        +

        Optional. If not set, automatic activity detection is enabled by default. If automatic voice detection is disabled, the client must send activity signals.

        +
        +
        +
        +
        +
        +
        + +activityHandling + + +enum (ActivityHandling) + +
        +
        +

        Optional. Defines what effect activity has.

        +
        +
        +
        +
        +
        +
        + +turnCoverage + + +enum (TurnCoverage) + +
        +
        +

        Optional. Defines which input is included in the user's turn.

        +
        +
        +
        +
        +
        +
        + +interimTranscriptTimestampEnabled + + +boolean + +
        +
        +

        Optional. Configures interim transcript timestamps.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "automaticActivityDetection": {
+    object (AutomaticActivityDetection)
+  },
+  "activityHandling": enum (ActivityHandling),
+  "turnCoverage": enum (TurnCoverage),
+  "interimTranscriptTimestampEnabled": boolean
+}
        +
        +
        +
        +
        +
        +

        AutomaticActivityDetection

        +
        +
        +
        +

        Configures automatic detection of activity.

        +
        +
        + + +Fields + + +
        +
        +
        + +disabled + + +boolean + +
        +
        +

        Optional. If enabled (the default), detected voice and text input count as activity. If disabled, the client must send activity signals.

        +
        +
        +
        +
        +
        +
        + +startOfSpeechSensitivity + + +enum (StartSensitivity) + +
        +
        +

        Optional. Determines how likely speech is to be detected.

        +
        +
        +
        +
        +
        +
        + +prefixPaddingMs + + +integer + +
        +
        +

        Optional. The required duration of detected speech before start-of-speech is committed. The lower this value, the more sensitive the start-of-speech detection is and shorter speech can be recognized. However, this also increases the probability of false positives.

        +
        +
        +
        +
        +
        +
        + +endOfSpeechSensitivity + + +enum (EndSensitivity) + +
        +
        +

        Optional. Determines how likely detected speech is ended.

        +
        +
        +
        +
        +
        +
        + +silenceDurationMs + + +integer + +
        +
        +

        Optional. The required duration of detected non-speech (e.g. silence) before end-of-speech is committed. The larger this value, the longer speech gaps can be without interrupting the user's activity but this will increase the model's latency.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "disabled": boolean,
+  "startOfSpeechSensitivity": enum (StartSensitivity),
+  "prefixPaddingMs": integer,
+  "endOfSpeechSensitivity": enum (EndSensitivity),
+  "silenceDurationMs": integer
+}
        +
        +
        +
        +
        +
        +

        StartSensitivity

        +
        +

        Determines how start of speech is detected.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + +
        Enums
        START_SENSITIVITY_UNSPECIFIEDThe default is START_SENSITIVITY_HIGH.
        START_SENSITIVITY_HIGHAutomatic detection will detect the start of speech more often.
        START_SENSITIVITY_LOWAutomatic detection will detect the start of speech less often.
        +
        +
        +
        +

        EndSensitivity

        +
        +

        Determines how end of speech is detected.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + +
        Enums
        END_SENSITIVITY_UNSPECIFIEDThe default is END_SENSITIVITY_HIGH.
        END_SENSITIVITY_HIGHAutomatic detection ends speech more often.
        END_SENSITIVITY_LOWAutomatic detection ends speech less often.
        +
        +
        +
        +

        ActivityHandling

        +
        +

        The different ways of handling user activity.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + +
        Enums
        ACTIVITY_HANDLING_UNSPECIFIEDIf unspecified, the default behavior is START_OF_ACTIVITY_INTERRUPTS.
        START_OF_ACTIVITY_INTERRUPTSIf true, start of activity will interrupt the model's response (also called "barge in"). The model's current response will be cut-off in the moment of the interruption. This is the default behavior.
        NO_INTERRUPTIONThe model's response will not be interrupted.
        +
        +
        +
        +

        TurnCoverage

        +
        +

        Options about which input is included in the user's turn.

        +
        +
        + ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Enums
        TURN_COVERAGE_UNSPECIFIEDIf unspecified, a default behavior is selected based on the model. E.g., for Gemini 2.5, the default is TURN_INCLUDES_ONLY_ACTIVITY, while for Gemini 3.1 and onwards, it's TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO.
        TURN_INCLUDES_ONLY_ACTIVITYIncludes activity since the last turn, excluding inactivity (e.g. silence on the audio stream).
        TURN_INCLUDES_ALL_INPUTIncludes all realtime input since the last turn, including inactivity (e.g. silence on the audio stream).
        TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEOIncludes audio activity and all video since the last turn. With automatic activity detection, audio activity means speech and excludes silence.
        +
        +
        +
        +

        SessionResumptionConfig

        +
        +
        +
        +

        Session resumption configuration.

        This message is included in the session configuration as BidiGenerateContentSetup.session_resumption. If configured, the server will send SessionResumptionUpdate messages.

        +
        +
        + + +Fields + + +
        +
        +
        + +handle + + +string + +
        +
        +

        The handle of a previous session. If not present then a new session is created.

        Session handles come from SessionResumptionUpdate.token values in previous connections.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "handle": string
+}
        +
        +
        +
        +
        +
        +

        ContextWindowCompressionConfig

        +
        +
        +
        +

        Enables context window compression — a mechanism for managing the model's context window so that it does not exceed a given length.

        +
        +
        + + +Fields + + +
        +
        + + +compression_mechanism + + +Union type + + +
        +
        The context window compression mechanism used. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +slidingWindow + + +object (SlidingWindow) + +
        +
        +

        A sliding-window mechanism.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        + +triggerTokens + + +string (int64 format) + +
        +
        +

        The number of tokens (before running a turn) required to trigger a context window compression.

        This can be used to balance quality against latency as shorter context windows may result in faster model responses. However, any compression operation will cause a temporary latency increase, so they should not be triggered frequently.

        If not set, the default is 80% of the model's context window limit. This leaves 20% for the next user request/model response.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+
+  // compression_mechanism
+  "slidingWindow": {
+    object (SlidingWindow)
+  }
+  // Union type
+  "triggerTokens": string
+}
        +
        +
        +
        +
        +
        +

        SlidingWindow

        +
        +
        +
        +

        The SlidingWindow method operates by discarding content at the beginning of the context window. The resulting context will always begin at the start of a USER role turn. System instructions and any BidiGenerateContentSetup.prefix_turns will always remain at the beginning of the result.

        +
        +
        + + +Fields + + +
        +
        +
        + +targetTokens + + +string (int64 format) + +
        +
        +

        The target number of tokens to keep. The default value is triggerTokens/2.

        Discarding parts of the context window causes a temporary latency increase so this value should be calibrated to avoid frequent compression operations.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "targetTokens": string
+}
        +
        +
        +
        +
        +
        +

        HistoryConfig

        +
        +
        +
        +

        History configuration.

        This message is included in the session configuration as BidiGenerateContentSetup.history_config. Configures the exchange of history messages.

        +
        +
        + + +Fields + + +
        +
        +
        + +initialHistoryInClientContent + + +boolean + +
        +
        +

        Optional. If true, after sending setupComplete, the server will wait and at first process clientContent messages until turnComplete is true. This initial history will not trigger a model call and may end with role MODEL. After turnComplete is true, the client can start the realtime conversation via realtimeInput.

        +
        +
        +
        +
        +
        +
        +
        + + + + + + + + + + + +
        JSON representation
        {
+  "initialHistoryInClientContent": boolean
+}
        +
        +
        +
        +
        +
        +

        Method: auth_tokens.create

        + + +
        + +
        +
        +
        +

        Creates a token that can be used to constrain the behavior of a BidiGenerateContent session.

        +
        +
        +
        +
        +

        Endpoint

        + + + post + + +https://generativelanguage.googleapis.com/v1beta/auth_tokens + + +
        + + + +
        +
        +

        Request body

        +

        The request body contains an instance of AuthToken.

        +
        + + +Fields + + +
        +
        +
        + +expireTime + + +string (Timestamp format) + +
        +
        +

        Optional. Input only. Immutable. An optional time after which, when using the resulting token, messages in BidiGenerateContent sessions will be rejected. (Gemini may preemptively close the session after this time.)

        If not set then this defaults to 30 minutes in the future. If set, this value must be less than 20 hours in the future.

        Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

        +
        +
        +
        +
        +
        +
        + +newSessionExpireTime + + +string (Timestamp format) + +
        +
        +

        Optional. Input only. Immutable. The time after which new Live API sessions using the token resulting from this request will be rejected.

        If not set this defaults to 60 seconds in the future. If set, this value must be less than 20 hours in the future.

        Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

        +
        +
        +
        +
        +
        +
        + +fieldMask + + +string (FieldMask format) + +
        +
        +

        Optional. Input only. Immutable. If fieldMask is empty, and bidiGenerateContentSetup is not present, then the effective BidiGenerateContentSetup message is taken from the Live API connection.

        If fieldMask is empty, and bidiGenerateContentSetup is present, then the effective BidiGenerateContentSetup message is taken entirely from bidiGenerateContentSetup in this request. The setup message from the Live API connection is ignored.

        If fieldMask is not empty, then the corresponding fields from bidiGenerateContentSetup will overwrite the fields from the setup message in the Live API connection.

        This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

        +
        +
        +
        +
        +
        + + +config + + +Union type + + +
        +
        The method-specific configuration for the resulting token. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
        +
        +
        +
        + +bidiGenerateContentSetup + + +object (BidiGenerateContentSetup) + +
        +
        +

        Optional. Input only. Immutable. Configuration specific to BidiGenerateContent.

        +
        +
        +
        +
        End of mutually exclusive fields.
        +
        +
        +
        +
        +
        +
        + +uses + + +integer + +
        +
        +

        Optional. Input only. Immutable. The number of times the token can be used. If this value is zero then no limit is applied. Resuming a Live API session does not count as a use. If unspecified, the default is 1.

        +
        +
        +
        +
        +
        +
        +
        +
        +
        +

        Response body

        +

        If successful, the response body contains a newly created instance of AuthToken.

        +
        +
        +
        +
        +
        + + + +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + +
        + + + + + + + + +
        + +         +
        + + + + + + + + + + + + + + + + + + + + + + +
        +
        + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/pipeline/provider_docs/google__ai.google.dev_gemini-api_docs_image-generation b/pipeline/provider_docs/google__ai.google.dev_gemini-api_docs_image-generation new file mode 100644 index 0000000000000000000000000000000000000000..2f2f344af00f75322dbed88a65f1d3466dfd1c81 --- /dev/null +++ b/pipeline/provider_docs/google__ai.google.dev_gemini-api_docs_image-generation @@ -0,0 +1,9202 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gemini API  |  Google AI for Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + + +
        + + + + + + + + + + + + + + + + + +
          + +
        • + + + + + + +
          • + +
        +         + +
        +
        +
        + +
        + + +
        +
        + +
        + + + +
        +
        +
        + +         + +
        + + + + + + + + + + + + + + + + + + + + Get API key + + + + Cookbook + + + + Community + + + + + + + + + + + + + + + +
        +
        +
        + + + +
        +
        + + + + +
        + + + + + + + + + + + + +
        + +
        +
        + +
        + + + + + + +         + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        +
        +
        + + + +
        +
        + + + + + + + + + + + + + +
        + + + + + + + + + + + + + + + + + + + + +
        + + + + + + +

        +

        + +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +

        Nano Banana image generation

        + + + + Prompt to prototype fully-functional, UI-complete apps, and see + Nano Banana 2 integrated with real-world tools, data, and the Gemini + ecosystem. All before writing a single line of code. +
          +
        • Or build your own from prompts:
          • +
        +         +         +         +
        + +
        + +
          +
        • +
          + magazine + london + restore + banana + cafe + article + dog + isometric +
          +
          • +
        • +
          + magazine +
          Generated by Nano Banana 2
          +
          +
          +
          + Prompt: "A photo of a glossy magazine cover, the minimal blue cover has the large bold words Nano Banana. The text is in a serif font and fills the view. No other text. In front of the text there is a portrait of a person in a sleek and minimal dress. She is playfully holding the number 2, which is the focal point. +
          Put the issue number and "Feb 2026" date in the corner along with a barcode. The magazine is on a shelf against an orange plastered wall, within a designer store." +
          +
          +
          • +
        • +
          + london +
          Generated by Nano Banana Pro
          +
          +
          +
          + Prompt: "Present a clear, 45° top-down isometric miniature 3D cartoon scene of London, featuring its most iconic landmarks and architectural elements. Use soft, refined textures with realistic PBR materials and gentle, lifelike lighting and shadows. Integrate the current weather conditions directly into the city environment to create an immersive atmospheric mood. Use a clean, minimalistic composition with a soft, solid-colored background. At the top-center, place the title "London" in large bold text, a prominent weather icon beneath it, then the date (small text) and temperature (medium text). All text must be centered with consistent spacing, and may subtly overlap the tops of the buildings." +
          +
          +
          • +
        • +
          + quetzal +
          Generated by Nano Banana 2
          +
          +
          +
          + Prompt: "Use image search to find accurate images of a resplendent quetzal bird. Create a beautiful 3:2 wallpaper of this bird, with a natural top to bottom gradient and minimal composition." +
          +
          +
          • +
        • +
          + banana +
          Generated by Nano Banana Pro
          +
          +
          +
          + Prompt: "Put this logo on a high-end ad for a banana scented perfume. The logo is perfectly integrated into the bottle." +
          +
          +
          • +
        • +
          + cafe +
          Generated by Nano Banana Pro
          +
          +
          +
          + Prompt: "A photo of an everyday scene at a busy cafe serving breakfast. In the foreground is an anime man with blue hair, one of the people is a pencil sketch, another is a claymation person" +
          +
          +
          • +
        • +
          + article +
          Generated by Nano Banana Pro
          +
          +
          +
          + Prompt: "Use search to find how the Gemini 3 Flash launch has been received. Use this information to write a short article about it (with headings). Return a photo of the article as it appeared in a design focused glossy magazine. It is a photo of a single folded over page, showing the article about Gemini 3 Flash. One hero photo. Headline in serif." +
          +
          +
          • +
        • +
          + dog +
          Generated by Nano Banana Pro
          +
          +
          +
          + Prompt: "An icon representing a cute dog. The background is white. Make the icons in a colorful and tactile 3D style. No text." +
          +
          +
          • +
        • +
          + isometric +
          Generated by Nano Banana 2
          +
          +
          +
          + Prompt: "Make a photo that is perfectly isometric. It is not a miniature, it is a captured photo that just happened to be perfectly isometric. It is a photo of a beautiful modern garden. There's a large 2 shaped pool and the words: Nano Banana 2." +
          +
          +
          • +
        +         +
        + +

        Nano Banana is the name for Gemini's native image generation capabilities. +Gemini can generate and process images conversationally +with text, images, video, or a combination. This lets you create, edit, and +iterate on visuals with unprecedented control.

        + +

        Model selection

        + +

        Nano Banana refers to the following models available in the Gemini API:

        + +
          +
        • Nano Banana 2.1 (Gemini Nano Banana 2.1) +(gemini-nano-banana-2.1): An update to Nano Banana 2, serving as the +primary high-efficiency workhorse model for image generation and +conversational editing. It maintains Flash-level speed and cost efficiency +while delivering improved visual quality, text rendering, multi-turn +consistency, and Google Search grounding across 1K, 2K, and 4K resolutions.
          • +
        • Nano Banana 2 Lite (Gemini 3.1 Flash Lite Image) +(gemini-3.1-flash-lite-image): The fastest and cheapest Gemini image +model, engineered for velocity and scale where speed and cost are the +primary operational constraints. Not optimized for multiple reference inputs +or multi-turn sequential editing.
          • +
        • Nano Banana 2 (Gemini 3.1 Flash Image) +(gemini-3.1-flash-image): The previous-generation high-efficiency +workhorse model, balancing speed with 4K generation, world knowledge, and +multi-reference image consistency. Recommended for all new projects to use +Nano Banana 2.1.
          • +
        • Nano Banana Pro (Gemini 3 Pro Image) +(gemini-3-pro-image): The premium choice for the most complex visual +tasks, offering the highest level of world knowledge, advanced localization, +accurate brand consistency, and precision creative control.
          • +
        • Nano Banana (Gemini 2.5 Flash Image) +(gemini-2.5-flash-image): The legacy pioneer of the Nano Banana series. +While it has been a reliable workhorse, recommended migration path is to +transition to Nano Banana 2 Lite to experience enhanced quality, faster +generation speeds, and lower API pricing.
          • +
        + +

        All generated images include a +SynthID watermark.

        + +

        Image generation (text-to-image)

        +
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme",
+)
+
+with open("generated_image.png", "wb") as f:
+    f.write(base64.b64decode(interaction.output_image.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+
+  const ai = new GoogleGenAI({});
+
+  const prompt =
+    "Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme";
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: prompt,
+  });
+  const generatedImage = interaction.output_image;
+  if (generatedImage) {
+    const buffer = Buffer.from(generatedImage.data, "base64");
+    fs.writeFileSync("gemini-native-image.png", buffer);
+    console.log("Image saved as gemini-native-image.png");
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme"))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.outputImage().isPresent()
+    && interaction.outputImage().get().data().isPresent()) {
+  byte[] imageBytes =
+      Base64.getDecoder().decode(interaction.outputImage().get().data().get());
+  Files.write(Paths.get("generated_image.png"), imageBytes);
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput("Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme"),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    if res.Interaction.OutputImage != nil && res.Interaction.OutputImage.Data != nil {
+        imageBytes, err := base64.StdEncoding.DecodeString(*res.Interaction.OutputImage.Data)
+        if err != nil {
+            log.Fatal(err)
+        }
+        if err := os.WriteFile("generated_image.png", imageBytes, 0644); err != nil {
+            log.Fatal(err)
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": [
+      {"type": "text", "text": "Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme"}
+    ]
+  }'
+
        +
        +

        You can retrieve generated image data by using the interaction.output_image +property, which returns the last generated image block. For details on +convenience properties, see the +Interactions overview.

        + +

        Image editing (text-and-image-to-image)

        + +

        Reminder: Make sure you have the necessary rights to any images you upload. +Don't generate content that infringe on others' rights, including videos or +images that deceive, harass, or harm. Your use of this generative AI service is +subject to our Prohibited Use Policy.

        + +

        Provide an image and use text prompts to add, remove, or modify elements, +change the style, or adjust the color grading.

        + +

        The following example demonstrates uploading base64 encoded images. +For multiple images, larger payloads, and supported MIME types, check the Image +understanding page.

        +
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+
+client = genai.Client()
+
+with open("/path/to/cat_image.png", "rb") as f:
+    image_bytes = f.read()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=[
+        {
+          "type": "text",
+          "text": "Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme"
+        },
+        {
+            "type": "image",
+            "data": base64.b64encode(image_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        }
+    ],
+)
+
+with open("generated_image.png", "wb") as f:
+    f.write(base64.b64decode(interaction.output_image.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+
+  const ai = new GoogleGenAI({});
+
+  const imagePath = "path/to/cat_image.png";
+  const imageData = fs.readFileSync(imagePath);
+  const base64Image = imageData.toString("base64");
+
+  const prompt = [
+    { type: "text", text: "Create a picture of my cat eating a nano-banana in a" +
+            "fancy restaurant under the Gemini constellation" },
+    {
+      type: "image",
+      mime_type: "image/png",
+      data: base64Image
+    },
+  ];
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: prompt,
+  });
+  const generatedImage = interaction.output_image;
+  if (generatedImage) {
+    const buffer = Buffer.from(generatedImage.data, "base64");
+    fs.writeFileSync("gemini-native-image.png", buffer);
+    console.log("Image saved as gemini-native-image.png");
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageContentMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.List;
+
+Client client = new Client();
+
+byte[] inputBytes = Files.readAllBytes(Paths.get("/path/to/cat_image.png"));
+String base64Image = Base64.getEncoder().encodeToString(inputBytes);
+
+Content textContent =
+    TextContent.builder()
+        .text("Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme")
+        .build();
+Content imageContent =
+    ImageContent.builder()
+        .data(base64Image)
+        .mimeType(ImageContentMimeType.IMAGE_PNG)
+        .build();
+
+List<Content> contents = Arrays.asList(textContent, imageContent);
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.ofContent(contents))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.outputImage().isPresent()
+    && interaction.outputImage().get().data().isPresent()) {
+  byte[] outputBytes =
+      Base64.getDecoder().decode(interaction.outputImage().get().data().get());
+  Files.write(Paths.get("generated_image.png"), outputBytes);
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    inputBytes, err := os.ReadFile("/path/to/cat_image.png")
+    if err != nil {
+        log.Fatal(err)
+    }
+    base64Image := base64.StdEncoding.EncodeToString(inputBytes)
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput([]interactions.Content{
+                interactions.NewContent(interactions.TextContent{
+                    Text: "Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme",
+                }),
+                interactions.NewContent(interactions.ImageContent{
+                    Data:     genai.Ptr(base64Image),
+                    MimeType: interactions.ImageContentMimeTypeImagePng.ToPointer(),
+                }),
+            }),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    if res.Interaction.OutputImage != nil && res.Interaction.OutputImage.Data != nil {
+        outputBytes, err := base64.StdEncoding.DecodeString(*res.Interaction.OutputImage.Data)
+        if err != nil {
+            log.Fatal(err)
+        }
+        if err := os.WriteFile("generated_image.png", outputBytes, 0644); err != nil {
+            log.Fatal(err)
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+    -H "x-goog-api-key: $GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -d "{
+      \"model\": \"gemini-nano-banana-2.1\",
+      \"input\": [
+        {\"type\": \"text\", \"text\": \"Create a picture of my cat eating a nano-banana in a fancy restaurant under the Gemini constellation\"},
+        {
+          \"type\": \"image\",
+          \"mime_type\": \"image/jpeg\",
+          \"data\": \"<BASE64_IMAGE_DATA>\"
+        }
+      ]
+    }"
+
        +
        +

        Multi-turn image editing

        + +

        Keep generating and editing images conversationally. Multi-turn +conversation is the recommended way to iterate on images. The following +example shows a prompt to generate an infographic about photosynthesis.

        +
        +

        Python

        from google import genai
+import base64
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="Create a vibrant infographic that explains photosynthesis as if it were a recipe for a plant's favorite food. Show the \"ingredients\" (sunlight, water, CO2) and the \"finished dish\" (sugar/energy). The style should be like a page from a colorful kids' cookbook, suitable for a 4th grader.",
+    tools=[{"type": "google_search"}],
+)
+
+with open("photosynthesis.png", "wb") as f:
+    f.write(base64.b64decode(interaction.output_image.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+const ai = new GoogleGenAI({});
+
+async function main() {
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "Create a vibrant infographic that explains photosynthesis as if it were a recipe for a plant's favorite food. Show the \"ingredients\" (sunlight, water, CO2) and the \"finished dish\" (sugar/energy). The style should be like a page from a colorful kids' cookbook, suitable for a 4th grader.",
+    tools: [{"type": "google_search"}],
+  });
+
+  const generatedImage = interaction.output_image;
+  if (generatedImage) {
+    const buffer = Buffer.from(generatedImage.data, "base64");
+    fs.writeFileSync("photosynthesis.png", buffer);
+    console.log("Image saved as photosynthesis.png");
+  }
+}
+
+await main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.GoogleSearch;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "Create a vibrant infographic that explains photosynthesis as if it were a recipe for a plant's favorite food. Show the \"ingredients\" (sunlight, water, CO2) and the \"finished dish\" (sugar/energy). The style should be like a page from a colorful kids' cookbook, suitable for a 4th grader."))
+        .tools(Arrays.asList(new GoogleSearch()))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.outputImage().isPresent()
+    && interaction.outputImage().get().data().isPresent()) {
+  byte[] imageBytes =
+      Base64.getDecoder().decode(interaction.outputImage().get().data().get());
+  Files.write(Paths.get("photosynthesis.png"), imageBytes);
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput(`Create a vibrant infographic that explains photosynthesis as if it were a recipe for a plant's favorite food. Show the "ingredients" (sunlight, water, CO2) and the "finished dish" (sugar/energy). The style should be like a page from a colorful kids' cookbook, suitable for a 4th grader.`),
+            Tools: []interactions.Tool{
+                interactions.NewTool(interactions.GoogleSearch{}),
+            },
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    if res.Interaction.OutputImage != nil && res.Interaction.OutputImage.Data != nil {
+        imageBytes, err := base64.StdEncoding.DecodeString(*res.Interaction.OutputImage.Data)
+        if err != nil {
+            log.Fatal(err)
+        }
+        if err := os.WriteFile("photosynthesis.png", imageBytes, 0644); err != nil {
+            log.Fatal(err)
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": [
+      {"type": "text", "text": "Create a vibrant infographic that explains photosynthesis as if it were a recipe for a plants favorite food. Show the \"ingredients\" (sunlight, water, CO2) and the \"finished dish\" (sugar/energy). The style should be like a page from a colorful kids cookbook, suitable for a 4th grader."}
+    ],
+    "tools": [{"type": "google_search"}]
+  }'
+
        +
        +
        + AI-generated infographic about photosynthesis +
        AI-generated infographic about photosynthesis
        +
        + +

        You can then use the previous_interaction_id to change the language on the graphic to Spanish.

        +
        +

        Python

        interaction_2 = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="Update this infographic to be in Spanish. Do not change any other elements of the image.",
+    previous_interaction_id=interaction.id,
+    response_format={
+        "type": "image",
+        "mime_type": "image/jpeg",
+        "aspect_ratio": "16:9",
+        "image_size": "2K"
+    },
+)
+
+generated_image = interaction_2.output_image
+if generated_image:
+    with open("photosynthesis_spanish.png", "wb") as f:
+        f.write(base64.b64decode(generated_image.data))
+
        +

        JavaScript

        const interaction2 = await ai.interactions.create({
+  model: "gemini-nano-banana-2.1",
+  input: "Update this infographic to be in Spanish. Do not change any other elements of the image.",
+  previous_interaction_id: interaction.id,
+  response_format: {
+    type: "image",
+    mime_type: "image/png",
+    aspect_ratio: "16:9",
+    image_size: "2K"
+  },
+});
+
+const generatedImage = interaction2.output_image;
+if (generatedImage) {
+  const buffer = Buffer.from(generatedImage.data, "base64");
+  fs.writeFileSync("photosynthesis_spanish.png", buffer);
+}
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.CreateModelInteractionResponseFormat;
+import com.google.genai.gaos.models.interactions.GoogleSearch;
+import com.google.genai.gaos.models.interactions.ImageResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatAspectRatio;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatImageSize;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ResponseFormat;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteraction turn1Params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "Create a vibrant infographic that explains photosynthesis as if it were a recipe for a plant's favorite food."))
+        .tools(Arrays.asList(new GoogleSearch()))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(turn1Params)).interaction().get();
+
+CreateModelInteractionResponseFormat format =
+    CreateModelInteractionResponseFormat.of(
+        ResponseFormat.of(
+            ImageResponseFormat.builder()
+                .mimeType(ImageResponseFormatMimeType.IMAGE_JPEG)
+                .aspectRatio(ImageResponseFormatAspectRatio.of("16:9"))
+                .imageSize(ImageResponseFormatImageSize.TWO_K)
+                .build()));
+
+CreateModelInteraction turn2Params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "Update this infographic to be in Spanish. Do not change any other elements of the image."))
+        .previousInteractionId(interaction.id().orElse(""))
+        .responseFormat(format)
+        .build();
+
+Interaction interaction2 =
+    client.interactions.create(CreateInteractionRequestBody.of(turn2Params)).interaction().get();
+
+if (interaction2.outputImage().isPresent()
+    && interaction2.outputImage().get().data().isPresent()) {
+  byte[] imageBytes =
+      Base64.getDecoder().decode(interaction2.outputImage().get().data().get());
+  Files.write(Paths.get("photosynthesis_spanish.png"), imageBytes);
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    res1, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput("Create a vibrant infographic that explains photosynthesis as if it were a recipe for a plant's favorite food."),
+            Tools: []interactions.Tool{
+                interactions.NewTool(interactions.GoogleSearch{}),
+            },
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    format := interactions.NewCreateModelInteractionResponseFormat(
+        interactions.NewResponseFormat(interactions.ImageResponseFormat{
+            MimeType:    interactions.ImageResponseFormatMimeTypeImageJpeg.ToPointer(),
+            AspectRatio: interactions.ImageResponseFormatAspectRatio("16:9").ToPointer(),
+            ImageSize:   interactions.ImageResponseFormatImageSizeTwoK.ToPointer(),
+        }),
+    )
+
+    res2, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model:                 interactions.Model("gemini-nano-banana-2.1"),
+            Input:                 interactions.NewInteractionsInput("Update this infographic to be in Spanish. Do not change any other elements of the image."),
+            PreviousInteractionID: res1.Interaction.ID,
+            ResponseFormat:        genai.Ptr(format),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    if res2.Interaction.OutputImage != nil && res2.Interaction.OutputImage.Data != nil {
+        imageBytes, err := base64.StdEncoding.DecodeString(*res2.Interaction.OutputImage.Data)
+        if err != nil {
+            log.Fatal(err)
+        }
+        if err := os.WriteFile("photosynthesis_spanish.png", imageBytes, 0644); err != nil {
+            log.Fatal(err)
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "Update this infographic to be in Spanish. Do not change any other elements of the image.",
+    "previous_interaction_id": "<PREVIOUS_INTERACTION_ID>",
+    "response_format": {
+      "type": "image",
+      "mime_type": "image/jpeg",
+      "aspect_ratio": "16:9",
+      "image_size": "2K"
+    }
+  }'
+
        +
        +
        + AI-generated infographic of photosynthesis in Spanish +
        AI-generated infographic of photosynthesis in Spanish
        +
        + +

        Features of Nano Banana

        + +

        Nano Banana models offer state-of-the-art image generation and editing. Gemini +Nano Banana 2.1 and Gemini 3.1 Flash Image are optimized for speed and +high-volume use-cases, and Gemini 3 Pro Image is optimized for professional +asset production. +Designed to tackle the most challenging workflows through advanced reasoning, +they excel at complex, multi-turn creation and modification tasks.

        + +
          +
        • High-resolution output: Built-in generation capabilities for 1K, 2K, and 4K visuals. +
            +
          • Gemini 3.1 Flash Image adds the smaller 512px (0.5K) resolution (not +supported on Gemini Nano Banana 2.1).
            • +
          • Gemini 3.1 Flash Lite Image only supports 1K resolution.
            • +
          • +
        • Advanced text rendering: Capable of generating legible, stylized text for +infographics, menus, diagrams, and marketing assets.
          • +
        • Grounding with Google Search: The model can use Google Search as a tool to +verify facts and generate imagery based on real-time data (e.g., current +weather maps, stock charts, recent events). +
            +
          • Not supported by Gemini 3.1 Flash Lite Image model.
            • +
          • Gemini Nano Banana 2.1 and Gemini 3.1 Flash Image add the integration of +Google Image Search Grounding alongside Web Search.
            • +
          • +
        • Thinking mode: The model utilizes a "thinking" process to reason through +complex prompts. It generates interim "thought images" (visible in the backend +but not charged) to refine the composition before producing the final +high-quality output.
          • +
        • Up to 14 reference images: Mix up to 14 reference images to +produce the final image.
          • +
        • New aspect ratios: Gemini 3.1 Flash Lite Image adds 1:1, 3:2, +2:3, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9 +aspect ratios.
          • +
        + +

        Use up to 14 reference images

        + +

        Nano Banana models allow you to mix up to 14 reference images. These 14 images +can include the following:

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Gemini 3.1 Flash Lite ImageGemini Nano Banana 2.1 & Gemini 3.1 Flash ImageGemini 3 Pro Image
        Up to 14 images of objects with high-fidelity to include in the final imageUp to 10 images of objects with high-fidelity to include in the final imageUp to 6 images of objects with high-fidelity to include in the final image
        N/AUp to 4 images of characters to maintain character consistencyUp to 5 images of characters to maintain character consistency
        N/AN/AUp to 3 images to be used as style references
        +
        +

        Python

        from google import genai
+from google.genai import types
+from PIL import Image
+import base64
+
+prompt = "An office group photo of these people, they are making funny faces."
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=[
+        {
+            "type": "text",
+            "text": prompt,
+        },
+        {
+            "type": "image",
+            "data": base64.b64encode(image_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        },
+        {
+            "type": "image",
+            "data": base64.b64encode(image_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        },
+        {
+            "type": "image",
+            "data": base64.b64encode(image_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        },
+        {
+            "type": "image",
+            "data": base64.b64encode(image_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        },
+        {
+            "type": "image",
+            "data": base64.b64encode(image_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        },
+    ],
+    response_format={
+        "type": "image",
+        "aspect_ratio": "5:4",
+        "image_size": "2K"
+    },
+)
+
+with open("office.png", "wb") as f:
+    f.write(base64.b64decode(interaction.output_image.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const input = [
+    {
+      type: "text",
+      text: "An office group photo of these people, they are making funny faces.",
+    },
+    { type: "image", mime_type: "image/jpeg", data: base64ImageFile1 },
+    { type: "image", mime_type: "image/jpeg", data: base64ImageFile2 },
+    { type: "image", mime_type: "image/jpeg", data: base64ImageFile3 },
+    { type: "image", mime_type: "image/jpeg", data: base64ImageFile4 },
+    { type: "image", mime_type: "image/jpeg", data: base64ImageFile5 },
+  ];
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: input,
+    response_format: {
+      type: "image",
+      aspect_ratio: "5:4",
+      image_size: "2K",
+    },
+  });
+
+  const buffer = Buffer.from(interaction.output_image.data, 'base64');
+
+  fs.writeFileSync('office.png', buffer);
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.CreateModelInteractionResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageContentMimeType;
+import com.google.genai.gaos.models.interactions.ImageResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatAspectRatio;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatImageSize;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ResponseFormat;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.List;
+
+String prompt = "An office group photo of these people, they are making funny faces.";
+
+byte[] imageBytes = Files.readAllBytes(Paths.get("/path/to/person.png"));
+String base64Image = Base64.getEncoder().encodeToString(imageBytes);
+
+Content textContent = TextContent.builder().text(prompt).build();
+Content imageContent =
+    ImageContent.builder()
+        .data(base64Image)
+        .mimeType(ImageContentMimeType.IMAGE_PNG)
+        .build();
+
+List<Content> contents =
+    Arrays.asList(
+        textContent,
+        imageContent,
+        imageContent,
+        imageContent,
+        imageContent,
+        imageContent);
+
+CreateModelInteractionResponseFormat format =
+    CreateModelInteractionResponseFormat.of(
+        ResponseFormat.of(
+            ImageResponseFormat.builder()
+                .aspectRatio(ImageResponseFormatAspectRatio.of("5:4"))
+                .imageSize(ImageResponseFormatImageSize.TWO_K)
+                .build()));
+
+Client client = new Client();
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.ofContent(contents))
+        .responseFormat(format)
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.outputImage().isPresent()
+    && interaction.outputImage().get().data().isPresent()) {
+  byte[] outBytes =
+      Base64.getDecoder().decode(interaction.outputImage().get().data().get());
+  Files.write(Paths.get("office.png"), outBytes);
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    prompt := "An office group photo of these people, they are making funny faces."
+
+    imageBytes, err := os.ReadFile("/path/to/person.png")
+    if err != nil {
+        log.Fatal(err)
+    }
+    base64Image := base64.StdEncoding.EncodeToString(imageBytes)
+
+    textContent := interactions.NewContent(interactions.TextContent{
+        Text: prompt,
+    })
+    imageContent := interactions.NewContent(interactions.ImageContent{
+        Data:     genai.Ptr(base64Image),
+        MimeType: interactions.ImageContentMimeTypeImagePng.ToPointer(),
+    })
+
+    contents := []interactions.Content{
+        textContent,
+        imageContent,
+        imageContent,
+        imageContent,
+        imageContent,
+        imageContent,
+    }
+
+    format := interactions.NewCreateModelInteractionResponseFormat(
+        interactions.NewResponseFormat(interactions.ImageResponseFormat{
+            AspectRatio: interactions.ImageResponseFormatAspectRatio("5:4").ToPointer(),
+            ImageSize:   interactions.ImageResponseFormatImageSizeTwoK.ToPointer(),
+        }),
+    )
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model:          interactions.Model("gemini-nano-banana-2.1"),
+            Input:          interactions.NewInteractionsInput(contents),
+            ResponseFormat: genai.Ptr(format),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    if res.Interaction.OutputImage != nil && res.Interaction.OutputImage.Data != nil {
+        outBytes, err := base64.StdEncoding.DecodeString(*res.Interaction.OutputImage.Data)
+        if err != nil {
+            log.Fatal(err)
+        }
+        if err := os.WriteFile("office.png", outBytes, 0644); err != nil {
+            log.Fatal(err)
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+    -H "x-goog-api-key: $GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -d "{
+      \"model\": \"gemini-nano-banana-2.1\",
+      \"input\": [
+        {\"type\": \"text\", \"text\": \"An office group photo of these people, they are making funny faces.\"},
+        {\"type\": \"image\", \"mime_type\": \"image/png\", \"data\": \"<BASE64_DATA_IMG_1>\"},
+        {\"type\": \"image\", \"mime_type\": \"image/png\", \"data\": \"<BASE64_DATA_IMG_2>\"},
+        {\"type\": \"image\", \"mime_type\": \"image/png\", \"data\": \"<BASE64_DATA_IMG_3>\"},
+        {\"type\": \"image\", \"mime_type\": \"image/png\", \"data\": \"<BASE64_DATA_IMG_4>\"},
+        {\"type\": \"image\", \"mime_type\": \"image/png\", \"data\": \"<BASE64_DATA_IMG_5>\"}
+      ],
+      \"response_format\": {
+        \"type\": \"image\",
+        \"aspect_ratio\": \"5:4\",
+        \"image_size\": \"2K\"
+      }
+    }"
+
        +
        +
        + AI-generated office group photo +
        AI-generated office group photo
        +
        + +

        Grounding with Google Search

        + +

        Use the Google Search tool to generate images +based on real-time information, such as weather forecasts, stock charts, or +recent events.

        + +

        Note that when using Grounding with Google Search with image generation, +image-based search results are not passed to the generation model and are +excluded from the response (see Grounding with Google Image Search)

        +
        +

        Python

        from google import genai
+from google.genai import types
+import base64
+prompt = "Visualize the current weather forecast for the next 5 days in San Francisco as a clean, modern weather chart. Add a visual on what I should wear each day"
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=prompt,
+    tools=[{"type": "google_search"}],
+    response_format={
+        "type": "image",
+        "mime_type": "image/jpeg",
+        "aspect_ratio": "16:9"
+    },
+)
+
+with open("weather.png", "wb") as f:
+    f.write(base64.b64decode(interaction.output_image.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "Visualize the current weather forecast for the next 5 days in San Francisco as a clean, modern weather chart. Add a visual on what I should wear each day",
+    tools: [{"type": "google_search"}],
+    response_format: {
+      type: "image",
+      mime_type: "image/png",
+      aspect_ratio: "16:9",
+      image_size: "2K"
+    },
+  });
+
+  const buffer = Buffer.from(interaction.output_image.data, 'base64');
+
+  fs.writeFileSync('weather.png', buffer);
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.CreateModelInteractionResponseFormat;
+import com.google.genai.gaos.models.interactions.GoogleSearch;
+import com.google.genai.gaos.models.interactions.ImageResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatAspectRatio;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ResponseFormat;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+
+String prompt =
+    "Visualize the current weather forecast for the next 5 days in San Francisco as a clean, modern weather chart. Add a visual on what I should wear each day";
+
+Client client = new Client();
+
+CreateModelInteractionResponseFormat format =
+    CreateModelInteractionResponseFormat.of(
+        ResponseFormat.of(
+            ImageResponseFormat.builder()
+                .mimeType(ImageResponseFormatMimeType.IMAGE_JPEG)
+                .aspectRatio(ImageResponseFormatAspectRatio.of("16:9"))
+                .build()));
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.of(prompt))
+        .tools(Arrays.asList(new GoogleSearch()))
+        .responseFormat(format)
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.outputImage().isPresent()
+    && interaction.outputImage().get().data().isPresent()) {
+  byte[] imageBytes =
+      Base64.getDecoder().decode(interaction.outputImage().get().data().get());
+  Files.write(Paths.get("weather.png"), imageBytes);
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    prompt := "Visualize the current weather forecast for the next 5 days in San Francisco as a clean, modern weather chart. Add a visual on what I should wear each day"
+
+    format := interactions.NewCreateModelInteractionResponseFormat(
+        interactions.NewResponseFormat(interactions.ImageResponseFormat{
+            MimeType:    interactions.ImageResponseFormatMimeTypeImageJpeg.ToPointer(),
+            AspectRatio: interactions.ImageResponseFormatAspectRatio("16:9").ToPointer(),
+        }),
+    )
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput(prompt),
+            Tools: []interactions.Tool{
+                interactions.NewTool(interactions.GoogleSearch{}),
+            },
+            ResponseFormat: genai.Ptr(format),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    if res.Interaction.OutputImage != nil && res.Interaction.OutputImage.Data != nil {
+        imageBytes, err := base64.StdEncoding.DecodeString(*res.Interaction.OutputImage.Data)
+        if err != nil {
+            log.Fatal(err)
+        }
+        if err := os.WriteFile("weather.png", imageBytes, 0644); err != nil {
+            log.Fatal(err)
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": [
+      {"type": "text", "text": "Visualize the current weather forecast for the next 5 days in San Francisco as a clean, modern weather chart. Add a visual on what I should wear each day"}
+    ],
+    "tools": [{"type": "google_search"}],
+    "response_format": {
+      "type": "image",
+      "mime_type": "image/jpeg",
+      "aspect_ratio": "16:9"
+    }
+  }'
+
        +
        +
        + AI-generated five day weather chart for San Francisco +
        AI-generated five day weather chart for San Francisco
        +
        + +

        The response includes google_search_call and google_search_result steps, +along with inline url_citation annotations on the text step:

        + +
          +
        • google_search_result: Contains search_suggestions, an HTML snippet +for rendering search suggestions in your UI.
          • +
        • url_citation annotations: Inline citations on the text step linking +parts of the response to their web sources.
          • +
        + + + +

        Grounding with Google Image Search allows models to use web images retrieved via +Google Image Search as visual context for image generation. Image Search is a +new search type within the existing Grounding with Google Search tool, +functioning alongside standard Web Search.

        + +

        To enable Image Search, configure the google_search tool in your API request +and specify image_search within the search_types array. Image Search can be +used independently or together with Web Search.

        +
        +

        Python

        from google import genai
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="A detailed painting of a Timareta butterfly resting on a flower",
+    tools=[{
+      "type": "google_search",
+      "search_types": ["web_search", "image_search"]
+    }]
+)
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "A detailed painting of a Timareta butterfly resting on a flower",
+    tools: [{
+      "type": "google_search",
+      "search_types": ["web_search", "image_search"]
+    }]
+  });
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.GoogleSearch;
+import com.google.genai.gaos.models.interactions.GoogleSearchSearchType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.util.Arrays;
+
+Client client = new Client();
+
+GoogleSearch searchTool =
+    GoogleSearch.builder()
+        .searchTypes(
+            Arrays.asList(
+                GoogleSearchSearchType.WEB_SEARCH, GoogleSearchSearchType.IMAGE_SEARCH))
+        .build();
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "A detailed painting of a Timareta butterfly resting on a flower"))
+        .tools(Arrays.asList(searchTool))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
        +

        Go

        package main
+
+import (
+    "context"
+    "log"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    searchTool := interactions.GoogleSearch{
+        SearchTypes: []interactions.GoogleSearchSearchType{
+            interactions.GoogleSearchSearchTypeWebSearch,
+            interactions.GoogleSearchSearchTypeImageSearch,
+        },
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput("A detailed painting of a Timareta butterfly resting on a flower"),
+            Tools: []interactions.Tool{
+                interactions.NewTool(searchTool),
+            },
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+    _ = res
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "A detailed painting of a Timareta butterfly resting on a flower",
+    "tools": [{"type": "google_search", "search_types": ["web_search", "image_search"]}]
+  }'
+
        +
        +

        Display requirements

        + +

        When you use Image Search within Grounding with Google Search, you must display +the search_suggestions from the google_search_result step. Full usage +requirements are detailed in the +Terms of Service.

        + +

        Response

        + +

        For grounded responses using image search, the API returns inline citations +and attribution metadata as part of the response steps:

        + +
          +

        • url_citation annotations: Inline citations on the text content block +within model_output, linking the generated content to its source.

          • +

        • google_search_result: Contains search_suggestions, an HTML +snippet for rendering search suggestions in your UI.

          • +
        + +

        Video-to-image generation (Nano Banana 2.1, 3.1 Flash, and 3.1 Flash Lite)

        + +

        Video-to-image generation allows you to generate new images using a video's context +as a multimodal reference. This is useful for creating high-quality video thumbnails, cinematic +posters, summary infographics, or new artwork inspired by a video scene.

        + +

        During generation, the model analyzes the video frames in context to extract visual themes +and key events, then uses them alongside your text prompt to synthesize the output image.

        + +

        You can pass public YouTube URLs +directly in your API request or upload local video files using the +Files API.

        +
        +

        Python

        from google import genai
+from google.genai import types
+import base64
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=[
+        {
+            "type": "video",
+            "uri": "https://www.youtube.com/watch?v=UTdfxFyOQTI",
+            "mime_type": "video/mp4"
+        },
+        {"type": "text", "text": "Generate a poster image that captures the key themes of this video."}
+    ],
+    response_format={"type": "image", "aspect_ratio": "16:9"}
+)
+
+# Save the generated image part
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("video_poster.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+                print("Image saved as video_poster.png")
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: [
+      {
+        type: "video",
+        uri: "https://www.youtube.com/watch?v=UTdfxFyOQTI",
+        mime_type: "video/mp4"
+      },
+      { type: "text", text: "Generate a poster image that captures the key themes of this video." }
+    ],
+    response_format: {
+      type: "image",
+      aspect_ratio: "16:9"
+    }
+  });
+
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("video_poster.png", buffer);
+          console.log("Image saved as video_poster.png");
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.CreateModelInteractionResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatAspectRatio;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.ResponseFormat;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.interactions.VideoContent;
+import com.google.genai.gaos.models.interactions.VideoContentMimeType;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.List;
+
+Client client = new Client();
+
+Content videoContent =
+    VideoContent.builder()
+        .uri("https://www.youtube.com/watch?v=UTdfxFyOQTI")
+        .mimeType(VideoContentMimeType.VIDEO_MP4)
+        .build();
+Content textContent =
+    TextContent.builder()
+        .text("Generate a poster image that captures the key themes of this video.")
+        .build();
+
+List<Content> contents = Arrays.asList(videoContent, textContent);
+
+CreateModelInteractionResponseFormat format =
+    CreateModelInteractionResponseFormat.of(
+        ResponseFormat.of(
+            ImageResponseFormat.builder()
+                .aspectRatio(ImageResponseFormatAspectRatio.of("16:9"))
+                .build()));
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.ofContent(contents))
+        .responseFormat(format)
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content block : outputStep.content().get()) {
+          if (block instanceof TextContent) {
+            System.out.println(((TextContent) block).text().orElse(""));
+          } else if (block instanceof ImageContent) {
+            ImageContent img = (ImageContent) block;
+            if (img.data().isPresent()) {
+              byte[] imgBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("video_poster.png"), imgBytes);
+              System.out.println("Image saved as video_poster.png");
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    contents := []interactions.Content{
+        interactions.NewContent(interactions.VideoContent{
+            URI:      genai.Ptr("https://www.youtube.com/watch?v=UTdfxFyOQTI"),
+            MimeType: interactions.VideoContentMimeTypeVideoMp4.ToPointer(),
+        }),
+        interactions.NewContent(interactions.TextContent{
+            Text: "Generate a poster image that captures the key themes of this video.",
+        }),
+    }
+
+    format := interactions.NewCreateModelInteractionResponseFormat(
+        interactions.NewResponseFormat(interactions.ImageResponseFormat{
+            AspectRatio: interactions.ImageResponseFormatAspectRatio("16:9").ToPointer(),
+        }),
+    )
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model:          interactions.Model("gemini-nano-banana-2.1"),
+            Input:          interactions.NewInteractionsInput(contents),
+            ResponseFormat: genai.Ptr(format),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, block := range step.ModelOutputStep.Content {
+                if block.TextContent != nil {
+                    fmt.Println(block.TextContent.Text)
+                } else if block.ImageContent != nil && block.ImageContent.Data != nil {
+                    imgBytes, err := base64.StdEncoding.DecodeString(*block.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("video_poster.png", imgBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                    fmt.Println("Image saved as video_poster.png")
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": [
+      {
+        "type": "video",
+        "uri": "https://www.youtube.com/watch?v=UTdfxFyOQTI",
+        "mime_type": "video/mp4"
+      },
+      {
+        "type": "text",
+        "text": "Generate a poster image that captures the key themes of this video."
+      }
+    ],
+    "response_format": {
+      "type": "image",
+      "aspect_ratio": "16:9"
+    }
+  }'
+
        +
        +
        + AI-generated infographic from a youtube video +
        AI-generated infographic from a youtube video
        +
        + +

        Generate images up to 4K resolution

        + +

        Gemini 3 image models generate 1K images by default but can also output 2K, +4K, and 512px (05.K) (Gemini 3.1 Flash Image only) images. To generate higher +resolution assets, specify the image_size in the response_format.

        + +

        You must use an uppercase 'K' (e.g. 512px (05.K), 1K, 2K, 4K). Lowercase +parameters (e.g., 1k) will be rejected.

        +
        +

        Python

        from google import genai
+from google.genai import types
+import base64
+
+prompt = "Da Vinci style anatomical sketch of a dissected Monarch butterfly. Detailed drawings of the head, wings, and legs on textured parchment with notes in English."
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=prompt,
+    response_format={
+        "type": "image",
+        "mime_type": "image/jpeg",
+        "aspect_ratio": "1:1",
+        "image_size": "1K"
+    },
+)
+
+print(interaction.output_text)
+
+with open("butterfly.png", "wb") as f:
+    f.write(base64.b64decode(interaction.output_image.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "Da Vinci style anatomical sketch of a dissected Monarch butterfly. Detailed drawings of the head, wings, and legs on textured parchment with notes in English.",
+    response_format: {
+      type: "image",
+      mime_type: "image/png",
+      aspect_ratio: "1:1",
+      image_size: "1K",
+    },
+  });
+
+  console.log(interaction.output_text);
+
+  const buffer = Buffer.from(interaction.output_image.data, 'base64');
+
+  fs.writeFileSync('butterfly.png', buffer);
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.CreateModelInteractionResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatAspectRatio;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatImageSize;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ResponseFormat;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Base64;
+
+String prompt =
+    "Da Vinci style anatomical sketch of a dissected Monarch butterfly. Detailed drawings of the head, wings, and legs on textured parchment with notes in English.";
+
+Client client = new Client();
+
+CreateModelInteractionResponseFormat format =
+    CreateModelInteractionResponseFormat.of(
+        ResponseFormat.of(
+            ImageResponseFormat.builder()
+                .mimeType(ImageResponseFormatMimeType.IMAGE_JPEG)
+                .aspectRatio(ImageResponseFormatAspectRatio.of("1:1"))
+                .imageSize(ImageResponseFormatImageSize.ONE_K)
+                .build()));
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.of(prompt))
+        .responseFormat(format)
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+System.out.println(interaction.outputText().orElse(""));
+
+if (interaction.outputImage().isPresent()
+    && interaction.outputImage().get().data().isPresent()) {
+  byte[] imageBytes =
+      Base64.getDecoder().decode(interaction.outputImage().get().data().get());
+  Files.write(Paths.get("butterfly.png"), imageBytes);
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    prompt := "Da Vinci style anatomical sketch of a dissected Monarch butterfly. Detailed drawings of the head, wings, and legs on textured parchment with notes in English."
+
+    format := interactions.NewCreateModelInteractionResponseFormat(
+        interactions.NewResponseFormat(interactions.ImageResponseFormat{
+            MimeType:    interactions.ImageResponseFormatMimeTypeImageJpeg.ToPointer(),
+            AspectRatio: interactions.ImageResponseFormatAspectRatio("1:1").ToPointer(),
+            ImageSize:   interactions.ImageResponseFormatImageSizeOneK.ToPointer(),
+        }),
+    )
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model:          interactions.Model("gemini-nano-banana-2.1"),
+            Input:          interactions.NewInteractionsInput(prompt),
+            ResponseFormat: genai.Ptr(format),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    if res.Interaction.OutputText != nil {
+        fmt.Println(*res.Interaction.OutputText)
+    }
+
+    if res.Interaction.OutputImage != nil && res.Interaction.OutputImage.Data != nil {
+        imageBytes, err := base64.StdEncoding.DecodeString(*res.Interaction.OutputImage.Data)
+        if err != nil {
+            log.Fatal(err)
+        }
+        if err := os.WriteFile("butterfly.png", imageBytes, 0644); err != nil {
+            log.Fatal(err)
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "Da Vinci style anatomical sketch of a dissected Monarch butterfly. Detailed drawings of the head, wings, and legs on textured parchment with notes in English.",
+    "response_format": {
+      "type": "image",
+      "mime_type": "image/jpeg",
+      "aspect_ratio": "1:1",
+      "image_size": "1K"
+    }
+  }'
+
        +
        +

        The following is an example image generated from this prompt:

        + +
        + AI-generated Da Vinci style anatomical sketch of a dissected Monarch butterfly. +
        AI-generated Da Vinci style anatomical sketch of a dissected Monarch butterfly.
        +
        + +

        Thinking process

        + +

        Gemini 3 image models are thinking models that use a reasoning +process ("Thinking") for complex prompts. This feature is enabled by default and +cannot be disabled in the API. To learn more about the thinking process, see +the Gemini Thinking guide.

        + +

        The model generates up to two interim images to test composition and logic. The +last image within Thinking is also the final rendered image.

        + +

        You can check the thoughts that lead to the final image being produced.

        +
        +

        Python

        for step in interaction.steps:
+    if step.type == "thought":
+        for content_block in step.summary:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                image = Image.open(io.BytesIO(base64.b64decode(content_block.data)))
+                image.show()
+
        +

        JavaScript

        for (const step of interaction.steps) {
+  if (step.type === "thought") {
+    for (const contentBlock of step.summary) {
+      if (contentBlock.type === "text") {
+        console.log(contentBlock.text);
+      } else if (contentBlock.type === "image") {
+        const buffer = Buffer.from(contentBlock.data, 'base64');
+        fs.writeFileSync('thought_image.png', buffer);
+      }
+    }
+  }
+}
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.interactions.ThoughtStep;
+import com.google.genai.gaos.models.interactions.ThoughtSummaryContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "A futuristic city built inside a giant glass bottle floating in space"))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ThoughtStep) {
+      ThoughtStep thoughtStep = (ThoughtStep) step;
+      if (thoughtStep.summary().isPresent()) {
+        for (ThoughtSummaryContent contentBlock : thoughtStep.summary().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] imgBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("thought_image.png"), imgBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput("A futuristic city built inside a giant glass bottle floating in space"),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ThoughtStep != nil {
+            for _, contentBlock := range step.ThoughtStep.Summary {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    imgBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("thought_image.png", imgBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +
        +

        Interleaved text and images

        + +

        While standard image generation models only output images, some advanced Gemini +3 models (such as gemini-3-pro-image) can generate interleaved +content—like stories or instructional guides containing both text blocks and +illustrations inside the same response.

        + +

        Because the output is complex and interleaved, convenience properties like +.output_image or .output_text will not capture the full sequence. To access +and save interleaved content, you must manually iterate over steps:

        +
        +

        Python

        interaction = client.interactions.create(
+    model="gemini-3-pro-image",
+    input="Write the story of the lifecycle of a monarch butterfly, interleave illustrations",
+)
+
+image_counter = 1
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                filename = f"butterfly_lifecycle_{image_counter}.png"
+                with open(filename, "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+                print(f"\n[Saved illustration: {filename}]\n")
+                image_counter += 1
+
        +

        JavaScript

        const interaction = await ai.interactions.create({
+    model: "gemini-3-pro-image",
+    input: "Write the story of the lifecycle of a monarch butterfly, interleave illustrations",
+});
+
+let imageCounter = 1;
+for (const step of interaction.steps) {
+  if (step.type === "model_output") {
+    for (const contentBlock of step.content) {
+      if (contentBlock.type === "text") {
+        console.log(contentBlock.text);
+      } else if (contentBlock.type === "image") {
+        const buffer = Buffer.from(contentBlock.data, "base64");
+        const filename = `butterfly_lifecycle_${imageCounter}.png`;
+        fs.writeFileSync(filename, buffer);
+        console.log(`\n[Saved illustration: ${filename}]\n`);
+        imageCounter++;
+      }
+    }
+  }
+}
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-3-pro-image"))
+        .input(
+            InteractionsInput.of(
+                "Write the story of the lifecycle of a monarch butterfly, interleave illustrations"))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+int imageCounter = 1;
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              String filename = String.format("butterfly_lifecycle_%d.png", imageCounter);
+              byte[] imgBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get(filename), imgBytes);
+              System.out.printf("%n[Saved illustration: %s]%n", filename);
+              imageCounter++;
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-3-pro-image"),
+            Input: interactions.NewInteractionsInput("Write the story of the lifecycle of a monarch butterfly, interleave illustrations"),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    imageCounter := 1
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    filename := fmt.Sprintf("butterfly_lifecycle_%d.png", imageCounter)
+                    imgBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile(filename, imgBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                    fmt.Printf("\n[Saved illustration: %s]\n", filename)
+                    imageCounter++
+                }
+            }
+        }
+    }
+}
+
        +
        +

        Controlling thinking levels

        + +

        With Gemini Nano Banana 2.1, Gemini 3.1 Flash Image, and Gemini 3.1 Flash Lite +Image, you can control the amount of thinking the model uses to balance quality +and latency:

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        ModelSupported thinking levelsDefault
        Gemini Nano Banana 2.1minimal, medium, highmedium
        Gemini 3.1 Flash Imageminimal, highminimal
        Gemini 3.1 Flash Lite Imageminimal, highminimal
        +
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+import io
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="A futuristic city built inside a giant glass bottle floating in space",
+    generation_config={"thinking_level": "high"},
+)
+
+print(interaction.output_text)
+
+image = Image.open(io.BytesIO(base64.b64decode(interaction.output_image.data)))
+
+image.show()
+
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "A futuristic city built inside a giant glass bottle floating in space",
+    generation_config: { thinking_level: "high" },
+  });
+
+  console.log(interaction.output_text);
+
+  const buffer = Buffer.from(interaction.output_image.data, 'base64');
+
+  fs.writeFileSync('image.png', buffer);
+}
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.GenerationConfig;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ThinkingLevel;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "A futuristic city built inside a giant glass bottle floating in space"))
+        .generationConfig(GenerationConfig.builder().thinkingLevel(ThinkingLevel.HIGH).build())
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+System.out.println(interaction.outputText().orElse(""));
+
+if (interaction.outputImage().isPresent()
+    && interaction.outputImage().get().data().isPresent()) {
+  byte[] imageBytes =
+      Base64.getDecoder().decode(interaction.outputImage().get().data().get());
+  Files.write(Paths.get("futuristic_city.png"), imageBytes);
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput("A futuristic city built inside a giant glass bottle floating in space"),
+            GenerationConfig: &interactions.GenerationConfig{
+                ThinkingLevel: interactions.ThinkingLevelHigh.ToPointer(),
+            },
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    if res.Interaction.OutputText != nil {
+        fmt.Println(*res.Interaction.OutputText)
+    }
+
+    if res.Interaction.OutputImage != nil && res.Interaction.OutputImage.Data != nil {
+        imageBytes, err := base64.StdEncoding.DecodeString(*res.Interaction.OutputImage.Data)
+        if err != nil {
+            log.Fatal(err)
+        }
+        if err := os.WriteFile("futuristic_city.png", imageBytes, 0644); err != nil {
+            log.Fatal(err)
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "A futuristic city built inside a giant glass bottle floating in space",
+    "generation_config": {
+      "thinking_level": "high"
+    }
+  }'
+
        +
        +

        Note that thinking tokens are billed by default for thinking models, as the +thinking process always happens by default whether you view +the process or not.

        + +

        Other image generation modes

        + +

        Although Nano Banana image generation models are recommended for most use cases, +you can also explore dedicated image generation models:

        + +
          +
        • Imagen: Google's legacy text-to-image models (shut down).
          • +
        • Veo: Google's video generation model.
          • +
        + +

        Generate images in batch

        + +

        All of the image generation capabilities described on this page can also be +run as batch jobs using the +Batch API, which is ideal if you +need to generate many images.You get higher rate limits in exchange for a +turnaround of up to 24 hours.

        + +

        Prompting guide and strategies

        + +

        This section provides prompt examples and templates for common image generation +and editing workflows. Each example includes a re-usable template and a +sample prompt for the Interactions API.

        + +

        Prompts for generating images

        + +

        The following examples show how to use text prompts to generate various types of +images.

        + +

        1. Photorealistic scenes

        + +

        Describe a scene in rich detail. The more specific you are, the more control you +have over the results.

        +
        +

        Template

        A photorealistic [type of shot] of a [subject description] in a [setting
+description]. [Description of the light]. Shot from a [camera angle]
+with a [lens type].
+
        +

        Prompt

        A photorealistic wide-angle shot of a vibrant coral reef teeming with tropical fish. Crystal-clear turquoise water with sunbeams filtering down from the surface, illuminating a sea turtle gliding gracefully over the coral. Shot from a low perspective with a wide-angle lens. Aspect ratio 16:9.
+
        +

        Python

        from google import genai
+from google.genai import types
+import base64
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="A photorealistic wide-angle shot of a vibrant coral reef teeming with tropical fish. Crystal-clear turquoise water with sunbeams filtering down from the surface, illuminating a sea turtle gliding gracefully over the coral. Shot from a low perspective with a wide-angle lens. Aspect ratio 16:9.",
+    response_format=[
+        {
+            "type": "image",
+            "mime_type": "image/jpeg",
+            "aspect_ratio": "16:9",
+        }
+    ],
+)
+
+print(interaction.output_text)
+
+with open("coral_reef.png", "wb") as f:
+
+    f.write(base64.b64decode(interaction.output_image.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "A photorealistic wide-angle shot of a vibrant coral reef teeming with tropical fish. Crystal-clear turquoise water with sunbeams filtering down from the surface, illuminating a sea turtle gliding gracefully over the coral. Shot from a low perspective with a wide-angle lens. Aspect ratio 16:9.",
+    response_format: [
+      {
+        type: "image",
+        mime_type: "image/jpeg",
+        aspect_ratio: "16:9",
+      }
+    ],
+  });
+  console.log(interaction.output_text);
+
+  const buffer = Buffer.from(interaction.output_image.data, 'base64');
+
+  fs.writeFileSync('coral_reef.png', buffer);
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.CreateModelInteractionResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatAspectRatio;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ResponseFormat;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteractionResponseFormat format =
+    CreateModelInteractionResponseFormat.of(
+        Arrays.asList(
+            ResponseFormat.of(
+                ImageResponseFormat.builder()
+                    .mimeType(ImageResponseFormatMimeType.IMAGE_JPEG)
+                    .aspectRatio(ImageResponseFormatAspectRatio.of("16:9"))
+                    .build())));
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "A photorealistic wide-angle shot of a vibrant coral reef teeming with tropical fish. Crystal-clear turquoise water with sunbeams filtering down from the surface, illuminating a sea turtle gliding gracefully over the coral. Shot from a low perspective with a wide-angle lens. Aspect ratio 16:9."))
+        .responseFormat(format)
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+System.out.println(interaction.outputText().orElse(""));
+
+if (interaction.outputImage().isPresent()
+    && interaction.outputImage().get().data().isPresent()) {
+  byte[] imageBytes =
+      Base64.getDecoder().decode(interaction.outputImage().get().data().get());
+  Files.write(Paths.get("coral_reef.png"), imageBytes);
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    format := interactions.NewCreateModelInteractionResponseFormat([]interactions.ResponseFormat{
+        interactions.NewResponseFormat(interactions.ImageResponseFormat{
+            MimeType:    interactions.ImageResponseFormatMimeTypeImageJpeg.ToPointer(),
+            AspectRatio: interactions.ImageResponseFormatAspectRatio("16:9").ToPointer(),
+        }),
+    })
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model:          interactions.Model("gemini-nano-banana-2.1"),
+            Input:          interactions.NewInteractionsInput("A photorealistic wide-angle shot of a vibrant coral reef teeming with tropical fish. Crystal-clear turquoise water with sunbeams filtering down from the surface, illuminating a sea turtle gliding gracefully over the coral. Shot from a low perspective with a wide-angle lens. Aspect ratio 16:9."),
+            ResponseFormat: genai.Ptr(format),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    if res.Interaction.OutputText != nil {
+        fmt.Println(*res.Interaction.OutputText)
+    }
+
+    if res.Interaction.OutputImage != nil && res.Interaction.OutputImage.Data != nil {
+        imageBytes, err := base64.StdEncoding.DecodeString(*res.Interaction.OutputImage.Data)
+        if err != nil {
+            log.Fatal(err)
+        }
+        if err := os.WriteFile("coral_reef.png", imageBytes, 0644); err != nil {
+            log.Fatal(err)
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "A photorealistic wide-angle shot of a vibrant coral reef teeming with tropical fish. Crystal-clear turquoise water with sunbeams filtering down from the surface, illuminating a sea turtle gliding gracefully over the coral. Shot from a low perspective with a wide-angle lens. Aspect ratio 16:9.",
+    "response_format": {
+      "type": "image",
+      "mime_type": "image/png",
+      "aspect_ratio": "16:9"
+    }
+  }'
+
        +
        +

        2. Stylized illustrations & stickers

        + +

        Describe the artistic style, subject, and medium. Be specific about the visual +detail (bold lines, colors, etc.) for consistent results.

        +
        +

        Template

        A [style] of a [subject, with details about accessories or actions]
+doing [activity]. The design features [visual qualities, e.g., bold outlines,
+cel-shading, etc.] and [color/background preference].
+
        +

        Prompt

        A kawaii-style sticker of a happy red panda wearing a tiny bamboo hat. It's munching on a green bamboo leaf. The design features bold, clean outlines, simple cel-shading, and a vibrant color palette. The background must be white.
+
        +

        Python

        from google import genai
+import base64
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="A kawaii-style sticker of a happy red panda wearing a tiny bamboo hat. It's munching on a green bamboo leaf. The design features bold, clean outlines, simple cel-shading, and a vibrant color palette. The background must be white.",
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("red_panda_sticker.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "A kawaii-style sticker of a happy red panda wearing a tiny bamboo hat. It's munching on a green bamboo leaf. The design features bold, clean outlines, simple cel-shading, and a vibrant color palette. The background must be white.",
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("red_panda_sticker.png", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "A kawaii-style sticker of a happy red panda wearing a tiny bamboo hat. It's munching on a green bamboo leaf. The design features bold, clean outlines, simple cel-shading, and a vibrant color palette. The background must be white."))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] imgBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("red_panda_sticker.png"), imgBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput("A kawaii-style sticker of a happy red panda wearing a tiny bamboo hat. It's munching on a green bamboo leaf. The design features bold, clean outlines, simple cel-shading, and a vibrant color palette. The background must be white."),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    imgBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("red_panda_sticker.png", imgBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "A kawaii-style sticker of a happy red panda wearing a tiny bamboo hat. It is munching on a green bamboo leaf. The design features bold, clean outlines, simple cel-shading, and a vibrant color palette. The background must be white."
+  }'
+
        +
        +
        + A kawaii-style sticker of a happy red... +
        A kawaii-style sticker of a happy red panda...
        +
        + +

        3. Accurate text in images

        + +

        Gemini excels at rendering text. Be clear about the text, the font style +(descriptively), and the overall design. Use Gemini 3 Pro Image for +professional asset production.

        +
        +

        Template

        Create a [image type] for [brand/concept] with the text "[text to render]"
+in a [font style]. The design should be [style description], with a
+[color scheme].
+
        +

        Prompt

        Create a modern, minimalist logo for a coffee shop called 'The Daily Grind'. The text should be in a clean, bold, sans-serif font. The color scheme is black and white. Put the logo in a circle. Use a coffee bean in a clever way.
+
        +

        Python

        from google import genai
+import base64
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="Create a modern, minimalist logo for a coffee shop called 'The Daily Grind'. The text should be in a clean, bold, sans-serif font. The color scheme is black and white. Put the logo in a circle. Use a coffee bean in a clever way.",
+    response_format={"type": "image", "aspect_ratio": "1:1"},
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("logo_example.jpg", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "Create a modern, minimalist logo for a coffee shop called 'The Daily Grind'. The text should be in a clean, bold, sans-serif font. The color scheme is black and white. Put the logo in a circle. Use a coffee bean in a clever way.",
+    response_format: { type: "image", aspect_ratio: "1:1" },
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("logo_example.jpg", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.CreateModelInteractionResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatAspectRatio;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.ResponseFormat;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteractionResponseFormat format =
+    CreateModelInteractionResponseFormat.of(
+        ResponseFormat.of(
+            ImageResponseFormat.builder()
+                .aspectRatio(ImageResponseFormatAspectRatio.of("1:1"))
+                .build()));
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "Create a modern, minimalist logo for a coffee shop called 'The Daily Grind'. The text should be in a clean, bold, sans-serif font. The color scheme is black and white. Put the logo in a circle. Use a coffee bean in a clever way."))
+        .responseFormat(format)
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] imgBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("logo_example.jpg"), imgBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    format := interactions.NewCreateModelInteractionResponseFormat(
+        interactions.NewResponseFormat(interactions.ImageResponseFormat{
+            AspectRatio: interactions.ImageResponseFormatAspectRatio("1:1").ToPointer(),
+        }),
+    )
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model:          interactions.Model("gemini-nano-banana-2.1"),
+            Input:          interactions.NewInteractionsInput("Create a modern, minimalist logo for a coffee shop called 'The Daily Grind'. The text should be in a clean, bold, sans-serif font. The color scheme is black and white. Put the logo in a circle. Use a coffee bean in a clever way."),
+            ResponseFormat: genai.Ptr(format),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    imgBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("logo_example.jpg", imgBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "Create a modern, minimalist logo for a coffee shop called The Daily Grind. The text should be in a clean, bold, sans-serif font. The color scheme is black and white. Put the logo in a circle. Use a coffee bean in a clever way.",
+    "response_format": {
+      "type": "image",
+      "aspect_ratio": "1:1"
+    }
+  }'
+
        +
        +
        + Create a modern, minimalist logo for a coffee shop called 'The Daily Grind'... +
        Create a modern, minimalist logo for a coffee shop called 'The Daily Grind'...
        +
        + +

        4. Product mockups & commercial photography

        + +

        Perfect for creating clean, professional product shots for ecommerce, +advertising, or branding.

        +
        +

        Template

        A high-resolution, studio-lit product photograph of a [product description]
+on a [background surface/description]. The lighting is a [lighting setup,
+e.g., three-point softbox setup] to [lighting purpose]. The camera angle is
+a [angle type] to showcase [specific feature]. Ultra-realistic, with sharp
+focus on [key detail]. [Aspect ratio].
+
        +

        Prompt

        A high-resolution, studio-lit product photograph of a minimalist ceramic
+coffee mug in matte black, presented on a polished concrete surface. The
+lighting is a three-point softbox setup designed to create soft, diffused
+highlights and eliminate harsh shadows. The camera angle is a slightly
+elevated 45-degree shot to showcase its clean lines. Ultra-realistic, with
+sharp focus on the steam rising from the coffee. Square image.
+
        +

        Python

        from google import genai
+import base64
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="A high-resolution, studio-lit product photograph of a minimalist ceramic coffee mug in matte black, presented on a polished concrete surface. The lighting is a three-point softbox setup designed to create soft, diffused highlights and eliminate harsh shadows. The camera angle is a slightly elevated 45-degree shot to showcase its clean lines. Ultra-realistic, with sharp focus on the steam rising from the coffee. Square image.",
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("product_mockup.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "A high-resolution, studio-lit product photograph of a minimalist ceramic coffee mug in matte black, presented on a polished concrete surface. The lighting is a three-point softbox setup designed to create soft, diffused highlights and eliminate harsh shadows. The camera angle is a slightly elevated 45-degree shot to showcase its clean lines. Ultra-realistic, with sharp focus on the steam rising from the coffee. Square image.",
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("product_mockup.png", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "A high-resolution, studio-lit product photograph of a minimalist ceramic coffee mug in matte black, presented on a polished concrete surface. The lighting is a three-point softbox setup designed to create soft, diffused highlights and eliminate harsh shadows. The camera angle is a slightly elevated 45-degree shot to showcase its clean lines. Ultra-realistic, with sharp focus on the steam rising from the coffee. Square image."))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] imgBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("product_mockup.png"), imgBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput("A high-resolution, studio-lit product photograph of a minimalist ceramic coffee mug in matte black, presented on a polished concrete surface. The lighting is a three-point softbox setup designed to create soft, diffused highlights and eliminate harsh shadows. The camera angle is a slightly elevated 45-degree shot to showcase its clean lines. Ultra-realistic, with sharp focus on the steam rising from the coffee. Square image."),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    imgBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("product_mockup.png", imgBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "A high-resolution, studio-lit product photograph of a minimalist ceramic coffee mug in matte black, presented on a polished concrete surface. The lighting is a three-point softbox setup designed to create soft, diffused highlights and eliminate harsh shadows. The camera angle is a slightly elevated 45-degree shot to showcase its clean lines. Ultra-realistic, with sharp focus on the steam rising from the coffee. Square image."
+  }'
+
        +
        +
        + A high-resolution, studio-lit product photograph of a minimalist ceramic coffee mug... +
        A high-resolution, studio-lit product photograph of a minimalist ceramic coffee mug...
        +
        + +

        5. Minimalist & negative space design

        + +

        Excellent for creating backgrounds for websites, presentations, or marketing +materials where text will be overlaid.

        +
        +

        Template

        A minimalist composition featuring a single [subject] positioned in the
+[bottom-right/top-left/etc.] of the frame. The background is a vast, empty
+[color] canvas, creating significant negative space. Soft, subtle lighting.
+[Aspect ratio].
+
        +

        Prompt

        A minimalist composition featuring a single, delicate red maple leaf
+positioned in the bottom-right of the frame. The background is a vast, empty
+off-white canvas, creating significant negative space for text. Soft,
+diffused lighting from the top left. Square image.
+
        +

        Python

        from google import genai
+import base64
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="A minimalist composition featuring a single, delicate red maple leaf positioned in the bottom-right of the frame. The background is a vast, empty off-white canvas, creating significant negative space for text. Soft, diffused lighting from the top left. Square image.",
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("minimalist_design.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "A minimalist composition featuring a single, delicate red maple leaf positioned in the bottom-right of the frame. The background is a vast, empty off-white canvas, creating significant negative space for text. Soft, diffused lighting from the top left. Square image.",
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("minimalist_design.png", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "A minimalist composition featuring a single, delicate red maple leaf positioned in the bottom-right of the frame. The background is a vast, empty off-white canvas, creating significant negative space for text. Soft, diffused lighting from the top left. Square image."))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] imgBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("minimalist_design.png"), imgBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput("A minimalist composition featuring a single, delicate red maple leaf positioned in the bottom-right of the frame. The background is a vast, empty off-white canvas, creating significant negative space for text. Soft, diffused lighting from the top left. Square image."),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    imgBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("minimalist_design.png", imgBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "A minimalist composition featuring a single, delicate red maple leaf positioned in the bottom-right of the frame. The background is a vast, empty off-white canvas, creating significant negative space for text. Soft, diffused lighting from the top left. Square image."
+  }'
+
        +
        +
        + A minimalist composition featuring a single, delicate red maple leaf... +
        A minimalist composition featuring a single, delicate red maple leaf...
        +
        + +

        6. Sequential art (comic panel / storyboard)

        + +

        Builds on character consistency and scene description to create panels for +visual storytelling. For accuracy with text and storytelling ability, these +prompts work best with Gemini 3 Pro and Gemini 3.1 Flash Image.

        +
        +

        Template

        Make a 3 panel comic in a [style]. Put the character in a [type of scene].
+
        +

        Prompt

        Make a 3 panel comic in a gritty, noir art style with high-contrast black and white inks. Put the character in a humurous scene.
+
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+
+client = genai.Client()
+
+with open('/path/to/your/man_in_white_glasses.jpg', 'rb') as f:
+    image_bytes = f.read()
+text_input = "Make a 3 panel comic in a gritty, noir art style with high-contrast black and white inks. Put the character in a humurous scene."
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=[
+        {"type": "text", "text": text_input},
+        {
+            "type": "image",
+            "data": base64.b64encode(image_bytes).decode('utf-8'),
+            "mime_type": "image/jpeg"
+        }
+    ],
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("comic_panel.jpg", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const imagePath = "/path/to/your/man_in_white_glasses.jpg";
+  const imageData = fs.readFileSync(imagePath);
+  const base64Image = imageData.toString("base64");
+
+  const input = [
+    { type: "text", text: "Make a 3 panel comic in a gritty, noir art style with high-contrast black and white inks. Put the character in a humurous scene." },
+    {
+      type: "image",
+      mime_type: "image/jpeg",
+      data: base64Image
+    },
+  ];
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: input,
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("comic_panel.jpg", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageContentMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.List;
+
+Client client = new Client();
+
+byte[] imageBytes = Files.readAllBytes(Paths.get("/path/to/your/man_in_white_glasses.jpg"));
+String base64Image = Base64.getEncoder().encodeToString(imageBytes);
+String textInput =
+    "Make a 3 panel comic in a gritty, noir art style with high-contrast black and white inks. Put the character in a humurous scene.";
+
+Content textContent = TextContent.builder().text(textInput).build();
+Content imageContent =
+    ImageContent.builder()
+        .data(base64Image)
+        .mimeType(ImageContentMimeType.IMAGE_JPEG)
+        .build();
+
+List<Content> contents = Arrays.asList(textContent, imageContent);
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.ofContent(contents))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] outBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("comic_panel.jpg"), outBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    imageBytes, err := os.ReadFile("/path/to/your/man_in_white_glasses.jpg")
+    if err != nil {
+        log.Fatal(err)
+    }
+    base64Image := base64.StdEncoding.EncodeToString(imageBytes)
+    textInput := "Make a 3 panel comic in a gritty, noir art style with high-contrast black and white inks. Put the character in a humurous scene."
+
+    contents := []interactions.Content{
+        interactions.NewContent(interactions.TextContent{
+            Text: textInput,
+        }),
+        interactions.NewContent(interactions.ImageContent{
+            Data:     genai.Ptr(base64Image),
+            MimeType: interactions.ImageContentMimeTypeImageJpeg.ToPointer(),
+        }),
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput(contents),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    outBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("comic_panel.jpg", outBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": [
+      {"type": "text", "text": "Make a 3 panel comic in a gritty, noir art style with high-contrast black and white inks. Put the character in a humurous scene."},
+      {"type": "image", "data": "<BASE64_IMAGE_DATA>", "mime_type": "image/jpeg"}
+    ]
+  }'
+
        +
        + + + + + + + + + +

        Input

        Output

        +
        + Man in white glasses +
        Input image
        +
        +         		+
        + Make a 3 panel comic in a gritty, noir art style... +
        Make a 3 panel comic in a gritty, noir art style...
        +
        +
        + + + +

        Use Google Search to generate images based on recent or real-time information. +This is useful for news, weather, and other time-sensitive topics.

        +
        +

        Prompt

        Make a simple but stylish graphic of last night's Arsenal game in the Champion's League
+
        +

        Python

        from google import genai
+from google.genai import types
+import base64
+
+client = genai.Client()
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="Make a simple but stylish graphic of last night's Arsenal game in the Champion's League",
+    tools=[{"type": "google_search"}],
+    response_format={"type": "image", "aspect_ratio": "16:9"},
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("football-score.jpg", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: "Make a simple but stylish graphic of last night's Arsenal game in the Champion's League",
+    tools: [{ type: "google_search" }],
+    response_format: { type: "image", aspect_ratio: "16:9", image_size: "2K" },
+  });
+
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("football-score.jpg", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.CreateModelInteractionResponseFormat;
+import com.google.genai.gaos.models.interactions.GoogleSearch;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatAspectRatio;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.ResponseFormat;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+
+Client client = new Client();
+
+CreateModelInteractionResponseFormat format =
+    CreateModelInteractionResponseFormat.of(
+        ResponseFormat.of(
+            ImageResponseFormat.builder()
+                .aspectRatio(ImageResponseFormatAspectRatio.of("16:9"))
+                .build()));
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "Make a simple but stylish graphic of last night's Arsenal game in the Champion's League"))
+        .tools(Arrays.asList(new GoogleSearch()))
+        .responseFormat(format)
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] imgBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("football-score.jpg"), imgBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    format := interactions.NewCreateModelInteractionResponseFormat(
+        interactions.NewResponseFormat(interactions.ImageResponseFormat{
+            AspectRatio: interactions.ImageResponseFormatAspectRatio("16:9").ToPointer(),
+        }),
+    )
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput("Make a simple but stylish graphic of last night's Arsenal game in the Champion's League"),
+            Tools: []interactions.Tool{
+                interactions.NewTool(interactions.GoogleSearch{}),
+            },
+            ResponseFormat: genai.Ptr(format),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    imgBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("football-score.jpg", imgBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "Make a simple but stylish graphic of last nights Arsenal game in the Champions League",
+    "tools": [{"type": "google_search"}],
+    "response_format": {
+      "type": "image",
+      "aspect_ratio": "16:9"
+    }
+  }'
+
        +
        +
        + AI-generated graphic of an Arsenal football score +
        AI-generated graphic of an Arsenal football score
        +
        + +

        Prompts for editing images

        + +

        These examples show how to provide images alongside your text prompts for +editing, composition, and style transfer.

        + +

        1. Adding and removing elements

        + +

        Provide an image and describe your change. The model will match the original +image's style, lighting, and perspective.

        +
        +

        Template

        Using the provided image of [subject], please [add/remove/modify] [element]
+to/from the scene. Ensure the change is [description of how the change should
+integrate].
+
        +

        Prompt

        "Using the provided image of my cat, please add a small, knitted wizard hat
+on its head. Make it look like it's sitting comfortably and matches the soft
+lighting of the photo."
+
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+
+client = genai.Client()
+
+with open('/path/to/your/cat_photo.png', 'rb') as f:
+    image_bytes = f.read()
+text_input = """Using the provided image of my cat, please add a small, knitted wizard hat on its head. Make it look like it's sitting comfortably and not falling off."""
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=[
+        {"type": "text", "text": text_input},
+        {
+            "type": "image",
+            "data": base64.b64encode(image_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        }
+    ],
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("cat_with_hat.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const imagePath = "/path/to/your/cat_photo.png";
+  const imageData = fs.readFileSync(imagePath);
+  const base64Image = imageData.toString("base64");
+
+  const input = [
+    { type: "text", text: "Using the provided image of my cat, please add a small, knitted wizard hat on its head. Make it look like it's sitting comfortably and not falling off." },
+    {
+      type: "image",
+      mime_type: "image/png",
+      data: base64Image
+    },
+  ];
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: input,
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("cat_with_hat.png", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageContentMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.List;
+
+Client client = new Client();
+
+byte[] imageBytes = Files.readAllBytes(Paths.get("/path/to/your/cat_photo.png"));
+String base64Image = Base64.getEncoder().encodeToString(imageBytes);
+String textInput =
+    "Using the provided image of my cat, please add a small, knitted wizard hat on its head. Make it look like it's sitting comfortably and not falling off.";
+
+Content textContent = TextContent.builder().text(textInput).build();
+Content imageContent =
+    ImageContent.builder()
+        .data(base64Image)
+        .mimeType(ImageContentMimeType.IMAGE_PNG)
+        .build();
+
+List<Content> contents = Arrays.asList(textContent, imageContent);
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.ofContent(contents))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] outBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("cat_with_hat.png"), outBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    imageBytes, err := os.ReadFile("/path/to/your/cat_photo.png")
+    if err != nil {
+        log.Fatal(err)
+    }
+    base64Image := base64.StdEncoding.EncodeToString(imageBytes)
+    textInput := "Using the provided image of my cat, please add a small, knitted wizard hat on its head. Make it look like it's sitting comfortably and not falling off."
+
+    contents := []interactions.Content{
+        interactions.NewContent(interactions.TextContent{
+            Text: textInput,
+        }),
+        interactions.NewContent(interactions.ImageContent{
+            Data:     genai.Ptr(base64Image),
+            MimeType: interactions.ImageContentMimeTypeImagePng.ToPointer(),
+        }),
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput(contents),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    outBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("cat_with_hat.png", outBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+    -H "x-goog-api-key: $GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -d "{
+      \"model\": \"gemini-nano-banana-2.1\",
+      \"input\": [
+            {\"type\": \"text\", \"text\": \"Using the provided image of my cat, please add a small, knitted wizard hat on its head. Make it look like it's sitting comfortably and not falling off.\"},
+            {\"type\": \"image\", \"mime_type\":\"image/png\", \"data\": \"<BASE64_IMAGE_DATA>\"}
+        ]
+    }"
+
        +
        + + + + + + + + + +

        Input

        Output

        +
        + A photorealistic picture of a fluffy ginger cat.. +
        A photorealistic picture of a fluffy ginger cat...
        +
        +         		+
        + Using the provided image of my cat, please add a small, knitted wizard hat... +
        Using the provided image of my cat, please add a small, knitted wizard hat...
        +
        +
        + +

        2. Inpainting (semantic masking)

        + +

        Conversationally define a "mask" to edit a specific part of an image while +leaving the rest untouched.

        +
        +

        Template

        Using the provided image, change only the [specific element] to [new
+element/description]. Keep everything else in the image exactly the same,
+preserving the original style, lighting, and composition.
+
        +

        Prompt

        "Using the provided image of a living room, change only the blue sofa to be
+a vintage, brown leather chesterfield sofa. Keep the rest of the room,
+including the pillows on the sofa and the lighting, unchanged."
+
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+
+client = genai.Client()
+
+with open('/path/to/your/living_room.png', 'rb') as f:
+    image_bytes = f.read()
+text_input = """Using the provided image of a living room, change only the blue sofa to be a vintage, brown leather chesterfield sofa. Keep the rest of the room, including the pillows on the sofa and the lighting, unchanged."""
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=[
+        {
+            "type": "image",
+            "data": base64.b64encode(image_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        },
+        {"type": "text", "text": text_input}
+    ],
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("living_room_edited.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const imagePath = "/path/to/your/living_room.png";
+  const imageData = fs.readFileSync(imagePath);
+  const base64Image = imageData.toString("base64");
+
+  const input = [
+    {
+      type: "image",
+      mime_type: "image/png",
+      data: base64Image
+    },
+    { type: "text", text: "Using the provided image of a living room, change only the blue sofa to be a vintage, brown leather chesterfield sofa. Keep the rest of the room, including the pillows on the sofa and the lighting, unchanged." },
+  ];
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: input,
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("living_room_edited.png", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageContentMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.List;
+
+Client client = new Client();
+
+byte[] imageBytes = Files.readAllBytes(Paths.get("/path/to/your/living_room.png"));
+String base64Image = Base64.getEncoder().encodeToString(imageBytes);
+String textInput =
+    "Using the provided image of a living room, change only the blue sofa to be a vintage, brown leather chesterfield sofa. Keep the rest of the room, including the pillows on the sofa and the lighting, unchanged.";
+
+Content imageContent =
+    ImageContent.builder()
+        .data(base64Image)
+        .mimeType(ImageContentMimeType.IMAGE_PNG)
+        .build();
+Content textContent = TextContent.builder().text(textInput).build();
+
+List<Content> contents = Arrays.asList(imageContent, textContent);
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.ofContent(contents))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] outBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("living_room_edited.png"), outBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    imageBytes, err := os.ReadFile("/path/to/your/living_room.png")
+    if err != nil {
+        log.Fatal(err)
+    }
+    base64Image := base64.StdEncoding.EncodeToString(imageBytes)
+    textInput := "Using the provided image of a living room, change only the blue sofa to be a vintage, brown leather chesterfield sofa. Keep the rest of the room, including the pillows on the sofa and the lighting, unchanged."
+
+    contents := []interactions.Content{
+        interactions.NewContent(interactions.ImageContent{
+            Data:     genai.Ptr(base64Image),
+            MimeType: interactions.ImageContentMimeTypeImagePng.ToPointer(),
+        }),
+        interactions.NewContent(interactions.TextContent{
+            Text: textInput,
+        }),
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput(contents),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    outBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("living_room_edited.png", outBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+    -H "x-goog-api-key: $GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -d "{
+      \"model\": \"gemini-nano-banana-2.1\",
+      \"input\": [
+        {\"type\": \"image\", \"mime_type\":\"image/png\", \"data\": \"<BASE64_IMAGE_DATA>\"},
+        {\"type\": \"text\", \"text\": \"Using the provided image of a living room, change only the blue sofa to be a vintage, brown leather chesterfield sofa. Keep the rest of the room, including the pillows on the sofa and the lighting, unchanged.\"}
+      ]
+    }"
+
        +
        + + + + + + + + + +

        Input

        Output

        +
        + A wide shot of a modern, well-lit living room... +
        A wide shot of a modern, well-lit living room...
        +
        +         		+
        + Using the provided image of a living room, change only the blue sofa to be a vintage, brown leather chesterfield sofa... +
        Using the provided image of a living room, change only the blue sofa to be a vintage, brown leather chesterfield sofa...
        +
        +
        + +

        3. Style transfer

        + +

        Provide an image and ask the model to recreate its content in a different +artistic style.

        +
        +

        Template

        Transform the provided photograph of [subject] into the artistic style of [artist/art style]. Preserve the original composition but render it with [description of stylistic elements].
+
        +

        Prompt

        "Transform the provided photograph of a modern city street at night into the artistic style of Vincent van Gogh's 'Starry Night'. Preserve the original composition of buildings and cars, but render all elements with swirling, impasto brushstrokes and a dramatic palette of deep blues and bright yellows."
+
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+
+client = genai.Client()
+
+with open('/path/to/your/city.png', 'rb') as f:
+    image_bytes = f.read()
+text_input = """Transform the provided photograph of a modern city street at night into the artistic style of Vincent van Gogh's 'Starry Night'. Preserve the original composition of buildings and cars, but render all elements with swirling, impasto brushstrokes and a dramatic palette of deep blues and bright yellows."""
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=[
+        {
+            "type": "image",
+            "data": base64.b64encode(image_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        },
+        {"type": "text", "text": text_input}
+    ],
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("city_style_transfer.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+  const imageData = fs.readFileSync("/path/to/your/city.png");
+  const base64Image = imageData.toString("base64");
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: [
+      {
+        type: "image",
+        mime_type: "image/png",
+        data: base64Image
+      },
+      { type: "text", text: "Transform the provided photograph of a modern city street at night into the artistic style of Vincent van Gogh's 'Starry Night'. Preserve the original composition of buildings and cars, but render all elements with swirling, impasto brushstrokes and a dramatic palette of deep blues and bright yellows." },
+    ],
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("city_style_transfer.png", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageContentMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.List;
+
+Client client = new Client();
+
+byte[] imageBytes = Files.readAllBytes(Paths.get("/path/to/your/city.png"));
+String base64Image = Base64.getEncoder().encodeToString(imageBytes);
+String textInput =
+    "Transform the provided photograph of a modern city street at night into the artistic style of Vincent van Gogh's 'Starry Night'. Preserve the original composition of buildings and cars, but render all elements with swirling, impasto brushstrokes and a dramatic palette of deep blues and bright yellows.";
+
+Content imageContent =
+    ImageContent.builder()
+        .data(base64Image)
+        .mimeType(ImageContentMimeType.IMAGE_PNG)
+        .build();
+Content textContent = TextContent.builder().text(textInput).build();
+
+List<Content> contents = Arrays.asList(imageContent, textContent);
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.ofContent(contents))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] outBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("city_style_transfer.png"), outBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    imageBytes, err := os.ReadFile("/path/to/your/city.png")
+    if err != nil {
+        log.Fatal(err)
+    }
+    base64Image := base64.StdEncoding.EncodeToString(imageBytes)
+    textInput := "Transform the provided photograph of a modern city street at night into the artistic style of Vincent van Gogh's 'Starry Night'. Preserve the original composition of buildings and cars, but render all elements with swirling, impasto brushstrokes and a dramatic palette of deep blues and bright yellows."
+
+    contents := []interactions.Content{
+        interactions.NewContent(interactions.ImageContent{
+            Data:     genai.Ptr(base64Image),
+            MimeType: interactions.ImageContentMimeTypeImagePng.ToPointer(),
+        }),
+        interactions.NewContent(interactions.TextContent{
+            Text: textInput,
+        }),
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput(contents),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    outBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("city_style_transfer.png", outBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+    -H "x-goog-api-key: $GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -d "{
+      \"model\": \"gemini-nano-banana-2.1\",
+      \"input\": [
+        {\"type\": \"image\", \"mime_type\":\"image/png\", \"data\": \"<BASE64_IMAGE_DATA>\"},
+        {\"type\": \"text\", \"text\": \"Transform the provided photograph of a modern city street at night into the artistic style of Vincent van Gogh's 'Starry Night'. Preserve the original composition of buildings and cars, but render all elements with swirling, impasto brushstrokes and a dramatic palette of deep blues and bright yellows.\"}
+      ]
+    }"
+
        +
        + + + + + + + + + +

        Input

        Output

        +
        + A photorealistic, high-resolution photograph of a busy city street... +
        A photorealistic, high-resolution photograph of a busy city street...
        +
        +         		+
        + Transform the provided photograph of a modern city street at night... +
        Transform the provided photograph of a modern city street at night...
        +
        +
        + +

        4. Advanced composition: combining multiple images

        + +

        Provide multiple images as context to create a new, composite scene. This is +perfect for product mockups or creative collages.

        +
        +

        Template

        Create a new image by combining the elements from the provided images. Take
+the [element from image 1] and place it with/on the [element from image 2].
+The final image should be a [description of the final scene].
+
        +

        Prompt

        "Create a professional e-commerce fashion photo. Take the blue floral dress
+from the first image and let the woman from the second image wear it.
+Generate a realistic, full-body shot of the woman wearing the dress, with
+the lighting and shadows adjusted to match the outdoor environment."
+
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+
+client = genai.Client()
+
+with open('/path/to/your/dress.png', 'rb') as f:
+    dress_bytes = f.read()
+with open('/path/to/your/model.png', 'rb') as f:
+    model_bytes = f.read()
+text_input = """Create a professional e-commerce fashion photo. Take the blue floral dress from the first image and let the woman from the second image wear it. Generate a realistic, full-body shot of the woman wearing the dress, with the lighting and shadows adjusted to match the outdoor environment."""
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=[
+        {
+            "type": "image",
+            "data": base64.b64encode(dress_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        },
+        {
+            "type": "image",
+            "data": base64.b64encode(model_bytes).decode('utf-8'),
+            "mime_type": "image/png"
+        },
+        {"type": "text", "text": text_input}
+    ],
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("fashion_ecommerce_shot.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const imagePath1 = "/path/to/your/dress.png";
+  const imageData1 = fs.readFileSync(imagePath1);
+  const base64Image1 = imageData1.toString("base64");
+  const imagePath2 = "/path/to/your/model.png";
+  const imageData2 = fs.readFileSync(imagePath2);
+  const base64Image2 = imageData2.toString("base64");
+
+  const input = [
+    {
+      type: "image",
+      mime_type: "image/png",
+      data: base64Image1
+    },
+    {
+      type: "image",
+      mime_type: "image/png",
+      data: base64Image2
+    },
+    { type: "text", text: "Create a professional e-commerce fashion photo. Take the blue floral dress from the first image and let the woman from the second image wear it. Generate a realistic, full-body shot of the woman wearing the dress, with the lighting and shadows adjusted to match the outdoor environment." },
+  ];
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: input,
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("fashion_ecommerce_shot.png", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageContentMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.List;
+
+Client client = new Client();
+
+byte[] dressBytes = Files.readAllBytes(Paths.get("/path/to/your/dress.png"));
+byte[] modelBytes = Files.readAllBytes(Paths.get("/path/to/your/model.png"));
+String textInput =
+    "Create a professional e-commerce fashion photo. Take the blue floral dress from the first image and let the woman from the second image wear it. Generate a realistic, full-body shot of the woman wearing the dress, with the lighting and shadows adjusted to match the outdoor environment.";
+
+Content dressContent =
+    ImageContent.builder()
+        .data(Base64.getEncoder().encodeToString(dressBytes))
+        .mimeType(ImageContentMimeType.IMAGE_PNG)
+        .build();
+Content modelContent =
+    ImageContent.builder()
+        .data(Base64.getEncoder().encodeToString(modelBytes))
+        .mimeType(ImageContentMimeType.IMAGE_PNG)
+        .build();
+Content textContent = TextContent.builder().text(textInput).build();
+
+List<Content> contents = Arrays.asList(dressContent, modelContent, textContent);
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.ofContent(contents))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] outBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("fashion_ecommerce_shot.png"), outBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    dressBytes, err := os.ReadFile("/path/to/your/dress.png")
+    if err != nil {
+        log.Fatal(err)
+    }
+    modelBytes, err := os.ReadFile("/path/to/your/model.png")
+    if err != nil {
+        log.Fatal(err)
+    }
+    textInput := "Create a professional e-commerce fashion photo. Take the blue floral dress from the first image and let the woman from the second image wear it. Generate a realistic, full-body shot of the woman wearing the dress, with the lighting and shadows adjusted to match the outdoor environment."
+
+    contents := []interactions.Content{
+        interactions.NewContent(interactions.ImageContent{
+            Data:     genai.Ptr(base64.StdEncoding.EncodeToString(dressBytes)),
+            MimeType: interactions.ImageContentMimeTypeImagePng.ToPointer(),
+        }),
+        interactions.NewContent(interactions.ImageContent{
+            Data:     genai.Ptr(base64.StdEncoding.EncodeToString(modelBytes)),
+            MimeType: interactions.ImageContentMimeTypeImagePng.ToPointer(),
+        }),
+        interactions.NewContent(interactions.TextContent{
+            Text: textInput,
+        }),
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput(contents),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    outBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("fashion_ecommerce_shot.png", outBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+    -H "x-goog-api-key: $GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -d "{
+      \"model\": \"gemini-nano-banana-2.1\",
+      \"input\": [
+            {\"type\": \"image\", \"mime_type\":\"image/png\", \"data\": \"<BASE64_IMAGE_DATA_1>\"},
+            {\"type\": \"image\", \"mime_type\":\"image/png\", \"data\": \"<BASE64_IMAGE_DATA_2>\"},
+            {\"type\": \"text\", \"text\": \"Create a professional e-commerce fashion photo. Take the blue floral dress from the first image and let the woman from the second image wear it. Generate a realistic, full-body shot of the woman wearing the dress, with the lighting and shadows adjusted to match the outdoor environment.\"}
+      }]
+    }"
+
        +
        + + + + + + + + + + + +

        Input 1

        Input 2

        Output

        +
        + A blue floral summer dress on a neutral background +
        A blue floral summer dress on a neutral background
        +
        +         		+
        + Full-body shot of a woman with her hair in a bun... +
        Full-body shot of a woman with her hair in a bun...
        +
        +         		+
        + A woman wearing a blue floral summer dress in an outdoor setting +
        A woman wearing a blue floral summer dress in an outdoor setting
        +
        +
        + +

        5. High-fidelity detail preservation

        + +

        To ensure critical details (like a face or logo) are preserved during an edit, +describe them in great detail along with your edit request.

        +
        +

        Template

        Using the provided images, place [element from image 2] onto [element from
+image 1]. Ensure that the features of [element from image 1] remain
+completely unchanged. The added element should [description of how the
+element should integrate].
+
        +

        Prompt

        "Take the first image of the woman with brown hair, blue eyes, and a neutral
+expression. Add the logo from the second image onto her black t-shirt.
+Ensure the woman's face and features remain completely unchanged. The logo
+should look like it's naturally printed on the fabric, following the folds
+of the shirt."
+
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+
+client = genai.Client()
+
+with open('/path/to/your/woman.png', 'rb') as f:
+    woman_bytes = f.read()
+with open('/path/to/your/logo.png', 'rb') as f:
+    logo_bytes = f.read()
+text_input = """Take the first image of the woman with brown hair, blue eyes, and a neutral expression. Add the logo from the second image onto her black t-shirt. Ensure the woman's face and features remain completely unchanged. The logo should look like it's naturally printed on the fabric, following the folds of the shirt."""
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=[
+      {"type": "image", "mime_type":"image/png", "data": base64.b64encode(woman_bytes).decode('utf-8')},
+      {"type": "image", "mime_type":"image/png", "data": base64.b64encode(logo_bytes).decode('utf-8')},
+      {"type": "text", "text": text_input}
+    ],
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("woman_with_logo.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const imagePath1 = "/path/to/your/woman.png";
+  const imageData1 = fs.readFileSync(imagePath1);
+  const base64Image1 = imageData1.toString("base64");
+  const imagePath2 = "/path/to/your/logo.png";
+  const imageData2 = fs.readFileSync(imagePath2);
+  const base64Image2 = imageData2.toString("base64");
+
+  const input = [
+    {"type": "image", "mime_type":"image/png", "data": base64Image1},
+    {"type": "image", "mime_type":"image/png", "data": base64Image2},
+    {"type": "text", "text": "Take the first image of the woman with brown hair, blue eyes, and a neutral expression. Add the logo from the second image onto her black t-shirt. Ensure the woman's face and features remain completely unchanged. The logo should look like it's naturally printed on the fabric, following the folds of the shirt."},
+  ];
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: input,
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("woman_with_logo.png", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageContentMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.List;
+
+Client client = new Client();
+
+byte[] womanBytes = Files.readAllBytes(Paths.get("/path/to/your/woman.png"));
+byte[] logoBytes = Files.readAllBytes(Paths.get("/path/to/your/logo.png"));
+String textInput =
+    "Take the first image of the woman with brown hair, blue eyes, and a neutral expression. Add the logo from the second image onto her black t-shirt. Ensure the woman's face and features remain completely unchanged. The logo should look like it's naturally printed on the fabric, following the folds of the shirt.";
+
+Content womanContent =
+    ImageContent.builder()
+        .data(Base64.getEncoder().encodeToString(womanBytes))
+        .mimeType(ImageContentMimeType.IMAGE_PNG)
+        .build();
+Content logoContent =
+    ImageContent.builder()
+        .data(Base64.getEncoder().encodeToString(logoBytes))
+        .mimeType(ImageContentMimeType.IMAGE_PNG)
+        .build();
+Content textContent = TextContent.builder().text(textInput).build();
+
+List<Content> contents = Arrays.asList(womanContent, logoContent, textContent);
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.ofContent(contents))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] outBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("woman_with_logo.png"), outBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    womanBytes, err := os.ReadFile("/path/to/your/woman.png")
+    if err != nil {
+        log.Fatal(err)
+    }
+    logoBytes, err := os.ReadFile("/path/to/your/logo.png")
+    if err != nil {
+        log.Fatal(err)
+    }
+    textInput := "Take the first image of the woman with brown hair, blue eyes, and a neutral expression. Add the logo from the second image onto her black t-shirt. Ensure the woman's face and features remain completely unchanged. The logo should look like it's naturally printed on the fabric, following the folds of the shirt."
+
+    contents := []interactions.Content{
+        interactions.NewContent(interactions.ImageContent{
+            Data:     genai.Ptr(base64.StdEncoding.EncodeToString(womanBytes)),
+            MimeType: interactions.ImageContentMimeTypeImagePng.ToPointer(),
+        }),
+        interactions.NewContent(interactions.ImageContent{
+            Data:     genai.Ptr(base64.StdEncoding.EncodeToString(logoBytes)),
+            MimeType: interactions.ImageContentMimeTypeImagePng.ToPointer(),
+        }),
+        interactions.NewContent(interactions.TextContent{
+            Text: textInput,
+        }),
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput(contents),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    outBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("woman_with_logo.png", outBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+    -H "x-goog-api-key: $GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -d "{
+      \"model\": \"gemini-nano-banana-2.1\",
+      \"input\": [
+        {\"type\": \"image\", \"mime_type\":\"image/png\", \"data\": \"<BASE64_IMAGE_DATA_1>\"},
+        {\"type\": \"image\", \"mime_type\":\"image/png\", \"data\": \"<BASE64_IMAGE_DATA_2>\"},
+        {\"type\": \"text\", \"text\": \"Take the first image of the woman with brown hair, blue eyes, and a neutral expression. Add the logo from the second image onto her black t-shirt. Ensure the woman's face and features remain completely unchanged. The logo should look like it's naturally printed on the fabric, following the folds of the shirt.\"}
+      ]
+    }"
+
        +
        + + + + + + + + + + + +

        Input 1

        Input 2

        Output

        +
        + A professional headshot of a woman with brown hair and blue eyes... +
        A professional headshot of a woman with brown hair and blue eyes...
        +
        +         		+
        + Modern brand identifier with letters G and A +
        Modern brand identifier with letters G and A
        +
        +         		+
        + Take the first image of the woman with brown hair, blue eyes, and a neutral expression... +
        Take the first image of the woman with brown hair, blue eyes, and a neutral expression...
        +
        +
        + +

        6. Bring something to life

        + +

        Upload a rough sketch or drawing and ask the model to refine it into a +finished image.

        +
        +

        Template

        Turn this rough [medium] sketch of a [subject] into a [style description]
+photo. Keep the [specific features] from the sketch but add [new details/materials].
+
        +

        Prompt

        "Turn this rough pencil sketch of a futuristic car into a polished photo of the finished concept car in a showroom. Keep the sleek lines and low profile from the sketch but add metallic blue paint and neon rim lighting."
+
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+
+client = genai.Client()
+
+with open('/path/to/your/car_sketch.png', 'rb') as f:
+    sketch_bytes = f.read()
+text_input = """Turn this rough pencil sketch of a futuristic car into a polished photo of the finished concept car in a showroom. Keep the sleek lines and low profile from the sketch but add metallic blue paint and neon rim lighting."""
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=[
+      {"type": "image", "mime_type":"image/png", "data": base64.b64encode(sketch_bytes).decode('utf-8')},
+      {"type": "text", "text": text_input}
+    ],
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("car_photo.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +

        JavaScript

        import { GoogleGenAI } from "@google/genai";
+import * as fs from "node:fs";
+
+async function main() {
+  const ai = new GoogleGenAI({});
+
+  const imagePath = "/path/to/your/car_sketch.png";
+  const imageData = fs.readFileSync(imagePath);
+  const base64Image = imageData.toString("base64");
+
+  const input = [
+    {"type": "image", "mime_type":"image/png", "data": base64Image},
+    {"type": "text", "text": "Turn this rough pencil sketch of a futuristic car into a polished photo of the finished concept car in a showroom. Keep the sleek lines and low profile from the sketch but add metallic blue paint and neon rim lighting."},
+  ];
+
+  const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: input,
+  });
+  for (const step of interaction.steps) {
+    if (step.type === "model_output") {
+      for (const contentBlock of step.content) {
+        if (contentBlock.type === "text") {
+          console.log(contentBlock.text);
+        } else if (contentBlock.type === "image") {
+          const buffer = Buffer.from(contentBlock.data, "base64");
+          fs.writeFileSync("car_photo.png", buffer);
+        }
+      }
+    }
+  }
+}
+
+main();
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.Content;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.ImageContent;
+import com.google.genai.gaos.models.interactions.ImageContentMimeType;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ModelOutputStep;
+import com.google.genai.gaos.models.interactions.Step;
+import com.google.genai.gaos.models.interactions.TextContent;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Base64;
+import java.util.List;
+
+Client client = new Client();
+
+byte[] sketchBytes = Files.readAllBytes(Paths.get("/path/to/your/car_sketch.png"));
+String textInput =
+    "Turn this rough pencil sketch of a futuristic car into a polished photo of the finished concept car in a showroom. Keep the sleek lines and low profile from the sketch but add metallic blue paint and neon rim lighting.";
+
+Content sketchContent =
+    ImageContent.builder()
+        .data(Base64.getEncoder().encodeToString(sketchBytes))
+        .mimeType(ImageContentMimeType.IMAGE_PNG)
+        .build();
+Content textContent = TextContent.builder().text(textInput).build();
+
+List<Content> contents = Arrays.asList(sketchContent, textContent);
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.ofContent(contents))
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
+if (interaction.steps().isPresent()) {
+  for (Step step : interaction.steps().get()) {
+    if (step instanceof ModelOutputStep) {
+      ModelOutputStep outputStep = (ModelOutputStep) step;
+      if (outputStep.content().isPresent()) {
+        for (Content contentBlock : outputStep.content().get()) {
+          if (contentBlock instanceof TextContent) {
+            System.out.println(((TextContent) contentBlock).text().orElse(""));
+          } else if (contentBlock instanceof ImageContent) {
+            ImageContent img = (ImageContent) contentBlock;
+            if (img.data().isPresent()) {
+              byte[] outBytes = Base64.getDecoder().decode(img.data().get());
+              Files.write(Paths.get("car_photo.png"), outBytes);
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
        +

        Go

        package main
+
+import (
+    "context"
+    "encoding/base64"
+    "fmt"
+    "log"
+    "os"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    sketchBytes, err := os.ReadFile("/path/to/your/car_sketch.png")
+    if err != nil {
+        log.Fatal(err)
+    }
+    textInput := "Turn this rough pencil sketch of a futuristic car into a polished photo of the finished concept car in a showroom. Keep the sleek lines and low profile from the sketch but add metallic blue paint and neon rim lighting."
+
+    contents := []interactions.Content{
+        interactions.NewContent(interactions.ImageContent{
+            Data:     genai.Ptr(base64.StdEncoding.EncodeToString(sketchBytes)),
+            MimeType: interactions.ImageContentMimeTypeImagePng.ToPointer(),
+        }),
+        interactions.NewContent(interactions.TextContent{
+            Text: textInput,
+        }),
+    }
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model: interactions.Model("gemini-nano-banana-2.1"),
+            Input: interactions.NewInteractionsInput(contents),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    for _, step := range res.Interaction.Steps {
+        if step.ModelOutputStep != nil {
+            for _, contentBlock := range step.ModelOutputStep.Content {
+                if contentBlock.TextContent != nil {
+                    fmt.Println(contentBlock.TextContent.Text)
+                } else if contentBlock.ImageContent != nil && contentBlock.ImageContent.Data != nil {
+                    outBytes, err := base64.StdEncoding.DecodeString(*contentBlock.ImageContent.Data)
+                    if err != nil {
+                        log.Fatal(err)
+                    }
+                    if err := os.WriteFile("car_photo.png", outBytes, 0644); err != nil {
+                        log.Fatal(err)
+                    }
+                }
+            }
+        }
+    }
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+    -H "x-goog-api-key: $GEMINI_API_KEY" \
+    -H 'Content-Type: application/json' \
+    -d "{
+      \"model\": \"gemini-nano-banana-2.1\",
+      \"input\": [
+        {\"type\": \"image\", \"mime_type\":\"image/png\", \"data\": \"<BASE64_IMAGE_DATA>\"},
+        {\"type\": \"text\", \"text\": \"Turn this rough pencil sketch of a futuristic car into a polished photo of the finished concept car in a showroom. Keep the sleek lines and low profile from the sketch but add metallic blue paint and neon rim lighting.\"}
+      ]
+    }"
+
        +
        + + + + + + + + + +

        Input

        Output

        +
        + Sketch of a car +
        Rough sketch of a car
        +
        +         		+
        + Output showing the final concept car +
        Polished photo of a car
        +
        +
        + +

        7. Character consistency: 360 view

        + +

        You can generate 360-degree views of a character by iteratively prompting for +different angles. For best results, include previously generated images in +subsequent prompts to maintain consistency. For complex poses, include a +reference image of the selected pose.

        +
        +

        Template

        A studio portrait of [person] against [background], [looking forward/in profile looking right/etc.]
+
        +

        Prompt

        A studio portrait of this man against white, in profile looking right
+
        +

        Python

        from google import genai
+from PIL import Image
+import base64
+
+client = genai.Client()
+
+with open('/path/to/your/man_in_white_glasses.jpg', 'rb') as f:
+    image_bytes = f.read()
+text_input = """A studio portrait of this man against white, in profile looking right"""
+
+interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input={
+      {"type": "text", "text": text_input},
+      {"type": "image", "mime_type":"image/png", "data": base64.b64encode(image_bytes).decode('utf-8')}
+    },
+)
+
+for step in interaction.steps:
+    if step.type == "model_output":
+        for content_block in step.content:
+            if content_block.type == "text":
+                print(content_block.text)
+            elif content_block.type == "image":
+                with open("man_right_profile.png", "wb") as f:
+                    f.write(base64.b64decode(content_block.data))
+
        +
        + + + + + + + + + + + +

        Input

        Output 1

        Output 2

        +
        + Original input of a man in white glasses +
        Original image
        +
        +         		+
        + Output of a man in white glasses looking right +
        Man in white glasses looking right
        +
        +         		+
        + Output of a man in white glasses looking forward +
        Man in white glasses looking forward
        +
        +
        + +

        Best practices

        + +

        To elevate your results from good to great, incorporate these professional +strategies into your workflow.

        + +
          +
        • Be hyper-specific: The more detail you provide, the more control you +have. Instead of "fantasy armor," describe it: "ornate elven plate armor, etched +with silver leaf patterns, with a high collar and pauldrons shaped like falcon +wings."
          • +
        • Provide context and intent: Explain the purpose of the image. The +model's understanding of context will influence the final output. For example, +"Create a logo for a high-end, minimalist skincare brand" will yield better +results than just "Create a logo."
          • +
        • Iterate and refine: Don't expect a perfect image on the first try. Use +the conversational nature of the model to make small changes. Follow up with +prompts like, "That's great, but can you make the lighting a bit warmer?" or +"Keep everything the same, but change the character's expression to be more +serious."
          • +
        • Use step-by-step instructions: For complex scenes with many elements, +break your prompt into steps. "First, create a background of a serene, misty +forest at dawn. Then, in the foreground, add a moss-covered ancient stone altar. +Finally, place a single, glowing sword on top of the altar."
          • +
        • Use "semantic negative prompts": Instead of saying "no cars," describe +the intended scene positively: "an empty, deserted street with no signs of +traffic."
          • +
        • Control the camera: Use photographic and cinematic language to control +the composition. Terms like wide-angle shot, macro shot, low-angle +perspective.
          • +
        + +

        Limitations

        + +
          +
        • For best performance, use the following languages: EN, ar-EG, de-DE, es-MX, +fr-FR, hi-IN, id-ID, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, ua-UA, vi-VN, zh-CN.
          • +
        • Image generation does not support audio inputs. Video inputs are only +supported for Gemini Nano Banana 2.1, Gemini 3.1 Flash Image, and +Gemini 3.1 Flash Lite Image.
          • +
        • The model won't always follow the exact number of image outputs that the +user explicitly asks for.
          • +
        • gemini-2.5-flash-image works best with up to 3 images as input, while +gemini-3-pro-image supports 5 images with high fidelity, and up to +14 images in total. gemini-nano-banana-2.1 and gemini-3.1-flash-image +support character resemblance of up to 4 characters and the fidelity of up +to 10 objects in a single workflow.
          • +
        • When generating text for an image, Gemini works best if you first generate +the text and then ask for an image with the text.
          • +
        • gemini-nano-banana-2.1 and gemini-3.1-flash-image Grounding with Google +Search do not support using real-world images of people from web search at +this time.
          • +
        • All generated images include a SynthID watermark.
          • +
        + +

        Optional configurations

        + +

        You can optionally configure the output format, aspect ratio, and image size using the response_format parameter.

        + +

        Output format

        + +

        The model defaults to returning both text and image responses. You can configure the response to return only the generated images (omitting the conversational text) by specifying an image format in the response_format parameter.

        + +

        To request multiple modalities (for example, both text and the generated image), pass an array of format entries to response_format instead.

        +
        +

        Python

        interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input="Write a short poem about a starry night and generate an image of it.",
+    response_format=[
+        {"type": "text"},
+        {"type": "image"},
+    ],
+)
+
        +

        JavaScript

        const interaction = await ai.interactions.create({
+  model: "gemini-nano-banana-2.1",
+  input: "Write a short poem about a starry night and generate an image of it.",
+  response_format: [
+    { type: "text" },
+    { type: "image" },
+  ],
+});
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.CreateModelInteractionResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormat;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ResponseFormat;
+import com.google.genai.gaos.models.interactions.TextResponseFormat;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+import java.util.Arrays;
+
+Client client = new Client();
+
+CreateModelInteractionResponseFormat format =
+    CreateModelInteractionResponseFormat.of(
+        Arrays.asList(
+            ResponseFormat.of(TextResponseFormat.builder().build()),
+            ResponseFormat.of(ImageResponseFormat.builder().build())));
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(
+            InteractionsInput.of(
+                "Write a short poem about a starry night and generate an image of it."))
+        .responseFormat(format)
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
        +

        Go

        package main
+
+import (
+    "context"
+    "log"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    format := interactions.NewCreateModelInteractionResponseFormat([]interactions.ResponseFormat{
+        interactions.NewResponseFormat(interactions.TextResponseFormat{}),
+        interactions.NewResponseFormat(interactions.ImageResponseFormat{}),
+    })
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model:          interactions.Model("gemini-nano-banana-2.1"),
+            Input:          interactions.NewInteractionsInput("Write a short poem about a starry night and generate an image of it."),
+            ResponseFormat: genai.Ptr(format),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+    _ = res
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "Write a short poem about a starry night and generate an image of it.",
+    "response_format": [
+      { "type": "text" },
+      { "type": "image" }
+    ]
+  }'
+
        +
        +

        Aspect ratios and image size

        + +

        By default, the model matches the output image size to that of your input image, or otherwise generates 1:1 squares. You can control the aspect ratio and the size of the output image using the aspect_ratio and image_size fields under response_format when type is set to "image".

        +
        +

        Python

        interaction = client.interactions.create(
+    model="gemini-nano-banana-2.1",
+    input=prompt,
+    response_format={
+        "type": "image",
+        "aspect_ratio": "16:9",
+        "image_size": "2K",
+    },
+)
+
        +

        JavaScript

        const interaction = await ai.interactions.create({
+    model: "gemini-nano-banana-2.1",
+    input: prompt,
+    response_format: {
+      type: "image",
+      aspect_ratio: "16:9",
+      image_size: "2K",
+    },
+  });
+
        +

        Java

        import com.google.genai.Client;
+import com.google.genai.gaos.models.interactions.CreateModelInteraction;
+import com.google.genai.gaos.models.interactions.CreateModelInteractionResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormat;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatAspectRatio;
+import com.google.genai.gaos.models.interactions.ImageResponseFormatImageSize;
+import com.google.genai.gaos.models.interactions.Interaction;
+import com.google.genai.gaos.models.interactions.InteractionsInput;
+import com.google.genai.gaos.models.interactions.Model;
+import com.google.genai.gaos.models.interactions.ResponseFormat;
+import com.google.genai.gaos.models.operations.CreateInteractionRequestBody;
+
+Client client = new Client();
+String prompt = "Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme";
+
+CreateModelInteractionResponseFormat format =
+    CreateModelInteractionResponseFormat.of(
+        ResponseFormat.of(
+            ImageResponseFormat.builder()
+                .aspectRatio(ImageResponseFormatAspectRatio.of("16:9"))
+                .imageSize(ImageResponseFormatImageSize.TWO_K)
+                .build()));
+
+CreateModelInteraction params =
+    CreateModelInteraction.builder()
+        .model(Model.of("gemini-nano-banana-2.1"))
+        .input(InteractionsInput.of(prompt))
+        .responseFormat(format)
+        .build();
+
+Interaction interaction =
+    client.interactions.create(CreateInteractionRequestBody.of(params)).interaction().get();
+
        +

        Go

        package main
+
+import (
+    "context"
+    "log"
+
+    "google.golang.org/genai"
+    "google.golang.org/genai/interactions/models/interactions"
+    "google.golang.org/genai/interactions/models/operations"
+)
+
+func main() {
+    ctx := context.Background()
+    client, err := genai.NewClient(ctx, nil)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    prompt := "Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme"
+
+    format := interactions.NewCreateModelInteractionResponseFormat(
+        interactions.NewResponseFormat(interactions.ImageResponseFormat{
+            AspectRatio: interactions.ImageResponseFormatAspectRatio("16:9").ToPointer(),
+            ImageSize:   interactions.ImageResponseFormatImageSizeTwoK.ToPointer(),
+        }),
+    )
+
+    res, err := client.Interactions.Create(ctx, operations.CreateInteractionRequest{
+        Body: operations.NewCreateInteractionRequestBody(interactions.CreateModelInteraction{
+            Model:          interactions.Model("gemini-nano-banana-2.1"),
+            Input:          interactions.NewInteractionsInput(prompt),
+            ResponseFormat: genai.Ptr(format),
+        }),
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+    _ = res
+}
+
        +

        REST

        curl -s -X POST \
+  "https://generativelanguage.googleapis.com/v1beta/interactions" \
+  -H "x-goog-api-key: $GEMINI_API_KEY" \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "model": "gemini-nano-banana-2.1",
+    "input": "Create a picture of a nano banana dish in a fancy restaurant with a Gemini theme",
+    "response_format": {
+      "type": "image",
+      "aspect_ratio": "16:9",
+      "image_size": "2K"
+    }
+  }'
+
        +
        +

        The different ratios available and the size of the image generated are listed in +the following tables:

        +
        +

        Nano Banana 2.1

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Aspect ratio1K resolution1K tokens2K resolution2K tokens4K resolution4K tokens
        1:11024x102411202048x204816804096x40962520
        1:4512x204811201024x409616802048x81922520
        1:8384x30721120768x614416801536x122882520
        2:3848x126411201696x252816803392x50562520
        3:21264x84811202528x169616805056x33922520
        3:4896x120011201792x240016803584x48002520
        4:12048x51211204096x102416808192x20482520
        4:31200x89611202400x179216804800x35842520
        4:5928x115211201856x230416803712x46082520
        5:41152x92811202304x185616804608x37122520
        8:13072x38411206144x768168012288x15362520
        9:16768x137611201536x275216803072x55042520
        16:91376x76811202752x153616805504x30722520
        21:91584x67211203168x134416806336x26882520
        +

        3.1 Flash Image

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Aspect ratio512px resolution0.5K tokens1K resolution1K tokens2K resolution2K tokens4K resolution4K tokens
        1:1512x5127471024x102411202048x204816804096x40962520
        1:4256x1024747512x204811201024x409616802048x81922520
        1:8192x1536747384x30721120768x614416801536x122882520
        2:3424x632747848x126411201696x252816803392x50562520
        3:2632x4247471264x84811202528x169616805056x33922520
        3:4448x600747896x120011201792x240016803584x48002520
        4:11024x2567472048x51211204096x102416808192x20482520
        4:3600x4487471200x89611202400x179216804800x35842520
        4:5464x576747928x115211201856x230416803712x46082520
        5:4576x4647471152x92811202304x185616804608x37122520
        8:11536x1927473072x38411206144x768168012288x15362520
        9:16384x688747768x137611201536x275216803072x55042520
        16:9688x3847471376x76811202752x153616805504x30722520
        21:9792x1687471584x67211203168x134416806336x26882520
        +

        3.1 Pro Image

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Aspect ratio1K resolution1K tokens2K resolution2K tokens4K resolution4K tokens
        1:11024x102411202048x204811204096x40962000
        2:3848x126411201696x252811203392x50562000
        3:21264x84811202528x169611205056x33922000
        3:4896x120011201792x240011203584x48002000
        4:31200x89611202400x179211204800x35842000
        4:5928x115211201856x230411203712x46082000
        5:41152x92811202304x185611204608x37122000
        9:16768x137611201536x275211203072x55042000
        16:91376x76811202752x153611205504x30722000
        21:91584x67211203168x134411206336x26882000
        +

        Gemini 2.5 Flash Image

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Aspect ratioResolutionTokens
        1:11024x10241290
        2:3832x12481290
        3:21248x8321290
        3:4864x11841290
        4:31184x8641290
        4:5896x11521290
        5:41152x8961290
        9:16768x13441290
        16:91344x7681290
        21:91536x6721290
        +
        +

        When to use Imagen

        + + + +

        Imagen is shut down and no longer available through the Gemini API. +Use Nano Banana for image generation and editing.

        + +

        What's next

        + +
          +
        • Check out the Veo guide to learn how to generate +videos with the Gemini API.
          • +
        • To learn more about Gemini models, see Gemini models.
          • +
        + + + + +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + +
        + + + + + + + + +
        + +         +
        + + + + + + + + + + + + + + + + + + + + + + +
        +
        + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/pipeline/provider_docs/ideogram__api.ideogram.ai_openapi.json b/pipeline/provider_docs/ideogram__api.ideogram.ai_openapi.json new file mode 100644 index 0000000000000000000000000000000000000000..9e235949d02067ee82abb0440f725587b04a35d4 --- /dev/null +++ b/pipeline/provider_docs/ideogram__api.ideogram.ai_openapi.json @@ -0,0 +1 @@ +{"openapi":"3.1.0","info":{"title":"Ideogram API v2","version":"1.0.0"},"paths":{"/v2/image/precise-edit/ideogram-4-5":{"post":{"operationId":"imagesPreciseEdit_post_precise_edit_image_v2_ideogram45","summary":"Precise edit with Ideogram 4.5","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\nEditing the whole image is bounded by 4194304 pixels (the area of a\n2048x2048 square), so a larger image comes back scaled down to fit: an\n8192x8192 image returns as 2048x2048.\n\nTo edit a 4K or 8K image at its full resolution, set `context_window`\nto confine the edit to one region, either `auto` together with a\n`mask`, or `y_min,x_min,y_max,x_max` to name the region yourself. Only\nthat region changes, the rest of the image comes back unchanged, and\nthe result keeps the image's own width and height at any input size.\n\n```bash\ncurl -X POST https://api.ideogram.ai/v2/image/precise-edit/ideogram-4-5 \\\n -H \"Api-Key: $IDEOGRAM_API_KEY\" \\\n -F image=@photo_8k.png \\\n -F mask=@mask_8k.png \\\n -F context_window=auto \\\n -F prompt=\"Add round black sunglasses.\"\n```\n","tags":["images-precise-edit"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The edited images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreciseEditImageIdeogram45Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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"},"image":{"type":"string","format":"binary","description":"The image to edit, as raw bytes (max 50MB and 67108864 pixels, which 8192x8192 meets exactly; JPEG, PNG, or WEBP). Multipart requests only, and ignored when the same image is also supplied by reference. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it. Set `context_window` to keep the full resolution of an image over 4194304 pixels."},"reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Optional images to guide the edit (max 4, max 50MB each; JPEG, PNG, or WEBP). They are never edited themselves; only `image` is. Multipart requests only, and ignored when the same references are also supplied by reference. A request with a `mask` can include at most three, because the mask takes up one reference slot."},"mask":{"type":"string","format":"binary","description":"An optional mask that limits the edit to part of `image` (max 50MB; 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 image being edited and contain both black and white areas. A masked request can include at most three reference images."},"context_window":{"type":"string","pattern":"^(none|auto|[0-9]+,[0-9]+,[0-9]+,[0-9]+)$","default":"none","description":"Which region of the image to edit. Set this to keep the full resolution of an image larger than 4194304 pixels.\n`none`, the default, edits the whole image, which is bounded by 4194304 pixels (the area of a 2048x2048 square); a larger image comes back scaled down to fit. For example, an 8192x8192 image returns as 2048x2048.\n`auto` requires a `mask` and fits a region around the masked area. If the mask selects more than 4194304 pixels no region fits it, and the request falls back to editing the whole image, scaled down as above.\n`y_min,x_min,y_max,x_max` names the region explicitly, by its corners. Rows come first, matching the `bbox` ordering used elsewhere in this API, and the values are the edited image's own pixels with the origin at its top-left corner. For example `512,1024,2048,3072` is the region 2048 pixels wide and 1536 tall whose top-left corner is 1024 across and 512 down. The maximum edges are exclusive, so the region measures `x_max - x_min` by `y_max - y_min`. It must lie inside the image, measure at least 256px on each side, have an aspect ratio between 1:6 and 6:1, and cover no more than 4194304 pixels. A `mask` may select only pixels inside it.\nWith `auto` or an explicit region, only that region changes, the rest of the image comes back unchanged, and the output keeps the image's own width and height at any input size."},"quality":{"$ref":"#/components/schemas/V2ImagePreciseEditIdeogram45PostRequestBodyContentMultipartFormDataSchemaQuality","default":"medium","description":"The rendering quality to use. `very_low` is the fastest and cheapest, and `high` takes longer and is priced higher. This is the only field that affects the price: the size of the image you send does not change it, and neither does `context_window`."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/auto":{"post":{"operationId":"autoModel_post_generate_image_v2_auto","summary":"Generate with automatic model selection","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","tags":["auto-model"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageV2AutoResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks, or the request combined source images with text-to-image-only fields.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt to generate images from or, when source images are supplied, the change to make to them."},"images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only."},"negative_prompt":{"type":"string","maxLength":10000,"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."},"aspect_ratio":{"type":"string","pattern":"^(auto|[1-9][0-9]{0,4}x[1-9][0-9]{0,4})$","default":"auto","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."},"resolution":{"type":"string","pattern":"^[1-9][0-9]{1,4}x[1-9][0-9]{1,4}$","description":"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."},"resolution_tier":{"$ref":"#/components/schemas/V2ImageGenerateAutoPostRequestBodyContentMultipartFormDataSchemaResolutionTier","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."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"private":{"type":"boolean","description":"Whether the generated images should be kept private. When omitted, the default follows the caller's plan; some plans always generate privately."},"async":{"type":"boolean","default":false,"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."}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/ideogram-4-5":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_ideogram45","summary":"Generate with Ideogram 4.5","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogram45Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with Ideogram 4.5. Send it as `application/json`, or as `multipart/form-data` to include source `images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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"},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","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 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"},"images":{"type":"array","items":{"type":"string","format":"binary"},"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."},"mask":{"type":"string","format":"binary","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."},"size":{"type":["string","null"],"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 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"},"background":{"$ref":"#/components/schemas/V2ImageGenerateIdeogram45PostRequestBodyContentMultipartFormDataSchemaBackground","default":"auto","description":"The output background. `transparent` returns images with an alpha channel, `opaque` returns a solid one, and `auto` decides for you."},"quality":{"$ref":"#/components/schemas/V2ImageGenerateIdeogram45PostRequestBodyContentMultipartFormDataSchemaQuality","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."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/ideogram-4":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_ideogram_v4","summary":"Generate with Ideogram 4.0","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV4Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with Ideogram 4.0.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV4Request"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/ideogram-4-custom-model":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_ideogram_v4_custom_model","summary":"Generate with a custom Ideogram 4.0 model","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV4CustomModelResponse"}}}},"400":{"description":"Invalid input or an unsupported model option.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"The custom model does not exist or is not accessible to this user or organization.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with an accessible custom Ideogram 4.0 model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV4CustomModelRequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/ideogram-4-transparent":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_ideogram_v4_transparent","summary":"Generate transparent images with Ideogram 4.0","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV4TransparentResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate transparent-background images with Ideogram 4.0.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV4TransparentRequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/ideogram-3":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_ideogram_v3","summary":"Generate with Ideogram 3.0","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}`.","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt to generate images from."},"negative_prompt":{"type":"string","maxLength":10000,"description":"Description of what to exclude from the images. The prompt takes precedence over the negative prompt."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"resolution":{"$ref":"#/components/schemas/ResolutionV3"},"aspect_ratio":{"$ref":"#/components/schemas/IdeogramV3AspectRatio"},"rendering_speed":{"$ref":"#/components/schemas/V2ImageGenerateIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","default":"default","description":"The rendering speed to use."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"color_palette":{"$ref":"#/components/schemas/IdeogramColorPalette"},"style_codes":{"type":"array","items":{"$ref":"#/components/schemas/StyleCode"},"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."},"style_type":{"$ref":"#/components/schemas/IdeogramV3StyleType","default":"general"},"style_preset":{"$ref":"#/components/schemas/IdeogramV3StylePreset","description":"A predefined style preset to apply to the generated images. Cannot be combined with style codes or style references."},"style_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP)."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/ideogram-3-character":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_ideogram_v3_character","summary":"Generate a consistent character with Ideogram 3.0","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV3CharacterResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt to generate images from."},"negative_prompt":{"type":"string","maxLength":10000,"description":"Description of what to exclude from the images. The prompt takes precedence over the negative prompt."},"character_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"An image of the character to feature (max 25MB; JPEG, PNG, or WEBP)."},"character_reference_mask":{"type":"string","format":"binary","description":"Optional grayscale mask marking where the character is in the character reference image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"resolution":{"$ref":"#/components/schemas/ResolutionV3"},"aspect_ratio":{"$ref":"#/components/schemas/IdeogramV3AspectRatio"},"rendering_speed":{"$ref":"#/components/schemas/V2ImageGenerateIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","default":"default","description":"The rendering speed to use."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"style_type":{"$ref":"#/components/schemas/V2ImageGenerateIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaStyleType","default":"auto","description":"The style type to generate the character with. Defaults to `auto`."},"style_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP)."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","character_reference_images"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/ideogram-3-custom-model":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_ideogram_v3_custom_model","summary":"Generate with a custom Ideogram 3.0 model","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV3CustomModelResponse"}}}},"400":{"description":"Invalid input or an unsupported model option.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"The custom model does not exist or is not accessible to this user or organization.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"A requested resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt to generate images from."},"custom_model_uri":{"type":"string","pattern":"^model/[^/]+/version/[^/]+$","minLength":1,"maxLength":512,"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."},"transparent_background":{"type":"boolean","default":false,"description":"Remove the background after generation and return transparent PNG images. Included in the custom model generation price at no extra charge. When false, the model's automatic background removal behavior still applies."},"negative_prompt":{"type":"string","maxLength":10000,"description":"Description of what to exclude from the images. The prompt takes precedence over the negative prompt."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"resolution":{"$ref":"#/components/schemas/ResolutionV3"},"aspect_ratio":{"$ref":"#/components/schemas/IdeogramV3AspectRatio"},"rendering_speed":{"$ref":"#/components/schemas/V2ImageGenerateIdeogram3CustomModelPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","description":"The rendering speed to use. When omitted, a speed supported by the custom model is used."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"color_palette":{"$ref":"#/components/schemas/IdeogramColorPalette"},"style_codes":{"type":"array","items":{"$ref":"#/components/schemas/StyleCode"},"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."},"style_preset":{"$ref":"#/components/schemas/IdeogramV3StylePreset","description":"A predefined style preset to apply to the generated images. Cannot be combined with style codes or style references."},"style_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","custom_model_uri"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/ideogram-3-transparent":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_ideogram_v3_transparent","summary":"Generate transparent images with Ideogram 3.0","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV3TransparentResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate transparent-background images with Ideogram 3.0.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV3TransparentRequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/ideogram-2a":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_ideogram_v2_a","summary":"Generate with Ideogram 2a","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV2AResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with Ideogram 2a.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV2ARequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/ideogram-2":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_ideogram_v2","summary":"Generate with Ideogram 2.0","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV2Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with Ideogram 2.0.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageIdeogramV2Request"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/gpt-image-2-5-flare":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_gpt_image25_flare","summary":"Generate with GPT Image 2.5 Flare","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageGptImage25FlareResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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."},"images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only."},"mask":{"type":"string","format":"binary","description":"An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. White pixels mark the area to edit and black pixels mark the area to keep. The mask must have the same dimensions as the first source image and requires source images in the same request."},"background":{"$ref":"#/components/schemas/V2ImageGenerateGptImage25FlarePostRequestBodyContentMultipartFormDataSchemaBackground","default":"auto","description":"The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt."},"quality":{"$ref":"#/components/schemas/V2ImageGenerateGptImage25FlarePostRequestBodyContentMultipartFormDataSchemaQuality","default":"auto","description":"How much rendering effort the model spends. Lower tiers return sooner and cost less; `auto` lets the model choose, which it currently renders at `high`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"aspect_ratio":{"type":"string","description":"The requested output aspect ratio, for example \"1:1\", \"16:9\", or \"9:16\". Ignored when `resolution` is provided. Defaults to \"1:1\"."},"resolution":{"type":"string","description":"Exact output resolution, formatted as \"WIDTHxHEIGHT\", for example\n\"2048x2048\" or \"1920x1088\". When provided, this takes precedence\nover `aspect_ratio`. The dimensions must satisfy GPT Image 2.5 Flare\nconstraints: each side is a multiple of 16, the largest side is at\nmost 3840px, the long:short ratio is at most 3:1, and total pixels\nare between 655360 and 8294400 inclusive.\n"},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/gpt-image-2-5-sunburst":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_gpt_image25_sunburst","summary":"Generate with GPT Image 2.5 Sunburst","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageGptImage25SunburstResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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."},"images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only."},"mask":{"type":"string","format":"binary","description":"An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. White pixels mark the area to edit and black pixels mark the area to keep. The mask must have the same dimensions as the first source image and requires source images in the same request."},"background":{"$ref":"#/components/schemas/V2ImageGenerateGptImage25SunburstPostRequestBodyContentMultipartFormDataSchemaBackground","default":"auto","description":"The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt."},"quality":{"$ref":"#/components/schemas/V2ImageGenerateGptImage25SunburstPostRequestBodyContentMultipartFormDataSchemaQuality","default":"auto","description":"How much rendering effort the model spends. Lower tiers return sooner and cost less; `auto` lets the model choose, which it currently renders at `high`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"aspect_ratio":{"type":"string","description":"The requested output aspect ratio, for example \"1:1\", \"16:9\", or \"9:16\". Ignored when `resolution` is provided. Defaults to \"1:1\"."},"resolution":{"type":"string","description":"Exact output resolution, formatted as \"WIDTHxHEIGHT\", for example\n\"2048x2048\" or \"1920x1088\". When provided, this takes precedence\nover `aspect_ratio`. The dimensions must satisfy GPT Image 2.5 Sunburst\nconstraints: each side is a multiple of 16, the largest side is at\nmost 3840px, the long:short ratio is at most 3:1, and total pixels\nare between 655360 and 8294400 inclusive.\n"},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/gpt-image-2":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_gpt_image2","summary":"Generate with GPT Image 2","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageGptImage2Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with GPT Image 2. Send it as `application/json`, or as `multipart/form-data` to include source `images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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."},"images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only."},"mask":{"type":"string","format":"binary","description":"An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. White pixels mark the area to edit and black pixels mark the area to keep. The mask must have the same dimensions as the first source image and requires source images in the same request."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"aspect_ratio":{"type":"string","description":"The requested output aspect ratio, for example \"1:1\", \"16:9\", or \"9:16\". Ignored when `resolution` is provided. Defaults to \"1:1\"."},"resolution":{"type":"string","description":"Exact output resolution, formatted as \"WIDTHxHEIGHT\", for example\n\"2048x2048\" or \"1920x1088\". When provided, this takes precedence\nover `aspect_ratio`. The dimensions must satisfy GPT Image 2\nconstraints: each side is a multiple of 16, the largest side is at\nmost 3840px, the long:short ratio is at most 3:1, and total pixels\nare between 655360 and 8294400 inclusive.\n"},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/nano-banana-2":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_nano_banana2","summary":"Generate with Nano Banana 2","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageNanoBanana2Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with Nano Banana 2. Send it as `application/json`, or as `multipart/form-data` to include source `images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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."},"images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only."},"aspect_ratio":{"$ref":"#/components/schemas/NanoBanana2AspectRatio","default":"auto"},"resolution_tier":{"$ref":"#/components/schemas/V2ImageGenerateNanoBanana2PostRequestBodyContentMultipartFormDataSchemaResolutionTier","default":"1K","description":"The output resolution tier."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/nano-banana-2-1":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_nano_banana21","summary":"Generate with Nano Banana 2.1","description":"Generate images with Nano Banana 2.1. 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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageNanoBanana21Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with Nano Banana 2.1. Send it as `application/json`, or as `multipart/form-data` to include source `images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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."},"images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only."},"aspect_ratio":{"$ref":"#/components/schemas/NanoBanana21AspectRatio","default":"auto"},"resolution_tier":{"$ref":"#/components/schemas/V2ImageGenerateNanoBanana21PostRequestBodyContentMultipartFormDataSchemaResolutionTier","default":"1K","description":"The output resolution tier."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/nano-banana-pro":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_nano_banana_pro","summary":"Generate with Nano Banana Pro","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageNanoBananaProResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with Nano Banana Pro. Send it as `application/json`, or as `multipart/form-data` to include source `images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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."},"images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Optional source images to edit (max 10, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only."},"aspect_ratio":{"$ref":"#/components/schemas/NanoBananaProAspectRatio","default":"auto"},"resolution_tier":{"$ref":"#/components/schemas/V2ImageGenerateNanoBananaProPostRequestBodyContentMultipartFormDataSchemaResolutionTier","default":"1K","description":"The output resolution tier."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/p-image-ideogram":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_p_image_ideogram","summary":"Generate with P-Image Ideogram","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImagePImageIdeogramResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with P-Image Ideogram.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImagePImageIdeogramRequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/generate/z-image":{"post":{"operationId":"imagesGenerate_post_generate_image_v2_z_image","summary":"Generate with Z-Image","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","tags":["images-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The generated images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageZImageResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate images with Z-Image.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateImageZImageRequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/remix/auto":{"post":{"operationId":"autoModel_post_tool_remix","summary":"Remix with automatic model selection","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}`.","tags":["auto-model"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolRemixResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to remix one image with an automatically selected model. Send it as `multipart/form-data` with the source `image`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt that guides the remix."},"image":{"type":"string","format":"binary","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."},"image_weight":{"type":"integer","minimum":1,"maximum":100,"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."},"negative_prompt":{"type":"string","maxLength":10000,"description":"Description of what to exclude from the images. The prompt takes precedence over the negative prompt. Not every model uses it."},"resolution":{"type":"string","pattern":"^[1-9][0-9]{1,4}x[1-9][0-9]{1,4}$","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."},"aspect_ratio":{"$ref":"#/components/schemas/IdeogramV4AspectRatio","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":{"$ref":"#/components/schemas/V2ImageRemixAutoPostRequestBodyContentMultipartFormDataSchemaResolutionTier","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."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`. The selected model decides how to interpret it."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"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."},"style_preset":{"$ref":"#/components/schemas/IdeogramV3StylePreset","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":{"$ref":"#/components/schemas/IdeogramColorPalette","description":"A color palette to apply. Limits the request to a model that supports palettes and requires the 1K resolution tier."},"style_codes":{"type":"array","items":{"$ref":"#/components/schemas/StyleCode"},"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."},"style_type":{"$ref":"#/components/schemas/IdeogramV3StyleType","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":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/remix/ideogram-4":{"post":{"operationId":"imagesRemix_post_remix_image_v2_ideogram_v4","summary":"Remix with Ideogram 4.0","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","tags":["images-remix"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemixImageIdeogramV4Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Use `multipart/form-data` to upload the source `image`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt that guides the remix. It is always read as an editing instruction, so there is no `magic_prompt` option."},"image":{"type":"string","format":"binary","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."},"image_weight":{"type":"integer","minimum":1,"maximum":100,"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."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"resolution":{"$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"},"rendering_speed":{"$ref":"#/components/schemas/V2ImageRemixIdeogram4PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","default":"default","description":"The rendering speed to use."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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`."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/remix/ideogram-3":{"post":{"operationId":"imagesRemix_post_remix_image_v2_ideogram_v3","summary":"Remix with Ideogram 3.0","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","tags":["images-remix"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemixImageIdeogramV3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Use `multipart/form-data` to upload the source `image` and any `style_reference_images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt that guides the remix."},"image":{"type":"string","format":"binary","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."},"image_weight":{"type":"integer","minimum":1,"maximum":100,"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."},"negative_prompt":{"type":"string","maxLength":10000,"description":"Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"resolution":{"$ref":"#/components/schemas/ResolutionV3"},"aspect_ratio":{"$ref":"#/components/schemas/AspectRatioV3"},"rendering_speed":{"$ref":"#/components/schemas/V2ImageRemixIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","default":"default","description":"The rendering speed to use."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"color_palette":{"$ref":"#/components/schemas/IdeogramColorPalette"},"style_codes":{"type":"array","items":{"$ref":"#/components/schemas/StyleCode"},"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."},"style_type":{"$ref":"#/components/schemas/IdeogramV3StyleType","default":"general"},"style_preset":{"$ref":"#/components/schemas/IdeogramV3StylePreset","description":"A predefined style preset to apply to the remixed images. Cannot be combined with style codes or style references."},"style_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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`."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/remix/ideogram-3-character":{"post":{"operationId":"imagesRemix_post_remix_image_v2_ideogram_v3_character","summary":"Remix a consistent character with Ideogram 3.0","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","tags":["images-remix"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemixImageIdeogramV3CharacterResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Use `multipart/form-data` to upload the source `image` and any `character_reference_images` or `style_reference_images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt that guides the remix."},"image":{"type":"string","format":"binary","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."},"image_weight":{"type":"integer","minimum":1,"maximum":100,"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."},"negative_prompt":{"type":"string","maxLength":10000,"description":"Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt."},"character_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported."},"character_reference_mask":{"type":"string","format":"binary","description":"Optional grayscale mask for the 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; cannot be combined with `character_reference_collection_id`."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"resolution":{"$ref":"#/components/schemas/ResolutionV3"},"aspect_ratio":{"$ref":"#/components/schemas/AspectRatioV3"},"rendering_speed":{"$ref":"#/components/schemas/V2ImageRemixIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","default":"default","description":"The rendering speed to use."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"style_type":{"$ref":"#/components/schemas/V2ImageRemixIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaStyleType","default":"auto","description":"The style type to remix the character with. Defaults to `auto`."},"style_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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`."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","image","character_reference_images"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/remix/ideogram-3-custom-model":{"post":{"operationId":"imagesRemix_post_remix_image_v2_ideogram_v3_custom_model","summary":"Remix with a custom Ideogram 3.0 model","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","tags":["images-remix"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The remixed images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemixImageIdeogramV3CustomModelResponse"}}}},"400":{"description":"Invalid input or an unsupported model option.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"The custom model does not exist or is not accessible to this user or organization.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Use `multipart/form-data` to upload the source `image` and any `style_reference_images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt that guides the remix."},"custom_model_uri":{"type":"string","pattern":"^model/[^/]+/version/[^/]+$","minLength":1,"maxLength":512,"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."},"image":{"type":"string","format":"binary","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."},"image_weight":{"type":"integer","minimum":1,"maximum":100,"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."},"negative_prompt":{"type":"string","maxLength":10000,"description":"Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"resolution":{"$ref":"#/components/schemas/ResolutionV3"},"aspect_ratio":{"$ref":"#/components/schemas/AspectRatioV3"},"rendering_speed":{"$ref":"#/components/schemas/V2ImageRemixIdeogram3CustomModelPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","description":"The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"color_palette":{"$ref":"#/components/schemas/IdeogramColorPalette"},"style_codes":{"type":"array","items":{"$ref":"#/components/schemas/StyleCode"},"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."},"style_preset":{"$ref":"#/components/schemas/IdeogramV3StylePreset","description":"A predefined style preset to apply to the remixed images. Cannot be combined with style codes or style references."},"style_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Multipart requests only."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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`."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","custom_model_uri","image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/inpaint/ideogram-3":{"post":{"operationId":"imagesInpaint_post_inpaint_image_v2_ideogram_v3","summary":"Inpaint with Ideogram 3.0","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}`.","tags":["images-inpaint"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The repainted images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InpaintImageIdeogramV3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Use `multipart/form-data` to upload the source `image`, its `mask`, and any `style_reference_images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt describing the repainted result."},"image":{"type":"string","format":"binary","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."},"mask":{"type":"string","format":"binary","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."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"rendering_speed":{"$ref":"#/components/schemas/V2ImageInpaintIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","default":"default","description":"The rendering speed to use."},"style_type":{"$ref":"#/components/schemas/IdeogramV3StyleType","default":"general"},"style_preset":{"$ref":"#/components/schemas/IdeogramV3StylePreset","description":"A predefined style preset to apply to the repainted images. Cannot be combined with style codes or style references."},"style_codes":{"type":"array","items":{"$ref":"#/components/schemas/StyleCode"},"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."},"style_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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`."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","image","mask"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/inpaint/ideogram-3-character":{"post":{"operationId":"imagesInpaint_post_inpaint_image_v2_ideogram_v3_character","summary":"Inpaint a consistent character with Ideogram 3.0","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}`.","tags":["images-inpaint"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The repainted images (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InpaintImageIdeogramV3CharacterResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Use `multipart/form-data` to upload the source `image`, its `mask`, and any `character_reference_images` or `style_reference_images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt describing the repainted result."},"image":{"type":"string","format":"binary","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."},"mask":{"type":"string","format":"binary","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."},"character_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported."},"character_reference_mask":{"type":"string","format":"binary","description":"Optional grayscale mask for the 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; cannot be combined with `character_reference_collection_id`."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"rendering_speed":{"$ref":"#/components/schemas/V2ImageInpaintIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","default":"default","description":"The rendering speed to use."},"style_type":{"$ref":"#/components/schemas/V2ImageInpaintIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaStyleType","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 (not both) require `auto`. For API-key callers, combining a style with a character requires that feature to be enabled for their account."},"style_codes":{"type":"array","items":{"$ref":"#/components/schemas/StyleCode"},"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."},"style_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Images to use as style references (max 10, max 25MB each). JPEG, PNG, and WEBP are supported. Cannot be combined with `style_codes`."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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`."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","image","mask","character_reference_images"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/inpaint/ideogram-3-custom-model":{"post":{"operationId":"imagesInpaint_post_inpaint_image_v2_ideogram_v3_custom_model","summary":"Inpaint with a custom Ideogram 3.0 model","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}`.","tags":["images-inpaint"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The repainted images, or an acknowledgement for an asynchronous request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InpaintImageIdeogramV3CustomModelResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"The caller cannot use the requested custom model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Use `multipart/form-data` to upload the source `image`, its `mask`, and any `style_reference_images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt describing the repainted result."},"custom_model_uri":{"type":"string","pattern":"^model/[^/]+/version/[^/]+$","minLength":1,"maxLength":512,"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."},"image":{"type":"string","format":"binary","description":"The source image to repaint (max 25MB), as JPEG, PNG, or WEBP. Multipart requests only."},"mask":{"type":"string","format":"binary","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."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"rendering_speed":{"$ref":"#/components/schemas/V2ImageInpaintIdeogram3CustomModelPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","description":"The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model."},"style_preset":{"$ref":"#/components/schemas/IdeogramV3StylePreset","description":"A predefined style preset. Cannot be combined with style codes or style references."},"style_codes":{"type":"array","items":{"$ref":"#/components/schemas/StyleCode"},"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."},"style_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Images to use as style references (max 10, max 25MB each), as JPEG, PNG, or WEBP."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images return `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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}`."}},"required":["prompt","custom_model_uri","image","mask"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/reframe/ideogram-3":{"post":{"operationId":"reframe_ideogramV3","summary":"Reframe with Ideogram 3.0","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","tags":["reframe"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The reframed images, or an acknowledgement for an asynchronous request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReframeImageIdeogramV3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Use `multipart/form-data` to upload the source `image` and any `style_reference_images`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only."},"resolution":{"$ref":"#/components/schemas/ResolutionV3"},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"rendering_speed":{"$ref":"#/components/schemas/V2ImageReframeIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","default":"default"},"style_preset":{"$ref":"#/components/schemas/IdeogramV3StylePreset"},"color_palette":{"$ref":"#/components/schemas/IdeogramColorPalette"},"style_codes":{"type":"array","items":{"$ref":"#/components/schemas/StyleCode"},"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."},"style_reference_images":{"type":"array","items":{"type":"string","format":"binary"},"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`."},"async":{"type":"boolean","default":false,"description":"Return immediately instead of waiting for reframed images."}},"required":["image","resolution"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/reframe/nano-banana-2":{"post":{"operationId":"reframe_nanoBanana2","summary":"Reframe with Nano Banana 2","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","tags":["reframe"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReframeImageNanoBanana2Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"A referenced resource was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The JPEG, PNG, or WEBP image to reframe (max 50MB)."},"aspect_ratio":{"$ref":"#/components/schemas/NanoBanana2ReframeAspectRatio"},"private":{"type":"boolean","description":"API-key requests are always private. For bearer-authenticated\nrequests, this controls whether the result is private; when\nomitted, it follows the caller's plan entitlement. Enterprise\ngenerations are always private.\n"},"num_images":{"type":"integer","minimum":1,"maximum":4,"default":1,"description":"The number of output images to generate."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["image","aspect_ratio"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/upscale/auto":{"post":{"operationId":"tools_post_upscale","summary":"Upscale with automatic model selection","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","tags":["tools"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpscaleToolResponse"}}}},"400":{"description":"Invalid input provided, or the output would exceed the 8K limit.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to upscale images.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to upscale one image. Upload the source `image` using `multipart/form-data`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"upscale_factor":{"$ref":"#/components/schemas/V2ImageUpscaleAutoPostRequestBodyContentMultipartFormDataSchemaUpscaleFactor","default":"x2","description":"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."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"async":{"type":"boolean","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 `GET /v2/generations/{generation_id}` for the result."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/upscale/nano-banana-pro":{"post":{"operationId":"imagesUpscale_post_upscale_image_nano_banana_pro","summary":"Upscale with Nano Banana Pro","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","tags":["images-upscale"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpscaleImageNanoBananaProResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"The source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to upscale one image with Nano Banana Pro. Upload the source `image` using `multipart/form-data`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"prompt":{"type":"string","maxLength":2000,"description":"Optional short guidance for the enhancement, appended to the model's upscaling instruction. When omitted, the image is upscaled as-is."},"resolution_tier":{"$ref":"#/components/schemas/V2ImageUpscaleNanoBananaProPostRequestBodyContentMultipartFormDataSchemaResolutionTier","default":"2K","description":"The output resolution tier. The model sizes its output by tier at the source image's aspect ratio; exact pixel dimensions cannot be requested. Rejected when the source is already at or above the requested tier. Defaults to \"2K\"."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"async":{"type":"boolean","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 `GET /v2/generations/{generation_id}` for the result."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/upscale/topaz-bloom-2":{"post":{"operationId":"imagesUpscale_post_upscale_image_topaz_bloom2","summary":"Upscale with Topaz Bloom 2","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","tags":["images-upscale"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpscaleImageTopazBloom2Response"}}}},"400":{"description":"Invalid input provided, or the output would exceed the 8K limit.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"The source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to upscale one image with Topaz Bloom 2. Upload the source `image` using `multipart/form-data`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"upscale_factor":{"$ref":"#/components/schemas/V2ImageUpscaleTopazBloom2PostRequestBodyContentMultipartFormDataSchemaUpscaleFactor","default":"x2","description":"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."},"prompt":{"type":"string","maxLength":1024,"default":"","description":"An optional prompt guiding the detail the model regenerates while enlarging the image. Leave empty to enhance the source image as-is."},"creativity":{"type":"integer","minimum":1,"maximum":9,"default":3,"description":"How strongly the model reinterprets the source while enlarging it, from 1 (most faithful) to 9 (most creative)."},"color_preservation":{"type":"boolean","default":true,"description":"When true (the default), the output keeps the source image's colors. Set to false to let the model adjust colors while enhancing."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"async":{"type":"boolean","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 `GET /v2/generations/{generation_id}` for the result."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/upscale/topaz-redefine":{"post":{"operationId":"imagesUpscale_post_upscale_image_topaz_redefine","summary":"Upscale with Topaz Redefine","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","tags":["images-upscale"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpscaleImageTopazRedefineResponse"}}}},"400":{"description":"Invalid input provided, or the output would exceed the 8K limit.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"The source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to upscale one image with Topaz Redefine. Upload the source `image` using `multipart/form-data`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"upscale_factor":{"$ref":"#/components/schemas/V2ImageUpscaleTopazRedefinePostRequestBodyContentMultipartFormDataSchemaUpscaleFactor","default":"x2","description":"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."},"prompt":{"type":"string","maxLength":1024,"default":"","description":"An optional prompt guiding the detail the model regenerates while enlarging the image. Leave empty to enhance the source image as-is."},"creativity":{"type":"integer","minimum":1,"maximum":9,"default":3,"description":"How strongly the model reinterprets the source while enlarging it, from 1 (most faithful) to 9 (most creative)."},"autoprompt":{"type":"boolean","default":false,"description":"When true, the model describes the image itself and any `prompt` is ignored."},"texture":{"type":"integer","minimum":1,"maximum":5,"default":1,"description":"How much fine texture the model adds, from 1 to 5. Keep it low at low creativity."},"detail":{"type":"boolean","default":false,"description":"Apply a detail adjustment after rendering. When true, `detail_strength` sets how much."},"detail_strength":{"type":"string","title":"float","description":"Detail adjustment intensity, from 0 to 10."},"sharpen":{"type":"string","title":"float","description":"Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image."},"denoise":{"type":"string","title":"float","description":"Noise and grain reduction, from 0 to 1. Omit to let the model choose per image."},"face_enhancement":{"type":"boolean","description":"Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required."},"face_enhancement_strength":{"type":"string","title":"float","description":"How strongly faces are recovered, from 0 to 1."},"face_enhancement_creativity":{"type":"string","title":"float","description":"How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative)."},"subject_detection":{"$ref":"#/components/schemas/V2ImageUpscaleTopazRedefinePostRequestBodyContentMultipartFormDataSchemaSubjectDetection","description":"Where enhancements apply. Omit to let the model choose per image."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"async":{"type":"boolean","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 `GET /v2/generations/{generation_id}` for the result."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/upscale/topaz-standard-2":{"post":{"operationId":"imagesUpscale_post_upscale_image_topaz_standard_v2","summary":"Upscale with Topaz Standard V2","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","tags":["images-upscale"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpscaleImageTopazStandardV2Response"}}}},"400":{"description":"Invalid input provided, or the output would exceed the 8K limit.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"The source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to upscale one image with Topaz Standard V2. Upload the source `image` using `multipart/form-data`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"upscale_factor":{"$ref":"#/components/schemas/V2ImageUpscaleTopazStandard2PostRequestBodyContentMultipartFormDataSchemaUpscaleFactor","default":"x2","description":"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."},"strength":{"type":"string","title":"float","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."},"sharpen":{"type":"string","title":"float","description":"Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image."},"denoise":{"type":"string","title":"float","description":"Noise and grain reduction, from 0 to 1. Omit to let the model choose per image."},"fix_compression":{"type":"string","title":"float","description":"Compression artifact removal, from 0 to 1. Omit to let the model choose per image."},"face_enhancement":{"type":"boolean","description":"Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required."},"face_enhancement_strength":{"type":"string","title":"float","description":"How strongly faces are recovered, from 0 to 1."},"face_enhancement_creativity":{"type":"string","title":"float","description":"How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative)."},"subject_detection":{"$ref":"#/components/schemas/V2ImageUpscaleTopazStandard2PostRequestBodyContentMultipartFormDataSchemaSubjectDetection","description":"Where enhancements apply. Omit to let the model choose per image."},"async":{"type":"boolean","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 `GET /v2/generations/{generation_id}` for the result."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/upscale/topaz-text-refine":{"post":{"operationId":"imagesUpscale_post_upscale_image_topaz_text_refine","summary":"Upscale with Topaz Text Refine","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","tags":["images-upscale"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpscaleImageTopazTextRefineResponse"}}}},"400":{"description":"Invalid input provided, or the output would exceed the 8K limit.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"The source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to upscale one image with Topaz Text Refine. Upload the source `image` using `multipart/form-data`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"upscale_factor":{"$ref":"#/components/schemas/V2ImageUpscaleTopazTextRefinePostRequestBodyContentMultipartFormDataSchemaUpscaleFactor","default":"x2","description":"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."},"strength":{"type":"string","title":"float","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."},"sharpen":{"type":"string","title":"float","description":"Edge sharpening applied after enlarging, from 0 to 1. Omit to let the model choose per image."},"denoise":{"type":"string","title":"float","description":"Noise and grain reduction, from 0 to 1. Omit to let the model choose per image."},"fix_compression":{"type":"string","title":"float","description":"Compression artifact removal, from 0 to 1. Omit to let the model choose per image."},"face_enhancement":{"type":"boolean","description":"Recover detail in faces. When true, `face_enhancement_strength` and `face_enhancement_creativity` are required."},"face_enhancement_strength":{"type":"string","title":"float","description":"How strongly faces are recovered, from 0 to 1."},"face_enhancement_creativity":{"type":"string","title":"float","description":"How freely face recovery may reinterpret features, from 0 (faithful) to 1 (creative)."},"subject_detection":{"$ref":"#/components/schemas/V2ImageUpscaleTopazTextRefinePostRequestBodyContentMultipartFormDataSchemaSubjectDetection","description":"Where enhancements apply. Omit to let the model choose per image."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"async":{"type":"boolean","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 `GET /v2/generations/{generation_id}` for the result."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/upscale/topaz-wonder-3-5":{"post":{"operationId":"imagesUpscale_post_upscale_image_topaz_wonder35","summary":"Upscale with Topaz Wonder 3.5","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","tags":["images-upscale"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The upscaled image (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpscaleImageTopazWonder35Response"}}}},"400":{"description":"Invalid input provided, or the output would exceed the 8K limit.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"The source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to upscale one image with Topaz Wonder 3.5. Upload the source `image` using `multipart/form-data`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"upscale_factor":{"$ref":"#/components/schemas/V2ImageUpscaleTopazWonder35PostRequestBodyContentMultipartFormDataSchemaUpscaleFactor","default":"x2","description":"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."},"enhancement_strength":{"$ref":"#/components/schemas/V2ImageUpscaleTopazWonder35PostRequestBodyContentMultipartFormDataSchemaEnhancementStrength","default":"high","description":"How strongly the generative model reconstructs detail while upscaling. Lower values stay closer to the source image; higher values produce a more enhanced result."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"async":{"type":"boolean","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 `GET /v2/generations/{generation_id}` for the result."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/replace-background/ideogram-3":{"post":{"operationId":"tool_replaceBackgroundIdeogramV3","summary":"Replace background with Ideogram 3.0","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","tags":["tool"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Background replacement accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceBackgroundResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to replace backgrounds.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The source image was not found or is not readable.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"503":{"description":"Background replacement is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The source image and a prompt describing its new background.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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"},"prompt":{"type":"string","pattern":"\\S","minLength":1,"maxLength":4000,"description":"Plain-language description of the desired new background."},"rendering_speed":{"$ref":"#/components/schemas/V2ImageReplaceBackgroundIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed","default":"default","description":"The rendering speed to use."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"private":{"type":"boolean","description":"Whether to keep the result private. When omitted, defaults to your\nplan's setting. Enterprise generations are always private.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/replace-background/gpt-image-2":{"post":{"operationId":"tool_replaceBackground","summary":"Replace background with GPT Image 2","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","tags":["tool"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Background replacement accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceBackgroundResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to replace backgrounds.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The source image was not found or is not readable.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"503":{"description":"Background replacement is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The source image and a prompt describing its new background.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and\nMPO are supported, up to 50 MB. Multipart requests only.\n"},"prompt":{"type":"string","pattern":"\\S","minLength":1,"maxLength":4000,"description":"Plain-language description of the desired new background."},"quality":{"$ref":"#/components/schemas/ReplaceBackgroundQuality","default":"high","description":"The generation quality level. Defaults to `high`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"private":{"type":"boolean","description":"Whether to keep the result private. When omitted, defaults to your\nplan's setting. Enterprise generations are always private.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/remove-background/ideogram-1":{"post":{"operationId":"tool_removeBackground","summary":"Remove background","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","tags":["tool"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveBackgroundV2Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to remove backgrounds.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The source image was not found or is not readable.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"The background-removal request failed.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Background removal is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The source image. JPEG, PNG, or WebP, up to 25MB. Multipart requests only."},"private":{"type":"boolean","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"},"async":{"type":"boolean","default":false,"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."}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/remove-object/ideogram-1":{"post":{"operationId":"objectRemoval_post_remove_object_from_v2_assets","summary":"Remove an object","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","tags":["object-removal"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Object removal request accepted; poll for completion with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveObjectFromV2AssetsResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to remove an object.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The source image or mask was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"413":{"description":"An uploaded source or mask image is too large.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The source `image` and `mask`, uploaded using `multipart/form-data`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The source image to remove an object from. JPEG, PNG, or WEBP, up to 50MB. Multipart requests only."},"mask":{"type":"string","format":"binary","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."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["image","mask"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/describe/ideogram-4":{"post":{"operationId":"imageDescribe_post_describe_image_ideogram_v4","summary":"Describe with Ideogram 4.0","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","tags":["image-describe"],"responses":{"200":{"description":"Structured prompt generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeImageIdeogramV4Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"The source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Image failed the safety check.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageSafetyError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to describe one image. Send it as `multipart/form-data` with the `image` to describe.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only."},"include_bbox":{"type":"boolean","default":true,"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."},"include_style_descriptions":{"type":"boolean","default":false,"description":"Whether to include a free-form style description in the returned `json_prompt`. Defaults to false."},"include_tags":{"type":"boolean","default":false,"description":"Whether to include free-form tags in the returned `json_prompt`. Defaults to false."}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/describe/ideogram-3":{"post":{"operationId":"imageDescribe_post_describe_image_ideogram_v3","summary":"Describe with Ideogram 3.0","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","tags":["image-describe"],"responses":{"200":{"description":"Description(s) generated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeImageIdeogramV3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"404":{"description":"The source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Image failed the safety check.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageSafetyError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to describe one image. Send it as `multipart/form-data` with the `image` to describe.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only."}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/design/layerize/ideogram-3":{"post":{"operationId":"design_post_layerize_design_ideogram_v3","summary":"Layerize text with Ideogram 3.0","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","tags":["design"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The layerized design (synchronous requests), or an acknowledgement to poll with `GET /v2/generations/{generation_id}` (`async` requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerizeDesignIdeogramV3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to layerize images.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The source image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to layerize the text in one image. Send it as `multipart/form-data` with the source `image`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The source image to layerize (max 50MB). Common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only."},"prompt":{"type":["string","null"],"maxLength":10000,"description":"A description of the image, used to guide text detection. When omitted, detection runs on the image alone."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"font_candidate_files":{"type":"array","items":{"type":"string","format":"binary"},"description":"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."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/kling-3-standard-image-to-video":{"post":{"operationId":"videoGenerate_post_generate_video_kling_v3_standard_image_to_video","summary":"Image to video with Kling v3 Standard","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","tags":["video-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoKlingV3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The first-frame image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"end_image":{"type":"string","format":"binary","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."},"prompt":{"type":"string","minLength":1,"maxLength":2000,"description":"A natural-language prompt describing how the first frame should animate."},"negative_prompt":{"type":"string","maxLength":2000,"description":"Description of what to keep out of the video. Descriptions in the prompt take precedence over descriptions in the negative prompt."},"duration":{"type":"integer","minimum":3,"maximum":15,"description":"The length of the generated video in seconds. Defaults to 5 seconds\nwhen omitted.\n"},"generate_audio":{"type":"boolean","default":false,"description":"Whether to generate an audio track for the video. Audio roughly\ndoubles the provider cost and is subject to stricter output moderation.\n"},"shot_type":{"$ref":"#/components/schemas/KlingV3ShotType","default":"customize"},"cfg_scale":{"type":"string","title":"float","description":"How closely the video follows the prompt, from 0 to 1. Lower values\nleave the model more freedom. Defaults to 0.5 when omitted.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/kling-3-standard-text-to-video":{"post":{"operationId":"videoGenerate_post_generate_video_kling_v3_standard_text_to_video","summary":"Text to video with Kling v3 Standard","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","tags":["video-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoKlingV3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate a video from a text prompt with Kling v3 Standard.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoKlingV3StandardTextToVideoRequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/minimax-h3-image-to-video":{"post":{"operationId":"videoGenerate_post_generate_video_minimax_h3_image_to_video","summary":"Image to video with MiniMax H3","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","tags":["video-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoMinimaxH3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The first-frame image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"end_image":{"type":"string","format":"binary","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."},"prompt":{"type":"string","minLength":1,"maxLength":2000,"description":"A natural-language prompt describing how the first frame should animate."},"resolution":{"$ref":"#/components/schemas/MinimaxH3Resolution","default":"2K"},"duration":{"type":"integer","minimum":5,"maximum":15,"default":5,"description":"The length of the generated video in seconds."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/minimax-h3-reference-to-video":{"post":{"operationId":"videoEdit_post_edit_video_minimax_h3_reference_to_video","summary":"Reference to video with MiniMax H3","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","tags":["video-edit"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoMinimaxH3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"A referenced asset was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to produce a video from reference media with MiniMax H3. Use `multipart/form-data` to upload reference media.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000,"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\"."},"reference_images":{"type":"array","items":{"type":"string","format":"binary"},"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."},"reference_audios":{"type":"array","items":{"type":"string","format":"binary"},"description":"MP3 or WAV audio references, in prompt order as Audio 1, Audio 2, and Audio 3. Multipart uploads only; up to 15 MB per file and 2–15 seconds each. Audio and video references must total no more than 15 seconds. Requires a reference image or video. At most 12 references across images, videos, and audio. Used only for this request and not saved as assets."},"aspect_ratio":{"$ref":"#/components/schemas/MinimaxH3AspectRatio","default":"16x9"},"resolution":{"$ref":"#/components/schemas/MinimaxH3Resolution","default":"2K"},"duration":{"type":"integer","minimum":5,"maximum":15,"default":5,"description":"The length of the generated video in seconds."},"prompt_expansion_mode":{"$ref":"#/components/schemas/MinimaxH3PromptExpansionMode","default":"balanced"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/minimax-h3-text-to-video":{"post":{"operationId":"videoGenerate_post_generate_video_minimax_h3_text_to_video","summary":"Text to video with MiniMax H3","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","tags":["video-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoMinimaxH3Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate a video from a text prompt with MiniMax H3.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoMinimaxH3TextToVideoRequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/seedance-2-5-image-to-video":{"post":{"operationId":"videoGenerate_post_generate_video_seed_dance25_image_to_video","summary":"Image to video with Seedance 2.5","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","tags":["video-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoSeedDance25Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The first-frame image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"end_image":{"type":"string","format":"binary","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."},"prompt":{"type":"string","minLength":1,"maxLength":30000,"description":"A natural-language prompt describing how the first frame should animate."},"resolution":{"$ref":"#/components/schemas/SeedDance25Resolution","default":"720p"},"duration":{"type":"integer","minimum":4,"maximum":30,"description":"The length of the generated video in seconds. When omitted, the model\npicks the best duration for the prompt (\"auto\").\n"},"generate_audio":{"type":"boolean","default":false,"description":"Whether to generate an audio track for the video. Audio roughly\ndoubles the provider cost and is subject to stricter output moderation.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/seedance-2-5-reference-to-video":{"post":{"operationId":"videoGenerate_post_generate_video_seed_dance25_reference_to_video","summary":"Reference to video with Seedance 2.5","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","tags":["video-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoSeedDance25Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"A reference was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to produce a video from reference media with Seedance 2.5. Upload the references using `multipart/form-data`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":30000,"description":"A natural-language prompt describing the video to produce. Refer to references by position, as in \"[Image1] walks toward the camera\"."},"reference_images":{"type":"array","items":{"type":"string","format":"binary"},"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."},"reference_audios":{"type":"array","items":{"type":"string","format":"binary"},"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."},"aspect_ratio":{"$ref":"#/components/schemas/SeedDance2AspectRatio","default":"auto"},"resolution":{"$ref":"#/components/schemas/SeedDance25Resolution","default":"720p"},"duration":{"type":"integer","minimum":4,"maximum":30,"description":"The length of the generated video in seconds. When omitted, the model\npicks the best duration for the prompt (\"auto\").\n"},"generate_audio":{"type":"boolean","default":false,"description":"Whether to generate an audio track for the video. Audio roughly\ndoubles the provider cost and is subject to stricter output moderation.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/seedance-2-5-text-to-video":{"post":{"operationId":"videoGenerate_post_generate_video_seed_dance25_text_to_video","summary":"Text to video with Seedance 2.5","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","tags":["video-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoSeedDance25Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate a video from a text prompt with Seedance 2.5.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoSeedDance25TextToVideoRequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/seedance-2-image-to-video":{"post":{"operationId":"videoGenerate_post_generate_video_seed_dance2_image_to_video","summary":"Image to video with Seedance 2.0","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","tags":["video-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoSeedDance2Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The first-frame image was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"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`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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."},"end_image":{"type":"string","format":"binary","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."},"prompt":{"type":"string","minLength":1,"maxLength":2000,"description":"A natural-language prompt describing how the first frame should animate."},"aspect_ratio":{"$ref":"#/components/schemas/SeedDance2AspectRatio","default":"auto"},"resolution":{"$ref":"#/components/schemas/SeedDance2Resolution","default":"720p"},"duration":{"type":"integer","minimum":4,"maximum":15,"description":"The length of the generated video in seconds. When omitted, the model\npicks the best duration for the prompt (\"auto\").\n"},"generate_audio":{"type":"boolean","default":false,"description":"Whether to generate an audio track for the video. Audio roughly\ndoubles the provider cost and is subject to stricter output moderation.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/seedance-2-reference-to-video":{"post":{"operationId":"videoGenerate_post_generate_video_seed_dance2_reference_to_video","summary":"Reference to video with Seedance 2.0","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","tags":["video-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoSeedDance2Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"A reference was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to produce a video from reference media with Seedance 2.0. Upload the references using `multipart/form-data`.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000,"description":"A natural-language prompt describing the video to produce. Refer to references by position, as in \"@Image1 walks toward the camera\"."},"reference_images":{"type":"array","items":{"type":"string","format":"binary"},"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."},"reference_audios":{"type":"array","items":{"type":"string","format":"binary"},"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."},"aspect_ratio":{"$ref":"#/components/schemas/SeedDance2AspectRatio","default":"auto"},"resolution":{"$ref":"#/components/schemas/SeedDance2Resolution","default":"720p"},"duration":{"type":"integer","minimum":4,"maximum":15,"description":"The length of the generated video in seconds. When omitted, the model\npicks the best duration for the prompt (\"auto\").\n"},"generate_audio":{"type":"boolean","default":false,"description":"Whether to generate an audio track for the video. Audio roughly\ndoubles the provider cost and is subject to stricter output moderation.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/video/generate/seedance-2-text-to-video":{"post":{"operationId":"videoGenerate_post_generate_video_seed_dance2_text_to_video","summary":"Text to video with Seedance 2.0","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","tags":["video-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An acknowledgement to poll with `GET /v2/generations/{generation_id}`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoSeedDance2Response"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"This account does not have access to this model.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt did not pass safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"The endpoint is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"A request to generate videos from a text prompt with Seedance 2.0.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVideoSeedDance2TextToVideoRequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/svg/generate/ideogram-vector-1":{"post":{"operationId":"svgGenerate_post_generate_svg","summary":"Generate SVG","description":"Generates SVG artwork from a prompt and optional image references.","tags":["svg-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Generation accepted. Dry runs return a PriceQuote.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateSvgResponse"}}}},"400":{"description":"Invalid prompt, references, or settings.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Authentication required.","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"Access denied.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Reference not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"503":{"description":"Generation is unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":9500},"image_asset_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifier"},"description":"Existing uploaded or generated image references. Takes priority over images when both are supplied. The first image is the primary source; any others are additional references."},"images":{"type":"array","items":{"type":"string","format":"binary"},"description":"Source images to transform, supplied as multipart file uploads. The first image is the primary source; any others are additional references."},"aspect_ratio":{"$ref":"#/components/schemas/IdeogramV4AspectRatio","default":"auto"},"quality":{"$ref":"#/components/schemas/V2SvgGenerateIdeogramVector1PostRequestBodyContentMultipartFormDataSchemaQuality","default":"medium"},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1},"seed":{"type":"integer","minimum":0,"maximum":2147483647},"private":{"type":"boolean","description":"Outputs are private by default. Enterprise outputs are always private."},"target_collection_id":{"type":"string","description":"URL-safe base64 ID of a writable destination collection."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/svg/vectorize/ideogram-vector-1":{"post":{"operationId":"svgGenerate_post_vectorizer","summary":"Vectorizer","description":"Converts an image to SVG asynchronously.","tags":["svg-generate"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Conversion accepted; dry runs return the shared PriceQuote response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorizerResponse"}}}},"400":{"description":"Invalid source image or input combination.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Authentication required.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Access denied.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Source not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"503":{"description":"Conversion is unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"JPEG, PNG or WEBP source; at most 50 MB. Multipart only."},"image_asset_identifier":{"$ref":"#/components/schemas/AssetIdentifier"},"mode":{"$ref":"#/components/schemas/V2SvgVectorizeIdeogramVector1PostRequestBodyContentMultipartFormDataSchemaMode","default":"auto","description":"Simple uses fewer shapes; detailed preserves fine detail; auto chooses the level of detail that best suits the image."},"private":{"type":"boolean","description":"Outputs are private by default. Enterprise outputs are always private."},"target_collection_id":{"type":"string","description":"URL-safe base64 ID of a writable destination collection."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/tool/ad-localizer":{"post":{"operationId":"editWorkflow_post_ad_localizer","summary":"Ad Localizer","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","tags":["edit-workflow"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Ad localization accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdLocalizerResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to use Ad Localizer.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"An input asset was not found or is not readable.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The instruction did not pass prompt safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}}},"requestBody":{"description":"The source ad and the target language.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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"},"language":{"$ref":"#/components/schemas/V2ToolAdLocalizerPostRequestBodyContentMultipartFormDataSchemaLanguage","description":"The target language for the copy. Arabic is rendered right-to-left. Each request covers one language; send one request per language."},"exact_copy":{"type":"string","maxLength":4000,"description":"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."},"prompt":{"type":"string","maxLength":2000,"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."},"quality":{"$ref":"#/components/schemas/AdLocalizerQuality"},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"num_images":{"type":"integer","minimum":1,"maximum":4,"default":1,"description":"Number of localized variations to create for this language."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","language"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/tool/ad-resizer":{"post":{"operationId":"editWorkflow_post_ad_resizer","summary":"Ad Resizer","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`.","tags":["edit-workflow"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Ad resize accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdResizerResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to resize an ad.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Source asset not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt was rejected by safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}}},"requestBody":{"description":"The source creative, the target ad resolution, and optionally the platform whose safe zone the ad must stay inside.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The source creative to reframe (max size 25MB). JPEG, PNG, and\nWEBP formats are supported. Multipart requests only.\n"},"resolution":{"$ref":"#/components/schemas/V2ToolAdResizerPostRequestBodyContentMultipartFormDataSchemaResolution","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"},"platform":{"$ref":"#/components/schemas/V2ToolAdResizerPostRequestBodyContentMultipartFormDataSchemaPlatform","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"},"prompt":{"type":"string","description":"Optional edit instruction to apply while reframing, for example \"remove the logo\" or \"put the price bottom-right\"."},"quality":{"$ref":"#/components/schemas/AdResizerQuality"},"num_images":{"type":"integer","minimum":1,"maximum":4,"default":1,"description":"The number of reframed variations to generate."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","resolution"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/tool/ad-variations":{"post":{"operationId":"editWorkflow_post_ad_variations","summary":"Ad Variations","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","tags":["edit-workflow"],"responses":{"200":{"description":"Ad variation accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdVariationsResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to generate ad variations.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Source asset not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The prompt was rejected by safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}}},"requestBody":{"description":"The source creative and the variation axis.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","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"},"variation_type":{"$ref":"#/components/schemas/V2ToolAdVariationsPostRequestBodyContentMultipartFormDataSchemaVariationType","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"},"prompt":{"type":"string","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."},"quality":{"$ref":"#/components/schemas/AdVariationsQuality"},"num_images":{"type":"integer","minimum":1,"maximum":4,"default":1,"description":"The number of variations to generate along the requested axis."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","variation_type"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/tool/colorways":{"post":{"operationId":"editWorkflow_post_colorways","summary":"Colorways","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","tags":["edit-workflow"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Colorway accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ColorwaysResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to create a colorway.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}}},"requestBody":{"description":"The product photo, one mask or several masks marking the regions to recolor, and one target color per mask.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The product photo to recolor (max size 25MB). JPEG, PNG, and WEBP\nformats are supported.\n"},"masks":{"type":"array","items":{"type":"string","format":"binary"},"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"},"colors":{"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"description":"One target color per mask in `masks`, as six-digit hex codes like\n`#B3202C`, paired by position. The product's shape, construction,\nmaterials, prints, and logos are always preserved.\n"},"aspect_ratio":{"type":"string","pattern":"^(1:1|3:4|4:3|16:9|9:16)$","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"},"quality":{"$ref":"#/components/schemas/ColorwaysQuality"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","colors"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/tool/ghost-mannequin":{"post":{"operationId":"editWorkflow_post_ghost_mannequin","summary":"Ghost Mannequin","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","tags":["edit-workflow"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Ghost-mannequin generation accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GhostMannequinResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to create ghost-mannequin images.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"An input asset was not found or is not readable.","content":{"application/json":{"schema":{"description":"Any type"}}}},"413":{"description":"The combined raw image uploads exceed 100 MB.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The instruction did not pass prompt safety validation.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}}},"requestBody":{"description":"The garment photos and the requested output view.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"garment_images":{"type":"array","items":{"type":"string","format":"binary"},"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"},"front_image":{"type":"string","format":"binary","description":"Optional front-view garment photo, up to 50 MB. Multipart requests\nonly.\n"},"back_image":{"type":"string","format":"binary","description":"Optional back-view garment photo, up to 50 MB. Multipart requests\nonly.\n"},"left_image":{"type":"string","format":"binary","description":"Optional left-view garment photo, up to 50 MB. Multipart requests\nonly.\n"},"right_image":{"type":"string","format":"binary","description":"Optional right-view garment photo, up to 50 MB. Multipart requests\nonly.\n"},"top_image":{"type":"string","format":"binary","description":"Optional top-view garment photo, up to 50 MB. Multipart requests\nonly.\n"},"bottom_image":{"type":"string","format":"binary","description":"Optional bottom-view garment photo, up to 50 MB. Multipart\nrequests only.\n"},"output_reference_asset_identifier":{"$ref":"#/components/schemas/AssetIdentifier"},"output_reference_image":{"type":"string","format":"binary","description":"Optional presentation example, up to 50 MB. Multipart requests only.\nGuides pose, framing, and lighting without copying its garment,\ncolors, text, or branding. Garment photos remain authoritative for\nproduct identity; view and aspect_ratio take precedence, and the\nbackground remains white. Does not replace a required garment photo.\nMutually exclusive with `output_reference_asset_identifier`.\n"},"view":{"$ref":"#/components/schemas/V2ToolGhostMannequinPostRequestBodyContentMultipartFormDataSchemaView","description":"Camera view for the output garment."},"instruction":{"type":"string","maxLength":2000,"description":"Optional reconstruction guidance or identity-critical garment\ndetails to check against the photos. The output always uses a clean\nwhite studio background.\n"},"metadata":{"type":"string","maxLength":8000,"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"},"aspect_ratio":{"type":"string","pattern":"^(1:1|3:4|4:3|16:9|9:16)$","description":"Output aspect ratio. Defaults to `1:1` when omitted. Supported\nvalues are `1:1`, `3:4`, `4:3`, `16:9`, and `9:16`.\n"},"quality":{"$ref":"#/components/schemas/GhostMannequinQuality"},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Optional seed for repeatable results."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["view"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/tool/material-swap":{"post":{"operationId":"editWorkflow_post_material_swap","summary":"Material Swap","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","tags":["edit-workflow"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Material swap accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaterialSwapResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to create a material swap.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}}},"requestBody":{"description":"The product photo, one mask or several masks marking the regions to change, and either one shared material reference or one per mask.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The product photo to edit (max size 25MB). JPEG, PNG, and WEBP\nformats are supported.\n"},"masks":{"type":"array","items":{"type":"string","format":"binary"},"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"},"materials":{"type":"array","items":{"type":"string","format":"binary"},"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"},"aspect_ratio":{"type":"string","pattern":"^(1:1|3:4|4:3|16:9|9:16)$","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"},"quality":{"$ref":"#/components/schemas/MaterialSwapQuality"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/tool/model-pose-variants":{"post":{"operationId":"editWorkflow_post_model_pose_variants","summary":"Model Pose Variants","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","tags":["edit-workflow"],"responses":{"200":{"description":"Pose-variant generation accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelPoseVariantsResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to generate pose variants.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"An input asset was not found or is not readable.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The instruction did not pass prompt safety checks.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}}},"requestBody":{"description":"The fashion image to edit and the pose direction.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"source_image":{"type":"string","format":"binary","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"},"instruction":{"type":"string","minLength":1,"maxLength":4000,"description":"Plain-language pose or camera direction, such as a front-facing\ncatalog stance or right-facing walking profile.\n"},"aspect_ratio":{"type":"string","pattern":"^(1:1|3:4|4:3|16:9|9:16)$","description":"Output aspect ratio. When omitted, the nearest supported ratio is\nderived from the source image. Supported values are `1:1`, `3:4`,\n`4:3`, `16:9`, and `9:16`.\n"},"quality":{"$ref":"#/components/schemas/ModelPoseVariantsQuality"},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Optional seed for repeatable results."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"Number of pose variants to create."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["source_image","instruction"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/tool/sketch-to-render":{"post":{"operationId":"editWorkflow_post_sketch_to_render","summary":"Sketch to Render","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","tags":["edit-workflow"],"responses":{"200":{"description":"Sketch rendering accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SketchToRenderResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to render sketches.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The referenced sketch was not found or is not readable.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"The instruction did not pass prompt safety validation.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}}},"requestBody":{"description":"The source sketch and the material and rendering direction to apply.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"sketch_image":{"type":"string","format":"binary","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"},"instruction":{"type":"string","minLength":1,"maxLength":4000,"description":"Material and rendering direction, plus any construction or design\ndetails that are not legible in the sketch.\n"},"aspect_ratio":{"type":"string","pattern":"^(1:1|3:4|4:3|16:9|9:16)$","description":"Aspect ratio of each output image. Defaults to `1:1` when omitted."},"quality":{"$ref":"#/components/schemas/SketchToRenderQuality"},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Optional seed for repeatable results."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"Number of product renders to create."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["sketch_image","instruction"]}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/generations/{generation_id}":{"get":{"operationId":"generations_get_generation_v2","summary":"Poll a generation","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.","tags":["generations"],"parameters":[{"name":"generation_id","in":"path","description":"URL-safe base64 ID of the generation, as returned when the request was accepted.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Generation status retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationResponse"}}}},"400":{"description":"The generation ID is not a valid URL-safe base64 ID.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Not authorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Generation not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/account/api-keys":{"get":{"operationId":"account_get_account_api_keys","summary":"List API keys","description":"Lists the API keys in your organization. Key material is redacted —\nthe full key is only shown once, when it is created. Disabled and\narchived keys are included (see each key's `status`) 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.\n","tags":["account"],"responses":{"200":{"description":"The organization's API keys, redacted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAccountApiKeysResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"No organization with billing access was found for this credential.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/account/invoices":{"get":{"operationId":"account_get_account_invoices","summary":"List invoices","description":"Returns your organization's invoices with their line items — the\nbilling record your usage reports reconcile against. Amounts are\ndecimal strings in the invoice's currency.\n\nRequires an API key whose owner is an organization admin. Keys owned\nby other members receive a 404.\n","tags":["account"],"responses":{"200":{"description":"The organization's invoices. Empty when no billing history exists yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAccountInvoicesResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"No organization with billing access was found for this credential.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/account/usage":{"get":{"operationId":"account_get_account_usage","summary":"Get usage and spend","description":"Returns your organization's billed API usage as dense time buckets of\nline items. Every line item carries the billed dollar amount; products\nbilled per item also carry `billed_units` (unit, quantity, and unit\nprice, where `quantity × unit_price = cost_total`). Usage-priced\nproducts (billed by metered provider usage) report `cost_total` only.\n\nBuckets cover the requested range completely — a bucket with no line\nitems means no billed usage in that window. Line items are unique per\nbucket on (`product`, `dimensions`, `api_key.id`, unit price). Usage\nbilled without an API key (requests authenticated as a user session)\nis included with `api_key` absent, so totals always reconcile with\nyour invoices.\n`product` and `endpoint` are stable identifiers safe to aggregate on;\n`description` 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.\n","tags":["account"],"parameters":[{"name":"start_time","in":"query","description":"Start of the reporting range (RFC 3339). Snapped down to the containing bucket boundary (UTC).","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"end_time","in":"query","description":"End of the reporting range (RFC 3339), exclusive. Snapped up to the next bucket boundary (UTC). Defaults to now.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"bucket_width","in":"query","description":"Bucket granularity. `1d` allows ranges up to 92 days per request; `1h` allows up to 168 hours. Page through longer histories by moving `start_time` back across successive requests.","required":false,"schema":{"$ref":"#/components/schemas/V2AccountUsageGetParametersBucketWidth","default":"1d"}},{"name":"sources","in":"query","description":"Which billing sources to include. `api` is usage from API requests; `app` is web-app usage, attributed to the member who generated it. Defaults to both, so report totals reconcile with invoices.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/V2AccountUsageGetParametersSourcesSchemaItems"},"default":["api","app"]}}],"responses":{"200":{"description":"Bucketed usage for the requested range.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountUsageResponse"}}}},"400":{"description":"Invalid time range, bucket width, or filters.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"No organization with billing access was found for this credential.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v2/image/replace-background/ideogram-4-5":{"post":{"operationId":"tool_replaceBackgroundIdeogram45","summary":"Replace background with Ideogram 4.5","description":"Rebuild the background of an image as the setting shown in a\n`background_reference` image, with Ideogram 4.5 at its highest\nquality. The people in the source image are kept, people in the\nreference are left out, and results keep the source image's aspect\nratio. Returns a `generation_id`; poll\n`GET /v2/generations/{generation_id}` or supply a `webhook_url`.\n","tags":["tool"],"parameters":[{"name":"dry_run","in":"query","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","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Background replacement accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceBackgroundResponse"}}}},"400":{"description":"Invalid input provided.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"description":"Any type"}}}},"402":{"description":"Insufficient credits or quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"403":{"description":"Not authorized to replace backgrounds.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"An image was not found or is not readable.","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationErrorResponse"}}}},"503":{"description":"Background replacement is temporarily unavailable.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The source image and the background reference.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"The source image. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and\nMPO are supported, up to 50 MB. Its longer side may be at most the\nmodel's maximum aspect ratio times its shorter side; a more extreme\nproportion is rejected with a 400 that states the allowed range.\nMultipart requests only.\n"},"background_reference":{"type":"string","format":"binary","description":"A photo of the setting the new background should match. Its people\nare not copied. It is held to the same aspect-ratio limit as\n`image`. Multipart requests only.\n"},"num_images":{"type":"integer","minimum":1,"maximum":4,"default":1,"description":"The number of images to generate."},"private":{"type":"boolean","description":"Whether to keep the result private. When omitted, the result is\nprivate. Enterprise generations are always private.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["image","background_reference"]}}}},"security":[{"ApiKeyAuth":[]}]}}},"tags":[{"name":"images-precise-edit"},{"name":"auto-model"},{"name":"images-generate"},{"name":"images-remix"},{"name":"images-inpaint"},{"name":"reframe"},{"name":"tools"},{"name":"images-upscale"},{"name":"tool"},{"name":"object-removal"},{"name":"image-describe"},{"name":"design"},{"name":"video-generate"},{"name":"video-edit"},{"name":"svg-generate"},{"name":"edit-workflow"},{"name":"generations"},{"name":"account"}],"servers":[{"url":"https://api.ideogram.ai","description":"https://api.ideogram.ai"}],"components":{"schemas":{"V2ImagePreciseEditIdeogram45PostRequestBodyContentMultipartFormDataSchemaQuality":{"type":"string","enum":["very_low","low","medium","high"],"default":"medium","description":"The rendering quality to use. `very_low` is the fastest and cheapest, and `high` takes longer and is priced higher. This is the only field that affects the price: the size of the image you send does not change it, and neither does `context_window`.","title":"V2ImagePreciseEditIdeogram45PostRequestBodyContentMultipartFormDataSchemaQuality"},"GenerationKind":{"type":"string","enum":["sampling","workflow"],"description":"The kind of generation identified by generation_id. Both kinds can be polled through GET /v2/generations/{generation_id}.","title":"GenerationKind"},"GeneratedImageObject":{"type":"object","properties":{"url":{"type":["string","null"],"format":"uri","description":"The direct link to the generated image. Empty when the image did not pass safety checks."},"prompt":{"type":"string","description":"The final prompt the image was generated from."},"resolution":{"type":"string","description":"The resolution of the generated image, formatted as \"WIDTHxHEIGHT\"."},"is_image_safe":{"type":"boolean","description":"Whether the image passed safety checks. If false, `url` is empty."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["prompt","resolution","is_image_safe","seed"],"description":"One generated output image.","title":"GeneratedImageObject"},"PreciseEditImageIdeogram45Response":{"type":"object","properties":{"generation_kind":{"$ref":"#/components/schemas/GenerationKind"},"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The edited images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","description":"The seed that was used, including when you did not set one."}},"required":["generation_kind"],"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","title":"PreciseEditImageIdeogram45Response"},"GenerationRejectReason":{"type":"string","enum":["insufficient_funds","subscription_required","daily_limit","priority_credit_required","inflight_limit","feature_limit"],"description":"The account or usage limit that rejected a generation request.","title":"GenerationRejectReason"},"GenerationErrorResponseTaskCompletionSpeed":{"type":"string","enum":["fast","slow"],"description":"The queue this request resolved to. Present when `reject_reason`\nis `inflight_limit`.\n","title":"GenerationErrorResponseTaskCompletionSpeed"},"GenerationErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"A message describing why the generation request was rejected."},"reject_reason":{"$ref":"#/components/schemas/GenerationRejectReason"},"max_inflight_requests":{"type":"integer","minimum":1,"description":"How many generations the account may have in progress at once on\nthe queue this request resolved to. Present when `reject_reason`\nis `inflight_limit`.\n"},"task_completion_speed":{"$ref":"#/components/schemas/GenerationErrorResponseTaskCompletionSpeed","description":"The queue this request resolved to. Present when `reject_reason`\nis `inflight_limit`.\n"}},"required":["error","reject_reason"],"description":"A generation request rejected by an account or usage limit.","title":"GenerationErrorResponse"},"V2ImageGenerateAutoPostRequestBodyContentMultipartFormDataSchemaResolutionTier":{"type":"string","enum":["1k","2k","4k"],"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.","title":"V2ImageGenerateAutoPostRequestBodyContentMultipartFormDataSchemaResolutionTier"},"MagicPromptMode":{"type":"string","enum":["auto","on","off"],"description":"Determine if MagicPrompt should be used in generating the request or not.","title":"MagicPromptMode"},"GenerateImageV2AutoResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageV2AutoResponse"},"V2ImageGenerateIdeogram45PostRequestBodyContentMultipartFormDataSchemaBackground":{"type":"string","enum":["auto","transparent","opaque"],"default":"auto","description":"The output background. `transparent` returns images with an alpha channel, `opaque` returns a solid one, and `auto` decides for you.","title":"V2ImageGenerateIdeogram45PostRequestBodyContentMultipartFormDataSchemaBackground"},"V2ImageGenerateIdeogram45PostRequestBodyContentMultipartFormDataSchemaQuality":{"type":"string","enum":["very_low","low","medium","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.","title":"V2ImageGenerateIdeogram45PostRequestBodyContentMultipartFormDataSchemaQuality"},"GenerateImageIdeogram45Response":{"type":"object","properties":{"generation_kind":{"$ref":"#/components/schemas/GenerationKind"},"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_kind","generation_id","seed"],"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","title":"GenerateImageIdeogram45Response"},"ResolutionV4":{"type":"string","enum":["2048x2048","1440x2880","2880x1440","1664x2496","2496x1664","1792x2240","2240x1792","1440x2560","2560x1440","1600x2560","2560x1600","1728x2304","2304x1728","1296x3168","3168x1296","1152x2944","2944x1152","1248x3328","3328x1248","1280x3072","3072x1280","1024x3072","3072x1024","1024x1024","896x1120","1120x896","864x1152","1152x864","832x1248","1248x832","800x1280","1280x800","720x1280","1280x720","720x1440","1440x720","512x1536","1536x512"],"description":"The 1K and 2K resolutions supported for Ideogram 4.0 image generation.","title":"ResolutionV4"},"GenerateImageIdeogramV4RequestRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"GenerateImageIdeogramV4RequestRenderingSpeed"},"GenerateImageIdeogramV4Request":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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 unless `magic_prompt` is `on`.\n"},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","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 it into a structured\nprompt. A valid structured JSON prompt skips magic prompt unless\n`magic_prompt` is `on`.\n"},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"resolution":{"$ref":"#/components/schemas/ResolutionV4","description":"Optional. When supplied, the images are generated at this\nresolution. When omitted, an aspect ratio is picked automatically\nbased on the prompt.\n"},"rendering_speed":{"$ref":"#/components/schemas/GenerateImageIdeogramV4RequestRenderingSpeed","default":"default","description":"The rendering speed to use."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"title":"GenerateImageIdeogramV4Request"},"GenerateImageIdeogramV4Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageIdeogramV4Response"},"GenerateImageIdeogramV4CustomModelRequestRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"description":"The rendering speed to use. When omitted, a speed supported by the custom model is used.","title":"GenerateImageIdeogramV4CustomModelRequestRenderingSpeed"},"GenerateImageIdeogramV4CustomModelRequest":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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 unless `magic_prompt` is `on`.\n"},"custom_model_uri":{"type":"string","pattern":"^model/[^/]+/version/[^/]+$","minLength":1,"maxLength":512,"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."},"transparent_background":{"type":"boolean","default":false,"description":"Remove the background after generation and return transparent PNG images. Included in the custom model generation price at no extra charge. When false, the model's automatic background removal behavior still applies."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","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 it into a structured\nprompt. A valid structured JSON prompt skips magic prompt unless\n`magic_prompt` is `on`.\n"},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"resolution":{"$ref":"#/components/schemas/ResolutionV4","description":"Optional. When supplied, the images are generated at this\nresolution. When omitted, an aspect ratio is picked automatically\nbased on the prompt.\n"},"rendering_speed":{"$ref":"#/components/schemas/GenerateImageIdeogramV4CustomModelRequestRenderingSpeed","description":"The rendering speed to use. When omitted, a speed supported by the custom model is used."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt","custom_model_uri"],"title":"GenerateImageIdeogramV4CustomModelRequest"},"GenerateImageIdeogramV4CustomModelResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageIdeogramV4CustomModelResponse"},"IdeogramV4AspectRatio":{"type":"string","enum":["auto","1x4","1x3","1x2","9x16","10x16","2x3","3x4","4x5","1x1","5x4","4x3","3x2","16x10","16x9","2x1","3x1","4x1"],"default":"auto","description":"Supported output aspect ratios. The operation defines whether `auto`\npreserves the source shape or selects a shape from the prompt.\n","title":"IdeogramV4AspectRatio"},"GenerateImageIdeogramV4TransparentRequestOutputResolution":{"type":"string","enum":["1k","2k","4k","8k"],"default":"1k","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","title":"GenerateImageIdeogramV4TransparentRequestOutputResolution"},"GenerateImageIdeogramV4TransparentRequestRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"GenerateImageIdeogramV4TransparentRequestRenderingSpeed"},"GenerateImageIdeogramV4TransparentRequest":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"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"},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","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 it into a structured\nprompt. A valid structured JSON prompt skips magic prompt unless\n`magic_prompt` is `on`.\n"},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"aspect_ratio":{"$ref":"#/components/schemas/IdeogramV4AspectRatio","default":"auto"},"output_resolution":{"$ref":"#/components/schemas/GenerateImageIdeogramV4TransparentRequestOutputResolution","default":"1k","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"},"rendering_speed":{"$ref":"#/components/schemas/GenerateImageIdeogramV4TransparentRequestRenderingSpeed","default":"default","description":"The rendering speed to use."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"title":"GenerateImageIdeogramV4TransparentRequest"},"GenerateImageIdeogramV4TransparentResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageIdeogramV4TransparentResponse"},"ResolutionV3":{"type":"string","enum":["512x1536","576x1408","576x1472","576x1536","640x1344","640x1408","640x1472","640x1536","704x1152","704x1216","704x1280","704x1344","704x1408","704x1472","736x1312","768x1088","768x1216","768x1280","768x1344","800x1280","832x960","832x1024","832x1088","832x1152","832x1216","832x1248","864x1152","896x960","896x1024","896x1088","896x1120","896x1152","960x832","960x896","960x1024","960x1088","1024x832","1024x896","1024x960","1024x1024","1088x768","1088x832","1088x896","1088x960","1120x896","1152x704","1152x832","1152x864","1152x896","1216x704","1216x768","1216x832","1248x832","1280x704","1280x768","1280x800","1312x736","1344x640","1344x704","1344x768","1408x576","1408x640","1408x704","1472x576","1472x640","1472x704","1536x512","1536x576","1536x640"],"description":"The resolutions supported for Ideogram 3.0.","title":"ResolutionV3"},"IdeogramV3AspectRatio":{"type":"string","enum":["auto","1x3","3x1","1x2","2x1","9x16","16x9","10x16","16x10","2x3","3x2","3x4","4x3","4x5","5x4","1x1"],"description":"The aspect ratio for an Ideogram 3.x or 2.x generation. `auto` lets the\nmodel select a ratio from the prompt; any other value pins the ratio.\nCannot be combined with `resolution`. Omitting the field is not `auto`:\nit uses `1x1`.\n","title":"IdeogramV3AspectRatio"},"V2ImageGenerateIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"V2ImageGenerateIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"IdeogramColorPalettePresetName":{"type":"string","enum":["ember","fresh","jungle","magic","melon","mosaic","pastel","ultramarine"],"description":"A color palette preset value.","title":"IdeogramColorPalettePresetName"},"IdeogramColorPaletteWithPresetName":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/IdeogramColorPalettePresetName"}},"required":["name"],"description":"A color palette specified only via its name. Cannot be used in conjunction with members.","title":"IdeogramColorPaletteWithPresetName"},"ColorPaletteMember":{"type":"object","properties":{"color_hex":{"type":"string","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","description":"The hexadecimal representation of the color with an optional chosen weight."},"color_weight":{"type":"number","format":"double","minimum":0.05,"maximum":1,"description":"The weight of the color in the color palette."}},"required":["color_hex"],"description":"A member of a color palette.","title":"ColorPaletteMember"},"ColorPaletteWithMembers":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/ColorPaletteMember"},"description":"A list of ColorPaletteMembers that define the color palette. Each color palette member\nconsists of a required color hex and an optional weight between 0.05 and 1.0 (inclusive).\nIt is recommended that these weights descend from highest to lowest for the color hexes provided.\n"}},"required":["members"],"description":"A color palette represented only via its members. Cannot be used in conjunction with preset name.","title":"ColorPaletteWithMembers"},"IdeogramColorPalette":{"oneOf":[{"$ref":"#/components/schemas/IdeogramColorPaletteWithPresetName"},{"$ref":"#/components/schemas/ColorPaletteWithMembers"}],"description":"A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members).","title":"IdeogramColorPalette"},"StyleCode":{"type":"string","pattern":"^[0-9a-fA-F]{8}$","description":"The 8 character hexadecimal representation of the style code.","title":"StyleCode"},"IdeogramV3StyleType":{"type":"string","enum":["auto","general","realistic","design","custom","fiction","stylized"],"default":"general","description":"The style type to generate with.","title":"IdeogramV3StyleType"},"IdeogramV3StylePreset":{"type":"string","enum":["80s_illustration","90s_nostalgia","abstract_organic","analog_nostalgia","art_brut","art_deco","art_poster","aura","avant_garde","bauhaus","blueprint","blurry_motion","bright_art","c4d_cartoon","childrens_book","collage","coloring_book_i","coloring_book_ii","cubism","dark_aura","doodle","double_exposure","dramatic_cinema","editorial","emotional_minimal","ethereal_party","expired_film","flat_art","flat_vector","forest_reverie","geo_minimalist","glass_prism","golden_hour","graffiti_i","graffiti_ii","halftone_print","high_contrast","hippie_era","iconic","japandi_fusion","jazzy","long_exposure","magazine_editorial","minimal_illustration","mixed_media","monochrome","nightlife","oil_painting","old_cartoons","paint_gesture","pop_art","retro_etching","riviera_pop","spotlight_80s","stylized_red","surreal_collage","travel_poster","vintage_geo","vintage_poster","watercolor","weird","woodblock_print"],"description":"A predefined style preset that applies a specific artistic style to the generated image.","title":"IdeogramV3StylePreset"},"GenerateImageIdeogramV3Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageIdeogramV3Response"},"V2ImageGenerateIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"V2ImageGenerateIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"V2ImageGenerateIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaStyleType":{"type":"string","enum":["auto","realistic","fiction"],"default":"auto","description":"The style type to generate the character with. Defaults to `auto`.","title":"V2ImageGenerateIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaStyleType"},"GenerateImageIdeogramV3CharacterResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageIdeogramV3CharacterResponse"},"V2ImageGenerateIdeogram3CustomModelPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"description":"The rendering speed to use. When omitted, a speed supported by the custom model is used.","title":"V2ImageGenerateIdeogram3CustomModelPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"GenerateImageIdeogramV3CustomModelResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageIdeogramV3CustomModelResponse"},"GenerateImageIdeogramV3TransparentRequestUpscaleFactor":{"type":"string","enum":["x1","x2","x4"],"default":"x1","description":"Optional enhancement factor applied after generation. `x1` (the default) delivers the base render.","title":"GenerateImageIdeogramV3TransparentRequestUpscaleFactor"},"GenerateImageIdeogramV3TransparentRequestRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"GenerateImageIdeogramV3TransparentRequestRenderingSpeed"},"GenerateImageIdeogramV3TransparentRequest":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt to generate images from."},"negative_prompt":{"type":"string","maxLength":10000,"description":"Description of what to exclude from the images. The prompt takes precedence over the negative prompt."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"upscale_factor":{"$ref":"#/components/schemas/GenerateImageIdeogramV3TransparentRequestUpscaleFactor","default":"x1","description":"Optional enhancement factor applied after generation. `x1` (the default) delivers the base render."},"aspect_ratio":{"$ref":"#/components/schemas/IdeogramV3AspectRatio"},"rendering_speed":{"$ref":"#/components/schemas/GenerateImageIdeogramV3TransparentRequestRenderingSpeed","default":"default","description":"The rendering speed to use."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"title":"GenerateImageIdeogramV3TransparentRequest"},"GenerateImageIdeogramV3TransparentResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageIdeogramV3TransparentResponse"},"GenerateImageIdeogramV2ARequestRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use. `turbo` generates faster at a lower cost, while `quality` prioritizes the highest-quality result.","title":"GenerateImageIdeogramV2ARequestRenderingSpeed"},"IdeogramV2StyleType":{"type":"string","enum":["auto","general","realistic","design","render_3d","anime"],"description":"The style type to generate with. When omitted, the model's default styling is used; pass `auto` to have a style selected automatically from the prompt.","title":"IdeogramV2StyleType"},"GenerateImageIdeogramV2ARequest":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt to generate images from."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"aspect_ratio":{"$ref":"#/components/schemas/IdeogramV3AspectRatio"},"rendering_speed":{"$ref":"#/components/schemas/GenerateImageIdeogramV2ARequestRenderingSpeed","default":"default","description":"The rendering speed to use. `turbo` generates faster at a lower cost, while `quality` prioritizes the highest-quality result."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"style_type":{"$ref":"#/components/schemas/IdeogramV2StyleType"},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"title":"GenerateImageIdeogramV2ARequest"},"GenerateImageIdeogramV2AResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageIdeogramV2AResponse"},"GenerateImageIdeogramV2RequestRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use. `turbo` generates faster at a lower cost, while `quality` prioritizes the highest-quality result.","title":"GenerateImageIdeogramV2RequestRenderingSpeed"},"GenerateImageIdeogramV2Request":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt to generate images from."},"negative_prompt":{"type":"string","maxLength":10000,"description":"Description of what to exclude from the images. The prompt takes precedence over the negative prompt."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"aspect_ratio":{"$ref":"#/components/schemas/IdeogramV3AspectRatio"},"rendering_speed":{"$ref":"#/components/schemas/GenerateImageIdeogramV2RequestRenderingSpeed","default":"default","description":"The rendering speed to use. `turbo` generates faster at a lower cost, while `quality` prioritizes the highest-quality result."},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). Defaults to `auto`."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"style_type":{"$ref":"#/components/schemas/IdeogramV2StyleType"},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"title":"GenerateImageIdeogramV2Request"},"GenerateImageIdeogramV2Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageIdeogramV2Response"},"V2ImageGenerateGptImage25FlarePostRequestBodyContentMultipartFormDataSchemaBackground":{"type":"string","enum":["auto","transparent","opaque"],"default":"auto","description":"The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt.","title":"V2ImageGenerateGptImage25FlarePostRequestBodyContentMultipartFormDataSchemaBackground"},"V2ImageGenerateGptImage25FlarePostRequestBodyContentMultipartFormDataSchemaQuality":{"type":"string","enum":["auto","low","medium","high"],"default":"auto","description":"How much rendering effort the model spends. Lower tiers return sooner and cost less; `auto` lets the model choose, which it currently renders at `high`.","title":"V2ImageGenerateGptImage25FlarePostRequestBodyContentMultipartFormDataSchemaQuality"},"GenerateImageGptImage25FlareResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageGptImage25FlareResponse"},"V2ImageGenerateGptImage25SunburstPostRequestBodyContentMultipartFormDataSchemaBackground":{"type":"string","enum":["auto","transparent","opaque"],"default":"auto","description":"The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt.","title":"V2ImageGenerateGptImage25SunburstPostRequestBodyContentMultipartFormDataSchemaBackground"},"V2ImageGenerateGptImage25SunburstPostRequestBodyContentMultipartFormDataSchemaQuality":{"type":"string","enum":["auto","low","medium","high"],"default":"auto","description":"How much rendering effort the model spends. Lower tiers return sooner and cost less; `auto` lets the model choose, which it currently renders at `high`.","title":"V2ImageGenerateGptImage25SunburstPostRequestBodyContentMultipartFormDataSchemaQuality"},"GenerateImageGptImage25SunburstResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageGptImage25SunburstResponse"},"GenerateImageGptImage2Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageGptImage2Response"},"NanoBanana2AspectRatio":{"type":"string","enum":["auto","1:1","3:2","2:3","4:3","3:4","5:4","4:5","16:9","9:16","21:9","4:1","1:4","8:1","1:8"],"default":"auto","description":"Output aspect ratios Nano Banana 2 serves. `auto` lets the model choose the shape; an edit keeps its source image's shape.","title":"NanoBanana2AspectRatio"},"V2ImageGenerateNanoBanana2PostRequestBodyContentMultipartFormDataSchemaResolutionTier":{"type":"string","enum":["1K","2K","4K"],"default":"1K","description":"The output resolution tier.","title":"V2ImageGenerateNanoBanana2PostRequestBodyContentMultipartFormDataSchemaResolutionTier"},"GenerateImageNanoBanana2Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageNanoBanana2Response"},"NanoBanana21AspectRatio":{"type":"string","enum":["auto","1:1","3:2","2:3","4:3","3:4","5:4","4:5","16:9","9:16","21:9","4:1","1:4","8:1","1:8"],"default":"auto","description":"Output aspect ratios Nano Banana 2.1 serves. `auto` lets the model choose the shape; an edit keeps its source image's shape.","title":"NanoBanana21AspectRatio"},"V2ImageGenerateNanoBanana21PostRequestBodyContentMultipartFormDataSchemaResolutionTier":{"type":"string","enum":["1K","2K","4K"],"default":"1K","description":"The output resolution tier.","title":"V2ImageGenerateNanoBanana21PostRequestBodyContentMultipartFormDataSchemaResolutionTier"},"GenerateImageNanoBanana21Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"description":"Response returned by `POST /v2/image/generate/nano-banana-2-1`.\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","title":"GenerateImageNanoBanana21Response"},"NanoBananaProAspectRatio":{"type":"string","enum":["auto","1:1","3:2","2:3","4:3","3:4","5:4","4:5","16:9","9:16","21:9"],"default":"auto","description":"Output aspect ratios Nano Banana Pro serves. `auto` lets the model choose the shape; an edit keeps its source image's shape.","title":"NanoBananaProAspectRatio"},"V2ImageGenerateNanoBananaProPostRequestBodyContentMultipartFormDataSchemaResolutionTier":{"type":"string","enum":["1K","2K","4K"],"default":"1K","description":"The output resolution tier.","title":"V2ImageGenerateNanoBananaProPostRequestBodyContentMultipartFormDataSchemaResolutionTier"},"GenerateImageNanoBananaProResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageNanoBananaProResponse"},"GenerationQuality":{"type":"string","enum":["very_low","low","medium","high","very_high"],"description":"The generation quality level. Higher levels may use more inference steps\nor additional prompt processing. `very_high` has noticeably higher latency\nand cost than the other levels.\n","title":"GenerationQuality"},"GenerateImagePImageIdeogramRequestResolution":{"type":"string","enum":["1k","2k"],"description":"The output size tier. Defaults to `1k`. Cannot be combined with `custom_width`/`custom_height`.","title":"GenerateImagePImageIdeogramRequestResolution"},"AspectRatioV3":{"type":"string","enum":["1x3","3x1","1x2","2x1","9x16","16x9","10x16","16x10","2x3","3x2","3x4","4x3","4x5","5x4","1x1"],"description":"Output aspect ratio. Cannot be combined with resolution. Generation defaults to 1x1; remix keeps the source ratio when both fields are omitted.","title":"AspectRatioV3"},"GenerateImagePImageIdeogramRequest":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt to generate images from, in natural language or as a\nstructured Ideogram 4.0 JSON prompt.\n"},"magic_prompt":{"$ref":"#/components/schemas/MagicPromptMode","default":"auto","description":"Controls magic prompt (automatic prompt rewriting). `off` disables magic prompt entirely. Defaults to `auto`."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"quality":{"$ref":"#/components/schemas/GenerationQuality","default":"medium","description":"The generation quality level. Defaults to `medium`."},"resolution":{"oneOf":[{"$ref":"#/components/schemas/GenerateImagePImageIdeogramRequestResolution"},{"type":"null"}],"description":"The output size tier. Defaults to `1k`. Cannot be combined with `custom_width`/`custom_height`."},"aspect_ratio":{"$ref":"#/components/schemas/AspectRatioV3","default":"1x1","description":"The output aspect ratio. Defaults to `1x1`."},"custom_width":{"type":["integer","null"],"description":"Optional. An exact output width in pixels, used together with\n`custom_height` for output sizes outside the preset tiers. Must\nbe a positive multiple of 16 between 16 and 4096, and\n`custom_width` × `custom_height` must not exceed 4,194,304 pixels\n(2048×2048). Cannot be combined with `resolution` or\n`aspect_ratio`; the request is billed at the resolution tier\nmatching its total pixel count.\n"},"custom_height":{"type":["integer","null"],"description":"Optional. An exact output height in pixels, used together with\n`custom_width`. See `custom_width` for the accepted range and\nbilling behavior.\n"},"enable_copyright_detection":{"type":["boolean","null"],"description":"Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned with `is_image_safe: false`."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"title":"GenerateImagePImageIdeogramRequest"},"GenerateImagePImageIdeogramResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImagePImageIdeogramResponse"},"GenerateImageZImageRequest":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":10000,"description":"The prompt to generate images from."},"resolution":{"type":["string","null"],"description":"Exact output resolution, formatted as \"WIDTHxHEIGHT\". Each side must be a positive multiple of 16 and the total area must not exceed 1,048,576 pixels (1024×1024). When omitted, the model's default 1024×1024 is used."},"num_inference_steps":{"type":["integer","null"],"minimum":1,"maximum":128,"description":"Optional number of diffusion steps. When omitted, the model's\ndefault is used. Higher values improve quality but take longer.\n"},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"num_images":{"type":"integer","minimum":1,"maximum":8,"default":1,"description":"The number of images to generate."},"async":{"type":"boolean","default":false,"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."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"title":"GenerateImageZImageRequest"},"GenerateImageZImageResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The generated images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"GenerateImageZImageResponse"},"V2ImageRemixAutoPostRequestBodyContentMultipartFormDataSchemaResolutionTier":{"type":"string","enum":["1k","2k"],"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.","title":"V2ImageRemixAutoPostRequestBodyContentMultipartFormDataSchemaResolutionTier"},"Seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation.","title":"Seed"},"ToolRemixResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The remixed images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"$ref":"#/components/schemas/Seed","description":"The seed attached to the request. Reusing it does not guarantee a reproducible result, because the selected model may not honor seeds."}},"required":["generation_id","seed"],"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","title":"ToolRemixResponse"},"V2ImageRemixIdeogram4PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"V2ImageRemixIdeogram4PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"RemixedImageObject":{"type":"object","properties":{"url":{"type":["string","null"],"format":"uri","description":"The direct link to the remixed image. Empty when the image did not pass safety checks."},"prompt":{"type":"string","description":"The final prompt the image was generated from."},"resolution":{"type":"string","description":"The resolution of the remixed image, formatted as \"WIDTHxHEIGHT\"."},"is_image_safe":{"type":"boolean","description":"Whether the image passed safety checks. If false, `url` is empty."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["prompt","resolution","is_image_safe","seed"],"description":"One remixed output image.","title":"RemixedImageObject"},"RemixImageIdeogramV4Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RemixedImageObject"},"description":"The remixed images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"RemixImageIdeogramV4Response"},"V2ImageRemixIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"V2ImageRemixIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"RemixImageIdeogramV3Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RemixedImageObject"},"description":"The remixed images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"RemixImageIdeogramV3Response"},"V2ImageRemixIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"V2ImageRemixIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"V2ImageRemixIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaStyleType":{"type":"string","enum":["auto","realistic","fiction"],"default":"auto","description":"The style type to remix the character with. Defaults to `auto`.","title":"V2ImageRemixIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaStyleType"},"RemixImageIdeogramV3CharacterResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RemixedImageObject"},"description":"The remixed images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"RemixImageIdeogramV3CharacterResponse"},"V2ImageRemixIdeogram3CustomModelPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"description":"The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model.","title":"V2ImageRemixIdeogram3CustomModelPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"RemixImageIdeogramV3CustomModelResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RemixedImageObject"},"description":"The remixed images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"RemixImageIdeogramV3CustomModelResponse"},"V2ImageInpaintIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"V2ImageInpaintIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"InpaintedImageObject":{"type":"object","properties":{"url":{"type":["string","null"],"format":"uri","description":"The direct link to the repainted image. Empty when the image did not pass safety checks."},"prompt":{"type":"string","description":"The final prompt the image was generated from."},"resolution":{"type":"string","description":"The resolution of the repainted image, formatted as \"WIDTHxHEIGHT\"."},"is_image_safe":{"type":"boolean","description":"Whether the image passed safety checks. If false, `url` is empty."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["prompt","resolution","is_image_safe","seed"],"description":"One repainted output image.","title":"InpaintedImageObject"},"InpaintImageIdeogramV3Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InpaintedImageObject"},"description":"The repainted images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The output width in pixels this request resolved to."},"height":{"type":"integer","description":"The output height in pixels this request resolved to."}},"required":["generation_id","seed","width","height"],"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","title":"InpaintImageIdeogramV3Response"},"V2ImageInpaintIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"V2ImageInpaintIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"V2ImageInpaintIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaStyleType":{"type":"string","enum":["auto","realistic","fiction"],"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 (not both) require `auto`. For API-key callers, combining a style with a character requires that feature to be enabled for their account.","title":"V2ImageInpaintIdeogram3CharacterPostRequestBodyContentMultipartFormDataSchemaStyleType"},"InpaintImageIdeogramV3CharacterResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InpaintedImageObject"},"description":"The repainted images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The output width in pixels this request resolved to."},"height":{"type":"integer","description":"The output height in pixels this request resolved to."}},"required":["generation_id","seed","width","height"],"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","title":"InpaintImageIdeogramV3CharacterResponse"},"V2ImageInpaintIdeogram3CustomModelPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"description":"The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model.","title":"V2ImageInpaintIdeogram3CustomModelPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"InpaintImageIdeogramV3CustomModelResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID accepted by the generation polling endpoint."},"data":{"type":"array","items":{"$ref":"#/components/schemas/InpaintedImageObject"},"description":"The repainted images, in generation order. Present only for synchronous requests."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The output width in pixels."},"height":{"type":"integer","description":"The output height in pixels."}},"required":["generation_id","seed","width","height"],"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","title":"InpaintImageIdeogramV3CustomModelResponse"},"V2ImageReframeIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","title":"V2ImageReframeIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"ReframeImageIdeogramV3Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedImageObject"},"description":"The reframed images, in generation order. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"ReframeImageIdeogramV3Response"},"NanoBanana2ReframeAspectRatio":{"type":"string","enum":["1:1","3:2","2:3","4:3","3:4","5:4","4:5","16:9","9:16","21:9","4:1","1:4","8:1","1:8"],"description":"Aspect ratios Nano Banana 2 can reframe an image to.","title":"NanoBanana2ReframeAspectRatio"},"ReframeImageNanoBanana2Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n"},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The resolved 1K output width in pixels."},"height":{"type":"integer","description":"The resolved 1K output height in pixels."}},"required":["generation_id","seed","width","height"],"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","title":"ReframeImageNanoBanana2Response"},"V2ImageUpscaleAutoPostRequestBodyContentMultipartFormDataSchemaUpscaleFactor":{"type":"string","enum":["x2","x4","x8"],"default":"x2","description":"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.","title":"V2ImageUpscaleAutoPostRequestBodyContentMultipartFormDataSchemaUpscaleFactor"},"UpscaleImageObject":{"type":"object","properties":{"url":{"type":["string","null"],"format":"uri","description":"The direct link to the upscaled image. Empty when the image did not pass safety checks."},"resolution":{"type":"string","description":"The resolution of the upscaled image, formatted as \"WIDTHxHEIGHT\"."},"is_image_safe":{"type":"boolean","description":"Whether the image passed safety checks. If false, `url` is empty."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["resolution","is_image_safe","seed"],"description":"One upscaled output image.","title":"UpscaleImageObject"},"UpscaleToolResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UpscaleImageObject"},"description":"The upscaled image. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The output width in pixels."},"height":{"type":"integer","description":"The output height in pixels."}},"required":["generation_id","seed","width","height"],"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","title":"UpscaleToolResponse"},"V2ImageUpscaleNanoBananaProPostRequestBodyContentMultipartFormDataSchemaResolutionTier":{"type":"string","enum":["1K","2K","4K"],"default":"2K","description":"The output resolution tier. The model sizes its output by tier at the source image's aspect ratio; exact pixel dimensions cannot be requested. Rejected when the source is already at or above the requested tier. Defaults to \"2K\".","title":"V2ImageUpscaleNanoBananaProPostRequestBodyContentMultipartFormDataSchemaResolutionTier"},"UpscaleImageNanoBananaProResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UpscaleImageObject"},"description":"The upscaled image. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The output width in pixels."},"height":{"type":"integer","description":"The output height in pixels."}},"required":["generation_id","seed","width","height"],"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","title":"UpscaleImageNanoBananaProResponse"},"V2ImageUpscaleTopazBloom2PostRequestBodyContentMultipartFormDataSchemaUpscaleFactor":{"type":"string","enum":["x2","x4","x8"],"default":"x2","description":"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.","title":"V2ImageUpscaleTopazBloom2PostRequestBodyContentMultipartFormDataSchemaUpscaleFactor"},"UpscaleImageTopazBloom2Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UpscaleImageObject"},"description":"The upscaled image. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The output width in pixels."},"height":{"type":"integer","description":"The output height in pixels."}},"required":["generation_id","seed","width","height"],"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","title":"UpscaleImageTopazBloom2Response"},"V2ImageUpscaleTopazRedefinePostRequestBodyContentMultipartFormDataSchemaUpscaleFactor":{"type":"string","enum":["x2","x4","x8"],"default":"x2","description":"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.","title":"V2ImageUpscaleTopazRedefinePostRequestBodyContentMultipartFormDataSchemaUpscaleFactor"},"V2ImageUpscaleTopazRedefinePostRequestBodyContentMultipartFormDataSchemaSubjectDetection":{"type":"string","enum":["all","foreground","background"],"description":"Where enhancements apply. Omit to let the model choose per image.","title":"V2ImageUpscaleTopazRedefinePostRequestBodyContentMultipartFormDataSchemaSubjectDetection"},"UpscaleImageTopazRedefineResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UpscaleImageObject"},"description":"The upscaled image. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The output width in pixels."},"height":{"type":"integer","description":"The output height in pixels."}},"required":["generation_id","seed","width","height"],"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","title":"UpscaleImageTopazRedefineResponse"},"V2ImageUpscaleTopazStandard2PostRequestBodyContentMultipartFormDataSchemaUpscaleFactor":{"type":"string","enum":["x2","x4","x8"],"default":"x2","description":"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.","title":"V2ImageUpscaleTopazStandard2PostRequestBodyContentMultipartFormDataSchemaUpscaleFactor"},"V2ImageUpscaleTopazStandard2PostRequestBodyContentMultipartFormDataSchemaSubjectDetection":{"type":"string","enum":["all","foreground","background"],"description":"Where enhancements apply. Omit to let the model choose per image.","title":"V2ImageUpscaleTopazStandard2PostRequestBodyContentMultipartFormDataSchemaSubjectDetection"},"UpscaleImageTopazStandardV2Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UpscaleImageObject"},"description":"The upscaled image. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The output width in pixels."},"height":{"type":"integer","description":"The output height in pixels."}},"required":["generation_id","seed","width","height"],"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","title":"UpscaleImageTopazStandardV2Response"},"V2ImageUpscaleTopazTextRefinePostRequestBodyContentMultipartFormDataSchemaUpscaleFactor":{"type":"string","enum":["x2","x4","x8"],"default":"x2","description":"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.","title":"V2ImageUpscaleTopazTextRefinePostRequestBodyContentMultipartFormDataSchemaUpscaleFactor"},"V2ImageUpscaleTopazTextRefinePostRequestBodyContentMultipartFormDataSchemaSubjectDetection":{"type":"string","enum":["all","foreground","background"],"description":"Where enhancements apply. Omit to let the model choose per image.","title":"V2ImageUpscaleTopazTextRefinePostRequestBodyContentMultipartFormDataSchemaSubjectDetection"},"UpscaleImageTopazTextRefineResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UpscaleImageObject"},"description":"The upscaled image. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The output width in pixels."},"height":{"type":"integer","description":"The output height in pixels."}},"required":["generation_id","seed","width","height"],"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","title":"UpscaleImageTopazTextRefineResponse"},"V2ImageUpscaleTopazWonder35PostRequestBodyContentMultipartFormDataSchemaUpscaleFactor":{"type":"string","enum":["x2","x4","x8"],"default":"x2","description":"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.","title":"V2ImageUpscaleTopazWonder35PostRequestBodyContentMultipartFormDataSchemaUpscaleFactor"},"V2ImageUpscaleTopazWonder35PostRequestBodyContentMultipartFormDataSchemaEnhancementStrength":{"type":"string","enum":["low","medium","high"],"default":"high","description":"How strongly the generative model reconstructs detail while upscaling. Lower values stay closer to the source image; higher values produce a more enhanced result.","title":"V2ImageUpscaleTopazWonder35PostRequestBodyContentMultipartFormDataSchemaEnhancementStrength"},"UpscaleImageTopazWonder35Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UpscaleImageObject"},"description":"The upscaled image. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"width":{"type":"integer","description":"The output width in pixels."},"height":{"type":"integer","description":"The output height in pixels."}},"required":["generation_id","seed","width","height"],"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","title":"UpscaleImageTopazWonder35Response"},"V2ImageReplaceBackgroundIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed":{"type":"string","enum":["turbo","default","quality"],"default":"default","description":"The rendering speed to use.","title":"V2ImageReplaceBackgroundIdeogram3PostRequestBodyContentMultipartFormDataSchemaRenderingSpeed"},"ReplaceBackgroundResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`."}},"required":["generation_id"],"description":"Acknowledgement that the request was accepted.","title":"ReplaceBackgroundResponse"},"ReplaceBackgroundQuality":{"type":"string","enum":["low","medium","high"],"description":"The quality tier for the edit. Higher tiers may improve detail and\ntake longer to complete.\n","title":"ReplaceBackgroundQuality"},"BackgroundRemovedImageObject":{"type":"object","properties":{"url":{"type":["string","null"],"format":"uri","description":"Direct link to the foreground PNG. Empty when the output fails safety checks."},"is_image_safe":{"type":"boolean","description":"Whether the foreground image passed safety checks."}},"required":["is_image_safe"],"title":"BackgroundRemovedImageObject"},"RemoveBackgroundV2Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`."},"data":{"type":"array","items":{"$ref":"#/components/schemas/BackgroundRemovedImageObject"},"description":"The single foreground image. Present only for synchronous requests."},"error":{"type":"string","description":"Error message for a failure after the response started streaming."},"status_code":{"type":"integer","description":"The HTTP status the failure would have returned before streaming began."}},"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","title":"RemoveBackgroundV2Response"},"RemoveObjectFromV2AssetsResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n"}},"required":["generation_id"],"description":"Acknowledgement that the request was accepted. Poll\n`GET /v2/generations/{generation_id}` with the returned `generation_id`\nfor the result.\n","title":"RemoveObjectFromV2AssetsResponse"},"V4StyleDescription":{"type":"object","properties":{"aesthetics":{"type":"string","description":"Aesthetic notes (mood, vibe, references)."},"art_style":{"type":"string","description":"Optional art-style hint (e.g., illustration, oil painting)."},"lighting":{"type":"string","description":"Lighting description."},"medium":{"type":"string","description":"Medium description (e.g., photograph, digital art)."},"photo":{"type":"string","description":"Optional photographic style notes (e.g., lens, film stock)."},"color_palette":{"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"description":"Optional list of hex color strings (e.g. \"#FFD700\") that bias the\nIdeogram 4.0 output toward this palette. Applied as a soft color bias,\nnot an exact per-pixel lock.\n"}},"description":"Optional style description supplied alongside a V4 JSON prompt.","title":"V4StyleDescription"},"V4ObjPromptElementType":{"type":"string","enum":["obj"],"description":"Discriminator. Must be `obj`.","title":"V4ObjPromptElementType"},"V4TextPromptElementType":{"type":"string","enum":["text"],"description":"Discriminator. Must be `text`.","title":"V4TextPromptElementType"},"V4PromptElement":{"oneOf":[{"type":"object","properties":{"type":{"$ref":"#/components/schemas/V4ObjPromptElementType","description":"Discriminator. Must be `obj`."},"bbox":{"type":"array","items":{"type":"integer","minimum":0,"maximum":1000},"description":"Bounding box for an element, expressed as four integers in `[0, 1000]`\nwith `[y_min, x_min, y_max, x_max]` semantics (row-first). Values are\nnormalized so the canvas is `1000 x 1000` regardless of the final\nresolution.\n"},"desc":{"type":"string","description":"Description of the object element."},"color_palette":{"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"description":"Optional list of hex color strings (e.g. \"#FFD700\") that bias the\nIdeogram 4.0 output toward this palette. Applied as a soft color bias,\nnot an exact per-pixel lock.\n"}},"required":["type","desc"],"description":"A non-text element (object, character, background detail) in the V4 prompt layout."},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/V4TextPromptElementType","description":"Discriminator. Must be `text`."},"bbox":{"type":"array","items":{"type":"integer","minimum":0,"maximum":1000},"description":"Bounding box for an element, expressed as four integers in `[0, 1000]`\nwith `[y_min, x_min, y_max, x_max]` semantics (row-first). Values are\nnormalized so the canvas is `1000 x 1000` regardless of the final\nresolution.\n"},"text":{"type":"string","description":"The literal text to render in the image."},"desc":{"type":"string","description":"Description of the text element (style, role, placement notes)."},"color_palette":{"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"description":"Optional list of hex color strings (e.g. \"#FFD700\") that bias the\nIdeogram 4.0 output toward this palette. Applied as a soft color bias,\nnot an exact per-pixel lock.\n"}},"required":["type","text","desc"],"description":"A text element to render in the V4 prompt layout."}],"discriminator":{"propertyName":"type"},"description":"A single element in the V4 prompt's compositional deconstruction.\nDiscriminated by the `type` field.\n","title":"V4PromptElement"},"V4CompositionalDeconstruction":{"type":"object","properties":{"background":{"type":"string","description":"Description of the background of the scene."},"elements":{"type":"array","items":{"$ref":"#/components/schemas/V4PromptElement"},"description":"Ordered list of elements (objects and text) composing the scene."}},"required":["background","elements"],"description":"The compositional breakdown of a V4 prompt — background plus an ordered list of elements.","title":"V4CompositionalDeconstruction"},"V4JsonPrompt":{"type":"object","properties":{"high_level_description":{"type":"string","description":"One- or two-sentence overall description of the desired image."},"style_description":{"$ref":"#/components/schemas/V4StyleDescription"},"compositional_deconstruction":{"$ref":"#/components/schemas/V4CompositionalDeconstruction"}},"required":["high_level_description","compositional_deconstruction"],"description":"Structured prompt for Ideogram 4.0 generation. When `json_prompt` is\nsupplied, magic-prompt is disabled and the diffusion model consumes\nthe JSON contract directly. Mutually exclusive with `text_prompt`\nand the legacy `prompt` field.\n","title":"V4JsonPrompt"},"DescribeImageIdeogramV4Response":{"type":"object","properties":{"description_id":{"type":"string","description":"URL-safe base64 ID of the description that was created."},"created":{"type":"string","format":"date-time","description":"The time the request was created."},"json_prompt":{"$ref":"#/components/schemas/V4JsonPrompt"}},"required":["description_id","created","json_prompt"],"description":"Response returned by `POST /v2/image/describe/ideogram-4`.\nThe `json_prompt` field is a structured `V4JsonPrompt` that can be\npassed back as `json_prompt` to the `/v1/ideogram-v4/generate` family\nof endpoints.\n","title":"DescribeImageIdeogramV4Response"},"ImageSafetyError":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"title":"ImageSafetyError"},"GeneratedDescription":{"type":"object","properties":{"text":{"type":"string","description":"The generated description for the provided image."}},"required":["text"],"title":"GeneratedDescription"},"DescribeImageIdeogramV3Response":{"type":"object","properties":{"description_id":{"type":"string","description":"URL-safe base64 ID of the description that was created."},"created":{"type":"string","format":"date-time","description":"The time the request was created."},"descriptions":{"type":"array","items":{"$ref":"#/components/schemas/GeneratedDescription"},"description":"The generated description(s) for the provided image."}},"required":["description_id","created","descriptions"],"description":"Response returned by `POST /v2/image/describe/ideogram-3`.","title":"DescribeImageIdeogramV3Response"},"DetectedTextBlockAlignment":{"type":"string","enum":["left","center","right"],"description":"Detected text alignment.","title":"DetectedTextBlockAlignment"},"DetectedTextBlockFormattingItems":{"type":"string","enum":["bold","italic","underline","strikethrough","all_caps","small_caps","superscript","subscript"],"title":"DetectedTextBlockFormattingItems"},"DetectedTextBlockRole":{"type":"string","enum":["heading","subheading","body","caption"],"description":"Inferred typographic role of this text block.","title":"DetectedTextBlockRole"},"DetectedTextBlock":{"type":"object","properties":{"x":{"type":"integer","description":"X coordinate in pixels from the top-left corner."},"y":{"type":"integer","description":"Y coordinate in pixels from the top-left corner."},"width":{"type":"integer","description":"Width of the text region in pixels."},"height":{"type":"integer","description":"Height of the text region in pixels."},"text":{"type":"string","description":"The detected text content. Line breaks are represented as \\n."},"alignment":{"$ref":"#/components/schemas/DetectedTextBlockAlignment","description":"Detected text alignment."},"angle":{"type":"string","title":"float","description":"Rotation angle in degrees (clockwise). Defaults to 0.","default":0},"font_name":{"type":["string","null"],"description":"Best-matching font name from the font library."},"font_alternatives":{"type":["array","null"],"items":{"type":"string"},"description":"Alternative font matches, ranked by similarity."},"font_size":{"type":["integer","null"],"description":"Detected font size in points."},"line_height":{"type":["string","null"],"title":"float","description":"Line height multiplier (e.g., 1.2)."},"color":{"type":["string","null"],"pattern":"^#[0-9A-Fa-f]{6}$","description":"Detected text color in hex format."},"formatting":{"type":"array","items":{"$ref":"#/components/schemas/DetectedTextBlockFormattingItems"},"description":"Detected text formatting effects."},"role":{"oneOf":[{"$ref":"#/components/schemas/DetectedTextBlockRole"},{"type":"null"}],"description":"Inferred typographic role of this text block."}},"required":["x","y","width","height","text","alignment","formatting"],"description":"A single detected text region with its position, content, font information, and styling.","title":"DetectedTextBlock"},"LayerizedImageObject":{"type":"object","properties":{"url":{"type":["string","null"],"format":"uri","description":"The direct link to the design image with its text intact. Empty when the image did not pass safety checks."},"base_image_url":{"type":["string","null"],"format":"uri","description":"The direct link to the base image with all detected text removed. Empty when the image did not pass safety checks."},"resolution":{"type":"string","description":"The resolution of the design, formatted as \"WIDTHxHEIGHT\"."},"is_image_safe":{"type":"boolean","description":"Whether the image passed safety checks. If false, the image links are empty."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"text_blocks":{"type":"array","items":{"$ref":"#/components/schemas/DetectedTextBlock"},"description":"Flat list of detected text regions in the design."}},"required":["resolution","is_image_safe","seed","text_blocks"],"description":"One layerized design. Image links are available for a limited period\nof time; if you would like to keep an image, you must download it.\n","title":"LayerizedImageObject"},"LayerizeDesignIdeogramV3Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation. Use it to poll\n`GET /v2/generations/{generation_id}`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LayerizedImageObject"},"description":"The layerized design. Present only for synchronous requests (`async` omitted or false)."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["generation_id","seed"],"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","title":"LayerizeDesignIdeogramV3Response"},"KlingV3ShotType":{"type":"string","enum":["customize","intelligent"],"default":"customize","description":"How the prompt is staged. `customize` follows the prompt as written;\n`intelligent` lets the model break the prompt into its own shots.\n","title":"KlingV3ShotType"},"GenerateVideoKlingV3Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`.\n"},"created":{"type":"string","format":"date-time","description":"The time the request was accepted."}},"required":["generation_id","created"],"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","title":"GenerateVideoKlingV3Response"},"KlingV3AspectRatio":{"type":"string","enum":["16x9","9x16","1x1"],"default":"16x9","description":"The aspect ratio of the generated video.","title":"KlingV3AspectRatio"},"GenerateVideoKlingV3StandardTextToVideoRequest":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000,"description":"A natural-language prompt describing the video to generate."},"negative_prompt":{"type":"string","maxLength":2000,"description":"Description of what to keep out of the video. Descriptions in the prompt take precedence over descriptions in the negative prompt."},"aspect_ratio":{"$ref":"#/components/schemas/KlingV3AspectRatio","default":"16x9"},"duration":{"type":"integer","minimum":3,"maximum":15,"description":"The length of the generated video in seconds. Defaults to 5 seconds\nwhen omitted.\n"},"generate_audio":{"type":"boolean","default":false,"description":"Whether to generate an audio track for the video. Audio roughly\ndoubles the provider cost and is subject to stricter output moderation.\n"},"shot_type":{"$ref":"#/components/schemas/KlingV3ShotType","default":"customize"},"cfg_scale":{"type":"string","title":"float","description":"How closely the video follows the prompt, from 0 to 1. Lower values\nleave the model more freedom. Defaults to 0.5 when omitted.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"description":"Request body for Kling v3 Standard text-to-video generation.","title":"GenerateVideoKlingV3StandardTextToVideoRequest"},"MinimaxH3Resolution":{"type":"string","enum":["480P","768P","2K","4K"],"default":"2K","description":"The resolution tier of the generated video, spelled the way MiniMax\nspells it. `480P` and `768P` are generated natively; `2K` and `4K` are\nupscaled from a `768P` result.\nHigher tiers cost more.\n","title":"MinimaxH3Resolution"},"GenerateVideoMinimaxH3Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the accepted generation. Accepted by the\n`GET /v2/generations/{generation_id}` polling endpoint.\n"},"created":{"type":"string","format":"date-time","description":"The time the request was accepted."}},"required":["generation_id","created"],"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","title":"GenerateVideoMinimaxH3Response"},"MinimaxH3AspectRatio":{"type":"string","enum":["21x9","16x9","4x3","1x1","3x4","9x16"],"default":"16x9","description":"The aspect ratio of the generated video.","title":"MinimaxH3AspectRatio"},"MinimaxH3PromptExpansionMode":{"type":"string","enum":["disabled","fast","balanced","quality"],"default":"balanced","description":"How much the model may rewrite the prompt before generating. `disabled`\nuses the prompt as written; the other modes trade latency for a richer\nrewrite.\n","title":"MinimaxH3PromptExpansionMode"},"GenerateVideoMinimaxH3TextToVideoRequest":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000,"description":"A natural-language prompt describing the video to generate."},"aspect_ratio":{"$ref":"#/components/schemas/MinimaxH3AspectRatio","default":"16x9"},"resolution":{"$ref":"#/components/schemas/MinimaxH3Resolution","default":"2K"},"duration":{"type":"integer","minimum":5,"maximum":15,"default":5,"description":"The length of the generated video in seconds."},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"description":"Request body for MiniMax H3 text-to-video generation.","title":"GenerateVideoMinimaxH3TextToVideoRequest"},"SeedDance25Resolution":{"type":"string","enum":["480p","720p","1080p"],"default":"720p","description":"The resolution tier of the generated video.","title":"SeedDance25Resolution"},"GenerateVideoSeedDance25Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`.\n"},"created":{"type":"string","format":"date-time","description":"The time the request was accepted."}},"required":["generation_id","created"],"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","title":"GenerateVideoSeedDance25Response"},"SeedDance2AspectRatio":{"type":"string","enum":["auto","21x9","16x9","4x3","1x1","3x4","9x16"],"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","title":"SeedDance2AspectRatio"},"GenerateVideoSeedDance25TextToVideoRequest":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":30000,"description":"A natural-language prompt describing the video to generate."},"aspect_ratio":{"$ref":"#/components/schemas/SeedDance2AspectRatio","default":"auto"},"resolution":{"$ref":"#/components/schemas/SeedDance25Resolution","default":"720p"},"duration":{"type":"integer","minimum":4,"maximum":30,"description":"The length of the generated video in seconds. When omitted, the model\npicks the best duration for the prompt (\"auto\").\n"},"generate_audio":{"type":"boolean","default":false,"description":"Whether to generate an audio track for the video. Audio roughly\ndoubles the provider cost and is subject to stricter output moderation.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"description":"Request body for Seedance 2.5 text-to-video generation.","title":"GenerateVideoSeedDance25TextToVideoRequest"},"SeedDance2Resolution":{"type":"string","enum":["480p","720p"],"default":"720p","description":"The resolution tier of the generated video.","title":"SeedDance2Resolution"},"GenerateVideoSeedDance2Response":{"type":"object","properties":{"generation_id":{"type":"string","description":"The generation ID to poll with `GET /v2/generations/{generation_id}`.\n"},"created":{"type":"string","format":"date-time","description":"The time the request was accepted."}},"required":["generation_id","created"],"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","title":"GenerateVideoSeedDance2Response"},"GenerateVideoSeedDance2TextToVideoRequest":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000,"description":"A natural-language prompt describing the video to generate."},"aspect_ratio":{"$ref":"#/components/schemas/SeedDance2AspectRatio","default":"auto"},"resolution":{"$ref":"#/components/schemas/SeedDance2Resolution","default":"720p"},"duration":{"type":"integer","minimum":4,"maximum":15,"description":"The length of the generated video in seconds. When omitted, the model\npicks the best duration for the prompt (\"auto\").\n"},"generate_audio":{"type":"boolean","default":false,"description":"Whether to generate an audio track for the video. Audio roughly\ndoubles the provider cost and is subject to stricter output moderation.\n"},"webhook_url":{"type":"string","format":"uri","maxLength":2048,"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"}},"required":["prompt"],"description":"Request body for Seedance 2.0 text-to-video generation.","title":"GenerateVideoSeedDance2TextToVideoRequest"},"AssetType":{"type":"string","enum":["ASSET","CANVAS_ASSET","LAYERED_ASSET","RESPONSE","UPLOAD"],"title":"AssetType"},"AssetIdentifier":{"type":"object","properties":{"asset_type":{"$ref":"#/components/schemas/AssetType"},"asset_id":{"type":"string"},"collection_id":{"type":"string","pattern":"^[A-Za-z0-9_-]{22}$","minLength":22,"maxLength":22,"description":"Optional collection from which this asset was selected as a generation reference. Records usage attribution; does not grant access to the asset."}},"required":["asset_type","asset_id"],"description":"An identifier for an ideogram asset.","title":"AssetIdentifier"},"V2SvgGenerateIdeogramVector1PostRequestBodyContentMultipartFormDataSchemaQuality":{"type":"string","enum":["low","medium","high"],"default":"medium","title":"V2SvgGenerateIdeogramVector1PostRequestBodyContentMultipartFormDataSchemaQuality"},"GenerateSvgResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 generation ID. Poll the shared generations endpoint for SVG results."}},"required":["generation_id"],"title":"GenerateSvgResponse"},"V2SvgVectorizeIdeogramVector1PostRequestBodyContentMultipartFormDataSchemaMode":{"type":"string","enum":["simple","detailed","auto"],"default":"auto","description":"Simple uses fewer shapes; detailed preserves fine detail; auto chooses the level of detail that best suits the image.","title":"V2SvgVectorizeIdeogramVector1PostRequestBodyContentMultipartFormDataSchemaMode"},"VectorizerResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 generation ID."}},"required":["generation_id"],"title":"VectorizerResponse"},"V2ToolAdLocalizerPostRequestBodyContentMultipartFormDataSchemaLanguage":{"type":"string","enum":["ar","cs","da","de","en","es","fi","fr","fr-ca","hu","it","ja","nl","no","pl","pt","sv"],"description":"The target language for the copy. Arabic is rendered right-to-left. Each request covers one language; send one request per language.","title":"V2ToolAdLocalizerPostRequestBodyContentMultipartFormDataSchemaLanguage"},"AdLocalizerQuality":{"type":"string","enum":["low","medium","high"],"description":"The quality tier for the edit. Higher tiers may improve detail and\ntake longer to complete.\n","title":"AdLocalizerQuality"},"AdLocalizerResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID accepted by the generation polling endpoint."}},"required":["generation_id"],"description":"Acknowledgement that the ad localization was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n","title":"AdLocalizerResponse"},"V2ToolAdResizerPostRequestBodyContentMultipartFormDataSchemaResolution":{"type":"string","enum":["300x250","336x280","300x600","1080x1080","1080x1350","1080x1920","1920x1080","728x90","160x600","970x250","320x50","300x50","320x100","1800x900","2400x2400","1200x3500","2880x2880","2560x3200","3200x2560","2448x3264","3264x2448","2336x3504","3504x2336","2240x3584","3584x2240","2160x3840","3840x2160","1920x3840","3840x1920","1280x3840","3840x1280"],"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","title":"V2ToolAdResizerPostRequestBodyContentMultipartFormDataSchemaResolution"},"V2ToolAdResizerPostRequestBodyContentMultipartFormDataSchemaPlatform":{"type":"string","enum":["google","meta","meta_reels","meta_stories","snapchat","tiktok"],"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","title":"V2ToolAdResizerPostRequestBodyContentMultipartFormDataSchemaPlatform"},"AdResizerQuality":{"type":"string","enum":["low","medium","high"],"description":"The quality tier for the reframe. Higher tiers may improve detail and\ntake longer to complete.\n","title":"AdResizerQuality"},"AdResizerResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID accepted by the generation polling endpoint."}},"required":["generation_id"],"description":"Acknowledgement that the ad resize was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n","title":"AdResizerResponse"},"V2ToolAdVariationsPostRequestBodyContentMultipartFormDataSchemaVariationType":{"type":"string","enum":["people","setting","group_size","scene"],"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","title":"V2ToolAdVariationsPostRequestBodyContentMultipartFormDataSchemaVariationType"},"AdVariationsQuality":{"type":"string","enum":["low","medium","high"],"description":"The quality tier for the edit. Higher tiers may improve detail and\ntake longer to complete.\n","title":"AdVariationsQuality"},"AdVariationsResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID accepted by the generation polling endpoint."}},"required":["generation_id"],"description":"Acknowledgement that the ad variation was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n","title":"AdVariationsResponse"},"ColorwaysQuality":{"type":"string","enum":["low","medium","high"],"description":"The quality tier for the edit. Higher tiers may improve detail and\ntake longer to complete.\n","title":"ColorwaysQuality"},"ColorwaysResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID accepted by the generation polling endpoint."}},"required":["generation_id"],"description":"Acknowledgement that the colorway was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n","title":"ColorwaysResponse"},"V2ToolGhostMannequinPostRequestBodyContentMultipartFormDataSchemaView":{"type":"string","enum":["front","three_quarter","back"],"description":"Camera view for the output garment.","title":"V2ToolGhostMannequinPostRequestBodyContentMultipartFormDataSchemaView"},"GhostMannequinQuality":{"type":"string","enum":["low","medium","high"],"description":"The quality tier for the edit. Higher tiers may improve detail and\ntake longer to complete.\n","title":"GhostMannequinQuality"},"GhostMannequinResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID accepted by the generation polling endpoint."}},"required":["generation_id"],"description":"Acknowledgement that the ghost-mannequin request was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n","title":"GhostMannequinResponse"},"MaterialSwapQuality":{"type":"string","enum":["low","medium","high"],"description":"The quality tier for the edit. Higher tiers may improve detail and\ntake longer to complete.\n","title":"MaterialSwapQuality"},"MaterialSwapResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID accepted by the generation polling endpoint."}},"required":["generation_id"],"description":"Acknowledgement that the material swap was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n","title":"MaterialSwapResponse"},"ModelPoseVariantsQuality":{"type":"string","enum":["low","medium","high"],"description":"The quality tier for the edit. Higher tiers may improve detail and\ntake longer to complete.\n","title":"ModelPoseVariantsQuality"},"ModelPoseVariantsResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID accepted by the generation polling endpoint."}},"required":["generation_id"],"description":"Acknowledgement that pose-variant generation was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n","title":"ModelPoseVariantsResponse"},"SketchToRenderQuality":{"type":"string","enum":["low","medium","high"],"description":"The quality tier for the edit. Higher tiers may improve detail and\ntake longer to complete.\n","title":"SketchToRenderQuality"},"SketchToRenderResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID accepted by the generation polling endpoint."}},"required":["generation_id"],"description":"Acknowledgement that the sketch rendering was accepted. Poll\n`GET /v2/generations/{generation_id}` for status and results.\n","title":"SketchToRenderResponse"},"GenerationResponseStatus":{"type":"string","enum":["pending","completed","failed"],"description":"Current status of the generation. `pending`: still in progress; the response contains only `generation_id`, `status`, and `created`. `completed`: finished successfully; the response includes `response_type` and `data`, and may include `usage_cost_usd_micros` when the request uses variable usage-based pricing. `failed`: generation did not succeed; the response contains only `generation_id`, `status`, and `created`.","title":"GenerationResponseStatus"},"GenerationResponseResponseType":{"type":"string","enum":["url"],"description":"Present when `status` is `completed`; always \"url\" for this shape.","title":"GenerationResponseResponseType"},"GenerationResponseDataInnerDiscriminatorMappingSvgGenerationMimeType":{"type":"string","enum":["image/svg+xml"],"title":"GenerationResponseDataInnerDiscriminatorMappingSvgGenerationMimeType"},"LayerizedTextBlockAlignment":{"type":"string","enum":["left","center","right"],"description":"Detected text alignment.","title":"LayerizedTextBlockAlignment"},"LayerizedTextBlockFormattingItems":{"type":"string","enum":["bold","italic","underline","strikethrough","all_caps","small_caps","superscript","subscript"],"title":"LayerizedTextBlockFormattingItems"},"LayerizedTextBlockRole":{"type":"string","enum":["heading","subheading","body","caption"],"description":"Inferred typographic role of this text block.","title":"LayerizedTextBlockRole"},"TextColorSpan":{"type":"object","properties":{"text":{"type":"string","description":"The characters in this run."},"color":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$","description":"Hex colour for this run."}},"required":["text","color"],"description":"One run of characters within a text block that shares a single colour. A block\nwhose letters are individually coloured returns one span per letter; a block in a\nsingle colour returns one span covering all of it. Concatenating `text` across a\nblock's spans in order reproduces the block's full text.\n","title":"TextColorSpan"},"LayerizedTextBlock":{"type":"object","properties":{"x":{"type":"integer","description":"X coordinate in pixels from the top-left corner."},"y":{"type":"integer","description":"Y coordinate in pixels from the top-left corner."},"width":{"type":"integer","description":"Width of the text region in pixels."},"height":{"type":"integer","description":"Height of the text region in pixels."},"text":{"type":"string","description":"The detected text content. Line breaks are represented as \\n."},"alignment":{"$ref":"#/components/schemas/LayerizedTextBlockAlignment","description":"Detected text alignment."},"angle":{"type":"string","title":"float","description":"Rotation angle in degrees (clockwise). Defaults to 0.","default":0},"font_name":{"type":["string","null"],"description":"Best-matching font name from the font library."},"font_alternatives":{"type":["array","null"],"items":{"type":"string"},"description":"Alternative font matches, ranked by similarity."},"font_size":{"type":["integer","null"],"description":"Detected font size in points."},"line_height":{"type":["string","null"],"title":"float","description":"Line height multiplier (e.g., 1.2)."},"color":{"type":["string","null"],"pattern":"^#[0-9A-Fa-f]{6}$","description":"Detected text color in hex format."},"formatting":{"type":"array","items":{"$ref":"#/components/schemas/LayerizedTextBlockFormattingItems"},"description":"Detected text formatting effects."},"role":{"oneOf":[{"$ref":"#/components/schemas/LayerizedTextBlockRole"},{"type":"null"}],"description":"Inferred typographic role of this text block."},"layer_id":{"type":"string","description":"Identifier of this block's layer in the page at `html_url`; pass it to the page's editing API."},"spans":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TextColorSpan"},"description":"The block's colour runs in reading order. Present, with at least one\nrun, whenever `color` is set; concatenating the runs' `text` reproduces\nthe block's `text`. `color` reports the dominant colour.\n"}},"required":["x","y","width","height","text","alignment","formatting","layer_id"],"description":"A single detected text region with its position, content, font information, and styling.","title":"LayerizedTextBlock"},"LayerizedImageLayer":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Signed link to the layer as a transparent PNG, cropped to its visible pixels. Links are available for a limited period of time."},"x":{"type":"integer","description":"Left edge of the layer on the design's canvas, in pixels."},"y":{"type":"integer","description":"Top edge of the layer on the design's canvas, in pixels."},"width":{"type":"integer","description":"Width of the layer, in pixels."},"height":{"type":"integer","description":"Height of the layer, in pixels."}},"required":["url","x","y","width","height"],"description":"One transparent image layer of a layerized design, placed at its\nposition on the design's canvas.\n","title":"LayerizedImageLayer"},"GenerationResponse_data_inner":{"oneOf":[{"type":"object","properties":{"object_type":{"type":"string","enum":["image.without-prompt-or-seed"],"description":"Discriminator value: image.without-prompt-or-seed"},"url":{"type":["string","null"],"format":"uri","description":"The direct link to the reframed image."},"resolution":{"type":"string","description":"The exact dimensions of the reframed image, formatted as \"{width}x{height}\"."},"is_image_safe":{"type":"boolean","description":"Whether this image passes safety checks. If false, the url field is empty."}},"required":["object_type","resolution","is_image_safe"],"description":"An image result that does not expose its prompt or seed."},{"type":"object","properties":{"object_type":{"type":"string","enum":["svg.generation"],"description":"Discriminator value: svg.generation"},"asset_id":{"type":"string","description":"URL-safe base64 SVG asset ID."},"url":{"type":"string","format":"uri","description":"Signed download URL for the original SVG."},"mime_type":{"$ref":"#/components/schemas/GenerationResponseDataInnerDiscriminatorMappingSvgGenerationMimeType"},"width":{"type":"integer","minimum":1,"description":"Width of the output SVG canvas in pixels."},"height":{"type":"integer","minimum":1,"description":"Height of the output SVG canvas in pixels."}},"required":["object_type","asset_id","url","mime_type","width","height"],"description":"SvgGenerationObject variant"},{"type":"object","properties":{"object_type":{"type":"string","enum":["image.generation"],"description":"Discriminator value: image.generation"},"url":{"type":["string","null"],"format":"uri","description":"The direct link to the image generated."},"prompt":{"type":"string","description":"The prompt used for the generation. This may be different from the original prompt."},"resolution":{"type":"string","description":"The resolution of the generated image, formatted as \"{width}x{height}\"."},"is_image_safe":{"type":"boolean","description":"Whether this image passes safety checks. If false, the url field will be empty."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."}},"required":["object_type","prompt","resolution","is_image_safe","seed"],"description":"A single generated image. Model-agnostic shape returned by the generation polling endpoint."},{"type":"object","properties":{"object_type":{"type":"string","enum":["video.generation"],"description":"Discriminator value: video.generation"},"asset_id":{"type":"string","description":"The generated video's asset ID. Use it with asset_type RESPONSE in video_asset_identifier for a follow-up video edit. This is distinct from the generation ID used for polling."},"url":{"type":["string","null"],"format":"uri","description":"The direct link to the generated video."},"prompt":{"type":"string","description":"The prompt used for the generation."},"resolution":{"type":"string","description":"The resolution tier of the generated video."},"aspect_ratio":{"type":"string","description":"The actual aspect ratio of the produced video, formatted as \"{width}:{height}\"."},"duration":{"type":"integer","description":"The actual measured length of the produced video in seconds."}},"required":["object_type","prompt","resolution","aspect_ratio","duration"],"description":"A single generated video returned by the generation polling endpoint."},{"type":"object","properties":{"object_type":{"type":"string","enum":["layerized_image"],"description":"Discriminator value: layerized_image"},"url":{"type":["string","null"],"format":"uri","description":"The direct link to the design image with its text intact. Empty when the image did not pass safety checks."},"base_image_url":{"type":["string","null"],"format":"uri","description":"The direct link to the base image with all detected text removed. Empty when the image did not pass safety checks."},"resolution":{"type":"string","description":"The resolution of the design, formatted as \"WIDTHxHEIGHT\"."},"is_image_safe":{"type":"boolean","description":"Whether the image passed safety checks. If false, the image links are empty."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"text_blocks":{"type":"array","items":{"$ref":"#/components/schemas/DetectedTextBlock"},"description":"Flat list of detected text regions in the design."}},"required":["object_type","resolution","is_image_safe","seed","text_blocks"],"description":"One layerized design. Image links are available for a limited period\nof time; if you would like to keep an image, you must download it.\n"},{"type":"object","properties":{"object_type":{"type":"string","enum":["layerized_design.generation"],"description":"Discriminator value: layerized_design.generation"},"url":{"type":["string","null"],"format":"uri","description":"Signed link to the design image with its text intact. Empty when the image did not pass safety checks."},"base_image_url":{"type":["string","null"],"format":"uri","description":"Signed link to the base image with all detected text removed. Empty when the image did not pass safety checks."},"resolution":{"type":"string","description":"The resolution of the design, formatted as \"WIDTHxHEIGHT\"."},"is_image_safe":{"type":"boolean","description":"Whether the image passed safety checks. If false, the links are empty."},"seed":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Random seed. Set for reproducible generation."},"text_blocks":{"type":"array","items":{"$ref":"#/components/schemas/LayerizedTextBlock"},"description":"Flat list of detected text regions in the design."},"image_layers":{"type":"array","items":{"$ref":"#/components/schemas/LayerizedImageLayer"},"description":"Transparent image layers stacked above the base image and below the\ntext blocks, back to front. Design Layerizer fills this with the\ndesign's separated artwork, including any text it could not rebuild;\nText Layerizer leaves it empty.\n"},"html_url":{"type":["string","null"],"format":"uri","description":"Signed link to a self-contained HTML page displaying the editable\ndesign, including curved text, gradients, outlines, and shadows. The\nrenderer, images, and fonts are embedded in the page, so it keeps\nworking offline once downloaded; the link itself expires after 24\nhours. Uploaded `font_candidate_files` are embedded as supplied, so\nredistributing the page is subject to those fonts' licenses. Empty\nwhen the image did not pass safety checks or the page could not be\nbuilt.\n\nThe page exposes one editing API for every text layer, whether it\nis drawn as HTML or on a canvas. Each layer is addressed by its\n`text_blocks[].layer_id`. Scripts in the page can call\n`window.layerize` (`ready`, `getTextLayers()`, `setText(id, text)`,\n`update(id, patch)`, `toJSON()`, `toPNG()`); a parent page that\nembeds it in an iframe sends `postMessage` requests such as\n`{\"type\": \"layerize:set-text\", \"id\": \"text-0\", \"text\": \"Hello\"}`\nand receives `layerize:ready`, `layerize:updated`, and\n`layerize:error` replies. The page is served sandboxed with an\nopaque origin, so it cannot read cookies or storage of the site\nthat embeds it.\n"}},"required":["object_type","resolution","is_image_safe","seed","text_blocks"],"description":"One layerized design. Links are available for a limited period of time;\nif you would like to keep a file, you must download it.\n"}],"discriminator":{"propertyName":"object_type"},"title":"GenerationResponse_data_inner"},"GenerationResponse":{"type":"object","properties":{"generation_id":{"type":"string","description":"URL-safe base64 ID of the generation."},"status":{"$ref":"#/components/schemas/GenerationResponseStatus","description":"Current status of the generation. `pending`: still in progress; the response contains only `generation_id`, `status`, and `created`. `completed`: finished successfully; the response includes `response_type` and `data`, and may include `usage_cost_usd_micros` when the request uses variable usage-based pricing. `failed`: generation did not succeed; the response contains only `generation_id`, `status`, and `created`."},"created":{"type":"string","format":"date-time","description":"The time the generation was created."},"response_type":{"$ref":"#/components/schemas/GenerationResponseResponseType","description":"Present when `status` is `completed`; always \"url\" for this shape."},"usage_cost_usd_micros":{"type":"integer","format":"int64","minimum":0,"description":"The total variable usage-based cost charged for the completed request, in millionths of a US dollar. Present only when `status` is `completed` and the request uses variable usage-based pricing; omitted otherwise."},"failure_reason":{"type":"string","description":"A short machine-readable reason the generation failed, for example\n`content_policy_violation`. Present only when `status` is `failed`.\n"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GenerationResponse_data_inner"},"description":"A list of generated images or videos. Present when `status` is\n`completed`. Video entries carry an `object_type` of\n`video.generation`; layerized designs carry `layerized_image`;\nentries without an `object_type` are images.\n"}},"required":["generation_id","status","created"],"description":"The current status and, when complete, result data for an asynchronous generation.","title":"GenerationResponse"},"AccountApiKeyStatus":{"type":"string","enum":["active","disabled","archived"],"title":"AccountApiKeyStatus"},"AccountApiKey":{"type":"object","properties":{"api_key_id":{"type":"string","description":"Base64 encoded API key ID"},"redacted_api_key":{"type":"string","description":"A redacted text snippet of the API key. Contains the first 4 characters of the API key"},"creation_time":{"type":"string","format":"date-time","description":"The date at which the API key was created"},"status":{"$ref":"#/components/schemas/AccountApiKeyStatus"},"label":{"type":["string","null"],"description":"An optional user-supplied label for managing the API key"},"creator_display_label":{"type":["string","null"],"description":"Name of the member who created the key, falling back to their display handle when no name is set. Null on keys created before creators were recorded, and on workspace types whose keys are shared rather than owned by one member."}},"required":["api_key_id","redacted_api_key","creation_time","status"],"title":"AccountApiKey"},"ListAccountApiKeysResponse":{"type":"object","properties":{"api_keys":{"type":"array","items":{"$ref":"#/components/schemas/AccountApiKey"},"description":"All API keys in the organization, newest first."}},"required":["api_keys"],"title":"ListAccountApiKeysResponse"},"AccountInvoiceStatus":{"type":"string","enum":["draft","pending_payment","paid","voided"],"description":"Status of the invoice","title":"AccountInvoiceStatus"},"AccountUsageApiKey":{"type":"object","properties":{"id":{"type":"string","description":"The API key's id, as listed by `GET /v2/account/api-keys`."},"redacted_key":{"type":["string","null"],"description":"The first characters of the key followed by bullets."},"label":{"type":["string","null"],"description":"The key's user-supplied label, when one is set."}},"required":["id"],"description":"The API key the usage was billed to, in redacted form.","title":"AccountUsageApiKey"},"AccountInvoiceLineItem":{"type":"object","properties":{"description":{"type":"string","description":"Display name of the charged product. Not an identifier."},"quantity":{"type":"string","description":"Number of billed units, as a decimal string."},"unit_price":{"type":"string","description":"Price per unit in `currency_code`, as a decimal string."},"cost_total":{"type":"string","description":"Total charged amount in `currency_code`, as a decimal string."},"currency_code":{"type":"string","description":"ISO 4217 currency code of the amounts on this line item."},"api_key":{"$ref":"#/components/schemas/AccountUsageApiKey"}},"required":["description","quantity","unit_price","cost_total","currency_code"],"description":"One charged product on an invoice.","title":"AccountInvoiceLineItem"},"AccountInvoice":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","description":"Start of the invoice period."},"end_time":{"type":"string","format":"date-time","description":"End of the invoice period."},"issued_time":{"type":["string","null"],"format":"date-time","description":"When the invoice was issued, when it has been."},"paid_time":{"type":["string","null"],"format":"date-time","description":"When the invoice was paid, when it has been."},"status":{"$ref":"#/components/schemas/AccountInvoiceStatus"},"total":{"type":"string","description":"Invoice total in `currency_code`, as a decimal string."},"currency_code":{"type":"string","description":"ISO 4217 currency code of the amounts on this invoice."},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/AccountInvoiceLineItem"},"description":"The invoice's charges."}},"required":["start_time","end_time","status","total","currency_code","line_items"],"title":"AccountInvoice"},"ListAccountInvoicesResponse":{"type":"object","properties":{"invoices":{"type":"array","items":{"$ref":"#/components/schemas/AccountInvoice"},"description":"The organization's invoices."}},"required":["invoices"],"title":"ListAccountInvoicesResponse"},"V2AccountUsageGetParametersBucketWidth":{"type":"string","enum":["1d","1h"],"default":"1d","title":"V2AccountUsageGetParametersBucketWidth"},"V2AccountUsageGetParametersSourcesSchemaItems":{"type":"string","enum":["api","app"],"title":"V2AccountUsageGetParametersSourcesSchemaItems"},"AccountUsageLineItemSource":{"type":"string","enum":["api","app"],"description":"Which billing surface the usage came through. `api` usage is attributed to an API key when one was used; `app` usage is attributed to the member who generated it.","title":"AccountUsageLineItemSource"},"AccountUsageBilledUnits":{"type":"object","properties":{"unit":{"type":"string","description":"What one billed unit is (for example `image`)."},"quantity":{"type":"string","description":"Number of units billed, as a decimal string."},"unit_price":{"type":"string","description":"Price per unit in `currency_code`, as a decimal string."}},"required":["unit","quantity","unit_price"],"description":"Per-unit detail for products billed per item. `quantity × unit_price` always equals the line item's `cost_total`.","title":"AccountUsageBilledUnits"},"AccountUsageLineItem":{"type":"object","properties":{"product":{"type":"string","description":"Stable identifier of the public pricing catalog entry this charge was billed under, at the granularity the pricing page prices it (for example one entry per quality and resolution). `unknown` when a historical charge can no longer be attributed; its cost is still included."},"endpoint":{"type":"string","description":"The API endpoint path this product belongs to."},"description":{"type":"string","description":"Name of the public pricing catalog entry, as shown on the pricing page. Not an identifier."},"dimensions":{"type":"object","additionalProperties":{"type":"string"},"description":"Pricing dimensions this line item was billed under, for products priced per dimension (for example rendering speed)."},"cost_total":{"type":"string","description":"Total billed amount in `currency_code`, as a decimal string."},"currency_code":{"type":"string","description":"ISO 4217 currency code of the amounts on this line item."},"source":{"$ref":"#/components/schemas/AccountUsageLineItemSource","description":"Which billing surface the usage came through. `api` usage is attributed to an API key when one was used; `app` usage is attributed to the member who generated it."},"api_key":{"$ref":"#/components/schemas/AccountUsageApiKey"},"user_email":{"type":["string","null"],"description":"Email address of the member who generated the usage. Only present on `app` usage."},"billed_units":{"$ref":"#/components/schemas/AccountUsageBilledUnits"}},"required":["product","endpoint","description","cost_total","currency_code","source"],"description":"One billed rate for one billing actor within one time bucket.","title":"AccountUsageLineItem"},"AccountUsageBucket":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","description":"Start of the bucket window (inclusive, UTC)."},"end_time":{"type":"string","format":"date-time","description":"End of the bucket window (exclusive, UTC)."},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/AccountUsageLineItem"},"description":"Usage billed in this window. Empty when nothing was billed."}},"required":["start_time","end_time","line_items"],"title":"AccountUsageBucket"},"GetAccountUsageResponse":{"type":"object","properties":{"buckets":{"type":"array","items":{"$ref":"#/components/schemas/AccountUsageBucket"},"description":"Dense, chronological buckets covering the requested range."}},"required":["buckets"],"title":"GetAccountUsageResponse"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"API key for access control. Use in the header with the name \\\"Api-Key\\\""}}}} \ No newline at end of file diff --git a/pipeline/provider_docs/kling__kling.ai_document-api_api_image_3-0-omni_image-omni b/pipeline/provider_docs/kling__kling.ai_document-api_api_image_3-0-omni_image-omni new file mode 100644 index 0000000000000000000000000000000000000000..b81adeeb9693842dfc7ddae5ef297ff51d74c28a --- /dev/null +++ b/pipeline/provider_docs/kling__kling.ai_document-api_api_image_3-0-omni_image-omni @@ -0,0 +1,364 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + KlingAI Open Platform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

        KlingAI Open Platform

        + +
        + + + + \ No newline at end of file diff --git a/pipeline/provider_docs/kling__rendered_text.txt b/pipeline/provider_docs/kling__rendered_text.txt new file mode 100644 index 0000000000000000000000000000000000000000..4fea8cd3b9b2a9c57bcb42fa25c0cb443beaa425 --- /dev/null +++ b/pipeline/provider_docs/kling__rendered_text.txt @@ -0,0 +1 @@ +"Kling AI API API Image 3 0 Omni Image Omni\n[New Release] Kling 4.0 API Is Now Officially Live and Ready for Integration!\nLearn More\nPurchase\nConsole\nSign In\nDeveloper Guide\nAPI\nPlayground\nPricing\nUpdates\nGet Started\nAuthentication\nError Codes\nConcurrency Rules\nCallback Protocol\nKling Skills\nUser Guide\nBasic APIs\nVideo\nImage\nKling Image 3.0 & 3.0 Omni\nKling Image O1\nGeneral\nKling Image 2.1\nSolution APIs\nEffects\nAI Apparel Replicator\nGoods Studio\nVideo Commerce\nNEW\nVirtual Try-on\nNEW\nAsset APIs\nDeduction Query\nAccount Usage\nKling Image 3.0 & 3.0 Omni\nImage Generation\nOmni Image Generation\nElement Management\nOmni Image Generation\nCopy page\nCreate Task\nPOST\n/v1/images/omni-image\ncURL\nCopy\nCollapse\ncurl --request POST \\\n --url https://api-singapore.klingai.com/v1/images/omni-image \\\n --header \"Authorization: Bearer ${KLING_API_KEY}\" \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"model_name\": \"kling-image-o1\",\n \"prompt\": \"Merge all the people in the images into the <<>> image\",\n \"element_list\": [\n {\n \"element_id\": 829836802793406551\n }\n ],\n \"image_list\": [\n {\n \"image\": \"https://v1-kling.klingai.com/kcdn/cdn-kcdn112452/kling-qa-test/multi-4.png\"\n },\n {\n \"image\": \"https://p2-kling.klingai.com/kcdn/cdn-kcdn112452/kling-qa-test/video_effects/1.png\"\n },\n {\n \"image\": \"https://p2-kling.klingai.com/kcdn/cdn-kcdn112452/kling-qa-test/video_effects/4.png\"\n }\n ],\n \"resolution\": \"2k\",\n \"n\": 1,\n \"aspect_ratio\": \"3:2\"\n }'\n200\nCopy\nCollapse\n{\n \"code\": 0, // Error code; Specific definitions can be found in Error codes\n \"message\": \"string\", // Error message\n \"request_id\": \"string\", // Request ID, system-generated, used for tracking requests and troubleshooting\n \"data\": {\n \"task_id\": \"string\", // Task ID, system-generated\n \"task_info\": { //Task creation parameters\n \"external_task_id\": \"string\" //User-defined task ID\n },\n \"task_status\": \"string\", // Task status, Enum values: submitted, processing, succeed, failed\n \"created_at\": 1722769557708, // Task creation time, Unix timestamp, unit: ms\n \"updated_at\": 1722769557708 //Task update time, Unix timestamp, unit: ms\n }\n}\nRequest Header\nContent-Type\nstring\nRequired\nDefault to application/json\n\nData Exchange Format\n\nAuthorization\nstring\nRequired\n\nAuthentication information, refer to API authentication\n\nRequest Body\nmodel_name\nstring\nOptional\nDefault to kling-image-o1\n\nModel Name\n\nEnum values：\nkling-image-o1\nkling-v3-omni\nprompt\nstring\nRequired\n\nText prompt words, which can include positive and negative descriptions\n\nThe prompt words can be templated to meet different image generation needs\nMust not exceed 2,500 characters\nSpecify an image in the format of <<<>>>, such as <<>>\nThe scope of abilities can be found in the user manual: KLING Omni Model User Guide\nimage_list\narray\nOptional\n\nReference Image List\n\nLoad with key:value format as follows:\n\"image_list\":[\n { \"image\":\"image_url\" }\n]\nSupports inputting image Base64 encoding or image URL (ensure accessibility)\nSupported image formats: .jpg / .jpeg / .png\nImage file size must not exceed 10MB. Image dimensions must be at least 300px. Aspect ratio must be between 1:2.5 and 2.5:1\nThe sum of reference elements and reference images must not exceed 10\nThe value of image_url parameter must not be empty\n▾\nHide child attributes\nimage\nstring\nRequired\n\nImage URL or Base64 string\n\nelement_list\narray\nOptional\n\nReference Element List based on element ID configuration\n\nLoad with key:value format as follows:\n\"element_list\":[\n { \"element_id\": 829836802793406551 }\n]\nThe sum of reference elements and reference images must not exceed 10\n\nThe support range for different model versionsvaries. For details, see Capability Map\n\n▾\nHide child attributes\nelement_id\nlong\nRequired\n\nElement ID from element library\n\nresolution\nstring\nOptional\nDefault to 1k\n\nImage generation resolution\n\nEnum values：\n1k\n2k\n4k\n1k: 1K standard definition\n2k: 2K high-res\n4k: 4K high-res\n\nThe support range for different model versionsvaries. For details, see Capability Map\n\nresult_type\nstring\nOptional\nDefault to single\n\nControl whether to generate a single image or a series of images\n\nEnum values：\nsingle\nseries\n\nThe support range for different model versionsvaries. For details, see Capability Map\n\nn\nint\nOptional\nDefault to 1\n\nNumber of generated images\n\nValue range: [1, 9]\nWhen result_type is series, this parameter is invalid\nseries_amount\nint\nOptional\nDefault to 4\n\nNumber of images in a generated image series\n\nEnum values：\n2\n3\n4\n5\n6\n7\n8\n9\nauto\nauto intelligently selects the number of images generated based on the input content\nWhen using auto, it will consume concurrency corresponding to the actual generated quantity\nWhen result_type is single, this parameter is invalid\n\nThe support range varies for different model versions. For more details, please refer to the current document's 2-0 Capability Map\n\naspect_ratio\nstring\nOptional\nDefault to auto\n\nAspect ratio of the generated images (width:height)\n\nEnum values：\n16:9\n9:16\n1:1\n4:3\n3:4\n3:2\n2:3\n21:9\nauto\nauto is to intelligently aspect ratio of the generated image based on incoming content.\n\nThe support range for different model versionsvaries. For details, see Capability Map\n\nwatermark_info\nobject\nOptional\n\nWhether to generate watermarked results simultaneously\n\nDefined by the enabled parameter, format:\n \"watermark_info\": { \"enabled\": boolean } \ntrue: generate watermarked result, false: do not generate\nCustom watermarks are not currently supported\ncallback_url\nstring\nOptional\n\nThe callback notification address for the result of this task. If configured, the server will actively notify when the task status changes\n\nFor the specific message schema, see Callback Protocol\nexternal_task_id\nstring\nOptional\n\nCustomized Task ID\n\nUser-defined task ID. It will not override the system-generated task ID, but supports querying tasks by this ID\nPlease note that it must be unique for each user\nInvocation Examples\nImage Generation with Element\ncurl --location 'https://xxx/v1/images/generations' \\\n--header \"Authorization: Bearer ${KLING_API_KEY}\" \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"model_name\": \"kling-v3-omni\",\n \"prompt\": \"Generate a recommended cover for each subject <> based on the style of the reference image <>\",\n \"element_list\": [\n {\n \"element_id\": 160\n },\n {\n \"element_id\": 161\n }\n ],\n \"image_list\": [\n {\n \"image\": \"xxx\"\n },\n {\n \"image\": \"xxx\"\n }\n ],\n \"resolution\": \"2k\",\n \"result_type\": \"series\",\n \"series_amount\": 2,\n \"aspect_ratio\": \"auto\",\n \"external_task_id\": \"\",\n \"callback_url\": \"\"\n }'\nQuery Task (Single)\nGET\n/v1/images/omni-image/{id}\ncURL\nCopy\nCollapse\ncurl --request GET \\\n --url https://api-singapore.klingai.com/v1/images/omni-image/{id} \\\n --header \"Authorization: Bearer ${KLING_API_KEY}\" \\\n --header 'Content-Type: application/json'\n200\nCopy\nCollapse\n{\n \"code\": 0, // Error codes; specific definitions see Error codes\n \"message\": \"string\", // Error information\n \"request_id\": \"string\", // Request ID, generated by the system, for tracking and troubleshooting\n \"data\": {\n \"task_id\": \"string\", // Task ID, generated by the system\n \"task_status\": \"string\", // Task status: submitted, processing, succeed, failed\n \"task_status_msg\": \"string\", // Task status message, failure reason when task fails\n \"task_info\": { //Task creation parameters\n \"external_task_id\": \"string\" //Customer-defined task ID\n },\n \"task_result\": {\n \"result_type\": \"single\",\n \"images\": [\n {\n \"index\": 0, // Image number\n \"url\": \"string\", // URL for generated image, anti-hotlinking format (Generated images/videos will be cleared after 30 days. Please save promptly.)\n \"watermark_url\": \"string\" // Watermarked image download URL, anti-hotlinking format\n }\n ],\n \"series_images\": [\n {\n \"index\": 0, // Series-image sequence number\n \"url\": \"string\", // URL for generated image, anti-hotlinking format\n \"watermark_url\": \"string\" // Watermarked image download URL\n }\n ]\n },\n \"watermark_info\": { \"enabled\": boolean },\n \"final_unit_deduction\": \"string\", // Final unit deduction for the task\n \"final_balance_deduction\": { // Balance deduction information\n \"quota\": \"string\", // Balance deduction discount price\n \"list_price\": \"string\" // Balance deduction list price\n },\n \"created_at\": 1722769557708, // Task creation time, Unix timestamp, unit: ms\n \"updated_at\": 1722769557708 //Task update time, Unix timestamp, unit: ms\n }\n}\nRequest Header\nContent-Type\nstring\nRequired\nDefault to application/json\n\nData Exchange Format\n\nAuthorization\nstring\nRequired\n\nAuthentication information, refer to API authentication\n\nPath Parameters\ntask_id\nstring\nOptional\n\nThe task ID for image generation. Request path parameter, directly fill the value in the request path. Query by external_task_id or task_id. Use either task_id or external_task_id as the {id} path parameter; exactly one is required.\n\nexternal_task_id\nstring\nOptional\n\nCustomized Task ID for image generation. Use either task_id or external_task_id as the {id} path parameter; exactly one is required.\n\nThe external_task_id filled in when creating the task. You can choose to query by external_task_id or task_id\nWhen creating a task, you can choose to query by external_task_id or task_id.\nQuery Task (List)\nGET\n/v1/images/omni-image\ncURL\nCopy\nCollapse\ncurl --request GET \\\n --url 'https://api-singapore.klingai.com/v1/images/omni-image?pageNum=1&pageSize=30' \\\n --header \"Authorization: Bearer ${KLING_API_KEY}\" \\\n --header 'Content-Type: application/json'\n200\nCopy\nCollapse\n{\n \"code\": 0, // Error codes; specific definitions see Error codes\n \"message\": \"string\", // Error information\n \"request_id\": \"string\", // Request ID, generated by the system\n \"data\": [\n {\n \"task_id\": \"string\", // Task ID, generated by the system\n \"task_status\": \"string\", // Task status: submitted, processing, succeed, failed\n \"task_status_msg\": \"string\", // Task status message\n \"task_info\": { //Task creation parameters\n \"external_task_id\": \"string\" //Customer-defined task ID\n },\n \"final_unit_deduction\": \"string\", // Final unit deduction for the task\n \"final_balance_deduction\": { // Balance deduction information\n \"quota\": \"string\", // Balance deduction discount price\n \"list_price\": \"string\" // Balance deduction list price\n },\n \"created_at\": 1722769557708, // Task creation time, Unix timestamp, unit: ms\n \"updated_at\": 1722769557708, // Task update time, Unix timestamp, unit: ms\n \"watermark_info\": { \"enabled\": boolean },\n \"task_result\": {\n \"result_type\": \"single\",\n \"images\": [\n {\n \"index\": 0, // Image number\n \"url\": \"string\", // URL for generated image, anti-hotlinking format (Generated images/videos will be cleared after 30 days. Please save promptly.)\n \"watermark_url\": \"string\" // Watermarked image download URL\n }\n ],\n \"series_images\": [\n {\n \"index\": 0, // Series-image sequence number\n \"url\": \"string\", // URL for generated image, anti-hotlinking format\n \"watermark_url\": \"string\" // Watermarked image download URL\n }\n ]\n }\n }\n ]\n}\nRequest Header\nContent-Type\nstring\nRequired\nDefault to application/json\n\nData Exchange Format\n\nAuthorization\nstring\nRequired\n\nAuthentication information, refer to API authentication\n\nQuery Parameters\npageNum\nint\nOptional\nDefault to 1\n\nPage number\n\nValue range: [1, 1000]\npageSize\nint\nOptional\nDefault to 30\n\nNumber of items per page\n\nValue range: [1, 500]\nKling Image 3.0 & 3.0 Omni - Image Generation\nKling Image 3.0 & 3.0 Omni - Element Management\nCreate Task\nInvocation Examples\nQuery Task (Single)\nQuery Task (List)\nContact Us\n[New Release] Kling 4.0 API Is Now Officially Live and Ready for Integration!\n\nKling 4.0 API is now fully available. As a next-generation native multimodal model for AI video creation, Kling 4.0 delivers a comprehensive upgrade in audiovisual performance, complex motion stability, Omni reference consistency. Empower every idea into production-ready video efficiently!\n\n\n\n\nImportant Note: To call the Kling 4.0 model, please purchase the Flagship Resource Pack or contact your account manager to top up your account balance.\n\n\n\n\nKling 4.0 Upgrade Highlights:\n\nDynamic Motions: Delivers smoother performance in complex motion and camera moves, tailored for high-dynamic content.\nNative 30s Generation: Generates up to 30 seconds of high-quality video in a single run, reducing style and character drift caused by multi-segment stitching.\nOmni Reference: Supports precise recognition and combination of up to 15 references, significantly enhancing cross-shot consistency.\nMulti-keyframe Control: Supports up to 10 keyframe inputs to precisely anchor characters, scenes, and narrative beats.\nCreative Recreation: Rapidly recreate proven concepts from reference videos to boost batch production efficiency.\nVideo Editing: Precise localized edits and style adjustments for completed videos, reducing rework costs.\n\n\n\nKling 4.0 ReleaseNote\n\n\n\n\nClick to get instant access. We can’t wait to see the story you’ll build with Kling 4.0!\n\nDon't show again\nIntegrate Now" \ No newline at end of file diff --git a/pipeline/provider_docs/luma__docs.agents.lumalabs.ai_api_resources_generations_methods_create_index.md b/pipeline/provider_docs/luma__docs.agents.lumalabs.ai_api_resources_generations_methods_create_index.md new file mode 100644 index 0000000000000000000000000000000000000000..575a305cdea95b0b4a9ea09479300ec637d9e50c --- /dev/null +++ b/pipeline/provider_docs/luma__docs.agents.lumalabs.ai_api_resources_generations_methods_create_index.md @@ -0,0 +1,677 @@ +## Create a generation + +**post** `/generations` + +Submit an image or video generation job. Returns immediately with an opaque job ID to poll via GET /generations/{id}. + +### Body Parameters + +- `prompt: string` + + Text prompt + +- `aspect_ratio: optional "3:1" or "2:1" or "21:9" or 10 more` + + Output aspect ratio. Valid values depend on the selected model and generation type; the server validates the final model-specific set. + + - `"3:1"` + + - `"2:1"` + + - `"21:9"` + + - `"16:9"` + + - `"4:3"` + + - `"3:2"` + + - `"1:1"` + + - `"4:5"` + + - `"3:4"` + + - `"2:3"` + + - `"9:16"` + + - `"1:2"` + + - `"1:3"` + +- `image_ref: optional array of ImageRef` + + Reference images for style/content guidance. Up to 9 for type 'image', up to 8 for type 'image_edit'. + + - `data: optional string` + + Base64-encoded image or video data + + - `file_id: optional string` + + UUID of a file previously uploaded via POST /files. Skips URL fetch / base64 decode and reuses the file's pre-moderated backing artifact. The referenced file must be owned by the same client and in state=ready. See the Files API for the upload flow. + + - `generation_id: optional string` + + UUID of a prior generation owned by the same caller. Used on source for image_edit, video_edit, and video_reframe chaining and on video.start_frame / video.end_frame for video extension. + + - `media_type: optional string` + + MIME type (for example, image/jpeg or video/mp4). Required with data. Required with source.url on video_edit/video_reframe so the route can dispatch video ingest before fetching bytes; optional for image URLs. + + - `url: optional string` + + Publicly accessible image URL, or a video URL when used as source for video_edit/video_reframe with media_type=video/*. + +- `layering: optional object { resolution }` + + Layering options. Applies only to type=layering; rejected on every other type. The image to split goes in source, and prompt may carry optional guidance for how to split it (up to 500 characters, may be empty). Unknown keys are rejected rather than ignored. + + - `resolution: optional "1k" or "2k"` + + Output resolution for every layer. 2k re-renders each layer at higher quality and costs more; either is one flat price per generation, whatever the number of layers. + + - `"1k"` + + - `"2k"` + +- `model: optional Model` + + Model identifier. `uni-1` is the default image tier; `uni-1-max` produces higher-quality output than `uni-1` at a higher per-image price. `ray-3.2` is the public video model for text-to-video, image-to-video, and video-to-video editing. + + - `"uni-1"` + + - `"uni-1-max"` + + - `"ray-3.2"` + +- `output_format: optional "png" or "jpeg"` + + Output image format + + - `"png"` + + - `"jpeg"` + +- `source: optional ImageRef` + + Media reference for guided generation. Provide exactly one of url, inline base64 data, generation_id, or file_id. URL/data references accept image media at image positions; video_edit and video_reframe sources also accept source.url or source.data when source.media_type is a video/* MIME. generation_id chains image_edit off a prior image output, video_edit/video_reframe off a prior video output, and video.start_frame/end_frame for extension. file_id references a file previously uploaded via POST /files — see the Files API. + + - `data: optional string` + + Base64-encoded image or video data + + - `file_id: optional string` + + UUID of a file previously uploaded via POST /files. Skips URL fetch / base64 decode and reuses the file's pre-moderated backing artifact. The referenced file must be owned by the same client and in state=ready. See the Files API for the upload flow. + + - `generation_id: optional string` + + UUID of a prior generation owned by the same caller. Used on source for image_edit, video_edit, and video_reframe chaining and on video.start_frame / video.end_frame for video extension. + + - `media_type: optional string` + + MIME type (for example, image/jpeg or video/mp4). Required with data. Required with source.url on video_edit/video_reframe so the route can dispatch video ingest before fetching bytes; optional for image URLs. + + - `url: optional string` + + Publicly accessible image URL, or a video URL when used as source for video_edit/video_reframe with media_type=video/*. + +- `style: optional "auto" or "manga"` + + Style preset (auto, manga) + + - `"auto"` + + - `"manga"` + +- `type: optional "image" or "image_edit" or "video" or 3 more` + + The kind of generation to perform + + - `"image"` + + - `"image_edit"` + + - `"video"` + + - `"video_edit"` + + - `"video_reframe"` + + - `"layering"` + +- `user_id: optional string` + + Your end-user's stable opaque identifier (no PII). Forwarded to upstream model providers as their per-user tagging field so trust & safety violations can be attributed to a specific end-user rather than the whole API account. Also used for per-end-user usage breakdowns in /v1/usage. Strongly recommended for partner integrations. + +- `video: optional VideoOptions` + + Ray 3.2 video request options. Common output settings live at the top level for `type=video`, `type=video_edit`, and `type=video_reframe`; video-to-video conditioning lives under `edit`. + + - `duration: optional VideoDuration` + + Video duration + + - `"5s"` + + - `"10s"` + + - `edit: optional VideoEditOptions` + + Ray 3.2 video-to-video edit controls. Only valid under `video.edit` when `type` is `video_edit`. The source video must be 18 seconds or shorter; output duration matches the source. + + - `auto_controls: optional boolean` + + When true, the model derives the control schedule from the source video. When omitted, supplying strength or controls implies manual mode. + + - `controls: optional AdvancedControls` + + Per-signal manual conditioning controls for video edits + + - `depth: optional DepthControl` + + Depth / scene-geometry conditioning control + + - `blur: optional number` + + Depth-map blur amount from 0 to 1. Higher values allow more geometric freedom. + + - `enabled: optional boolean` + + Enable or disable depth conditioning. Omit to use the model default. + + - `face: optional FaceControl` + + Face-identity conditioning control + + - `enabled: optional boolean` + + Enable or disable face conditioning. Omit to use the model default. + + - `normals: optional NormalsControl` + + Surface-normals conditioning control + + - `augmentation: optional number` + + Surface-normals augmentation from 0 to 1. Higher values allow more reinterpretation of surface geometry. + + - `enabled: optional boolean` + + Enable or disable normals conditioning. Omit to use the model default. + + - `pose: optional PoseControl` + + Pose / skeleton conditioning control + + - `enabled: optional boolean` + + Enable or disable pose conditioning. Omit to use the model default. + + - `strength: optional PoseControlStrength` + + Pose-conditioning strength + + - `"precise"` + + - `"coarse"` + + - `trajectory: optional TrajectoryControl` + + Motion-trajectory conditioning control + + - `enabled: optional boolean` + + Enable or disable trajectory conditioning. Omit to use the model default. + + - `sparsity: optional number` + + Point-trajectory sparsity from 0 to 1. Higher values use fewer motion anchors. + + - `keyframe_indexes: optional array of number` + + Parallel list of non-negative, unique frame positions in the source video's frame grid where each keyframes[i] is anchored. Must match keyframes in length. + + - `keyframes: optional array of ImageRef` + + Multi-anchor guide-frame images at arbitrary source-frame positions (parallel with keyframe_indexes). Up to 64 anchors. Mutually exclusive with video.start_frame (the single-anchor case). Each entry takes the same ImageRef shape as source / image_ref[]. + + - `data: optional string` + + Base64-encoded image or video data + + - `file_id: optional string` + + UUID of a file previously uploaded via POST /files. Skips URL fetch / base64 decode and reuses the file's pre-moderated backing artifact. The referenced file must be owned by the same client and in state=ready. See the Files API for the upload flow. + + - `generation_id: optional string` + + UUID of a prior generation owned by the same caller. Used on source for image_edit, video_edit, and video_reframe chaining and on video.start_frame / video.end_frame for video extension. + + - `media_type: optional string` + + MIME type (for example, image/jpeg or video/mp4). Required with data. Required with source.url on video_edit/video_reframe so the route can dispatch video ingest before fetching bytes; optional for image URLs. + + - `url: optional string` + + Publicly accessible image URL, or a video URL when used as source for video_edit/video_reframe with media_type=video/*. + + - `strength: optional VideoEditStrength` + + How much a video edit preserves or reimagines the source + + - `"adhere_1"` + + - `"adhere_2"` + + - `"adhere_3"` + + - `"flex_1"` + + - `"flex_2"` + + - `"flex_3"` + + - `"reimagine_1"` + + - `"reimagine_2"` + + - `"reimagine_3"` + + - `end_frame: optional ImageRef` + + Media reference for guided generation. Provide exactly one of url, inline base64 data, generation_id, or file_id. URL/data references accept image media at image positions; video_edit and video_reframe sources also accept source.url or source.data when source.media_type is a video/* MIME. generation_id chains image_edit off a prior image output, video_edit/video_reframe off a prior video output, and video.start_frame/end_frame for extension. file_id references a file previously uploaded via POST /files — see the Files API. + + - `exr_export: optional boolean` + + Export EXR alongside the MP4. Requires hdr=true. + + - `guide_frame: optional ImageRef` + + Media reference for guided generation. Provide exactly one of url, inline base64 data, generation_id, or file_id. URL/data references accept image media at image positions; video_edit and video_reframe sources also accept source.url or source.data when source.media_type is a video/* MIME. generation_id chains image_edit off a prior image output, video_edit/video_reframe off a prior video output, and video.start_frame/end_frame for extension. file_id references a file previously uploaded via POST /files — see the Files API. + + - `hdr: optional boolean` + + Generate HDR video. Requires HDR access. Not supported for video_reframe. + + - `keyframe_indexes: optional array of number` + + Parallel list of non-negative, unique output-frame positions where each keyframes[i] is anchored, in the duration x 24fps grid (5s -> 0..120, 10s -> 0..240). Must match keyframes in length. + + - `keyframes: optional array of ImageRef` + + Image-to-video guide frames (type=video only), each pinned to an output-frame position via the parallel keyframe_indexes. 1-64 anchors: a single anchor is a valid start-pinned i2v (an alternate to start_frame), and any count up to 64 places guide frames at arbitrary positions. Unlike start_frame/end_frame (the legacy 2-frame surface), this supports arbitrary positions, 10s durations, and HDR. Mutually exclusive with start_frame / end_frame / loop. Only supported on model ray-3.2. For video-to-video keyframes use video.edit.keyframes on type=video_edit instead. + + - `data: optional string` + + Base64-encoded image or video data + + - `file_id: optional string` + + UUID of a file previously uploaded via POST /files. Skips URL fetch / base64 decode and reuses the file's pre-moderated backing artifact. The referenced file must be owned by the same client and in state=ready. See the Files API for the upload flow. + + - `generation_id: optional string` + + UUID of a prior generation owned by the same caller. Used on source for image_edit, video_edit, and video_reframe chaining and on video.start_frame / video.end_frame for video extension. + + - `media_type: optional string` + + MIME type (for example, image/jpeg or video/mp4). Required with data. Required with source.url on video_edit/video_reframe so the route can dispatch video ingest before fetching bytes; optional for image URLs. + + - `url: optional string` + + Publicly accessible image URL, or a video URL when used as source for video_edit/video_reframe with media_type=video/*. + + - `loop: optional boolean` + + Generate a seamlessly looping video. Only valid for type=video; not supported with duration=10s or hdr=true. + + - `resolution: optional VideoResolution` + + Ray 3.2 video output resolution. 360p is the draft tier (fast, low-cost previews), accepted on type=video, video_edit, and video_reframe; on type=video it is SDR-only (not valid with hdr=true). 1080p is public for video generation; video_reframe 1080p is still rolling out and may return a coming-soon validation error until enabled for the caller. + + - `"360p"` + + - `"540p"` + + - `"720p"` + + - `"1080p"` + + - `source_position: optional SourcePosition` + + Normalized source rectangle inside the output canvas for video_reframe. Omit to let the model choose the default centered-fit crop. + + - `h_norm: number` + + Source rectangle height, as a fraction of canvas height. Up to 2.0 so the source can bleed off-canvas. + + - `w_norm: number` + + Source rectangle width, as a fraction of canvas width. Up to 2.0 so the source can bleed off-canvas. + + - `x_norm: number` + + Left edge of the source rectangle, as a fraction of canvas width. May be negative when the source extends off-canvas. + + - `y_norm: number` + + Top edge of the source rectangle, as a fraction of canvas height. May be negative when the source extends off-canvas. + + - `start_frame: optional ImageRef` + + Media reference for guided generation. Provide exactly one of url, inline base64 data, generation_id, or file_id. URL/data references accept image media at image positions; video_edit and video_reframe sources also accept source.url or source.data when source.media_type is a video/* MIME. generation_id chains image_edit off a prior image output, video_edit/video_reframe off a prior video output, and video.start_frame/end_frame for extension. file_id references a file previously uploaded via POST /files — see the Files API. + +- `web_search: optional boolean` + + Enable web search grounding — the agent can search the web and download reference images before generating. + +### Returns + +- `Generation = object { id, created_at, model, 5 more }` + + Generation status and output + + - `id: string` + + Generation identifier + + - `created_at: string` + + Creation timestamp + + - `model: Model` + + Model used + + - `"uni-1"` + + - `"uni-1-max"` + + - `"ray-3.2"` + + - `state: "queued" or "processing" or "completed" or "failed"` + + Current state of the generation + + - `"queued"` + + - `"processing"` + + - `"completed"` + + - `"failed"` + + - `type: "image" or "image_edit" or "video" or 3 more` + + The kind of generation to perform + + - `"image"` + + - `"image_edit"` + + - `"video"` + + - `"video_edit"` + + - `"video_reframe"` + + - `"layering"` + + - `failure_code: optional GenerationFailureCode` + + Machine-readable failure code for programmatic handling + + - `"content_moderated"` + + - `"generation_failed"` + + - `"budget_exhausted"` + + - `"output_not_found"` + + - `"image_too_large"` + + - `"unsupported_format"` + + - `"corrupt_input"` + + - `"invalid_request"` + + - `"rate_limited"` + + - `failure_reason: optional string` + + Human-readable failure description + + - `output: optional array of GenerationOutput` + + Generated outputs (populated on completion) + + - `type: string` + + Media type (e.g. image, video) + + - `url: string` + + Presigned URL (1hr expiry) + + - `layer: optional object { alpha_hint, description, index, 4 more }` + + Per-layer semantics for a type=layering output + + - `alpha_hint: string` + + Edge treatment of the layer's transparency — soft (hair/fur/glass), hard (solid edges), or none (the opaque background) + + - `description: string` + + Complete-element caption for the layer's content + + - `index: number` + + Layer position, front-to-back; the last layer is the background + + - `label: string` + + Short (1-2 word) layer name + + - `bounds: optional object { canvas_height, canvas_width, height, 3 more }` + + Where a layer's returned pixels sit inside the full composite frame. Layer images are cropped to their visible-alpha bounding box, so layers of one stack have differing pixel dimensions. Composite onto a transparent canvas_width x canvas_height image by pasting each layer at (x, y), iterating the output list in reverse (back-to-front), to reconstruct the source frame. + + - `canvas_height: number` + + Height of the full composite canvas the layers reassemble into + + - `canvas_width: number` + + Width of the full composite canvas the layers reassemble into + + - `height: number` + + Pixel height of the returned layer image + + - `width: number` + + Pixel width of the returned layer image + + - `x: number` + + Left offset of this layer's pixels within the composite canvas + + - `y: number` + + Top offset of this layer's pixels within the composite canvas + + - `contains_text: optional boolean` + + Whether the layer was planned as typeset text (a headline, caption, or label) rather than an image element. Null when not reported for this generation. + + - `text: optional object { content, decorated, font }` + + The text on one live-text layer, as a string plus how it is styled. Placement is the owning layer's bounds — the text fills that box. + + - `content: string` + + The text as shown, preserving capitalization; one line per line (newline-separated) + + - `decorated: optional boolean` + + True when the lettering is ornamental (outlines, patterned fills, bevels, drop shadows), so plain typeset text will not reproduce its look. + + - `font: optional object { category, families, italic, 3 more }` + + Described letterform traits of a text layer — enough to pick a matching font. + + - `category: "sans serif" or "serif" or "slab serif" or 6 more` + + Letterform style + + - `"sans serif"` + + - `"serif"` + + - `"slab serif"` + + - `"display sans"` + + - `"display serif"` + + - `"display slab"` + + - `"display decorative"` + + - `"handwriting"` + + - `"monospace"` + + - `families: array of string` + + Up to three Google Fonts family names that resemble the lettering, closest first. Empty when none of the offered families fit. + + - `italic: boolean` + + Whether the letters are slanted or cursive + + - `weight: "thin" or "light" or "regular" or 3 more` + + Stroke weight + + - `"thin"` + + - `"light"` + + - `"regular"` + + - `"medium"` + + - `"bold"` + + - `"black"` + + - `width: "condensed" or "normal" or "wide"` + + Letter width for its height + + - `"condensed"` + + - `"normal"` + + - `"wide"` + + - `match: optional object { face_id, family_id, family_name, 2 more }` + + The font in your font catalog that the lettering matches, so you can re-set the text in it. Absent when no catalog font matches closely enough, or matching is not enabled. The image itself is not rendered in this font. + + - `face_id: string` + + Typed ref of the matched face (one weight and style), font_face: + + - `family_id: string` + + Typed ref of the matched font family, font_family: + + - `family_name: string` + + Name of the matched font family + + - `style: "normal" or "italic"` + + Style of the matched face + + - `"normal"` + + - `"italic"` + + - `weight: number` + + CSS font weight of the matched face, e.g. 400 or 700 + +### Example + +```http +curl https://agents.lumalabs.ai/v1/generations \ + -H 'Content-Type: application/json' \ + -H "Authorization: Bearer $LUMA_AGENTS_API_KEY" \ + -d '{ + "prompt": "A glass of iced coffee on a marble countertop, morning light streaming through a window" + }' +``` + +#### Response + +```json +{ + "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", + "created_at": "created_at", + "model": "uni-1", + "state": "queued", + "type": "image", + "failure_code": "content_moderated", + "failure_reason": "failure_reason", + "output": [ + { + "type": "type", + "url": "https://example.com", + "layer": { + "alpha_hint": "alpha_hint", + "description": "description", + "index": 0, + "label": "label", + "bounds": { + "canvas_height": 0, + "canvas_width": 0, + "height": 0, + "width": 0, + "x": 0, + "y": 0 + }, + "contains_text": true, + "text": { + "content": "content", + "decorated": true, + "font": { + "category": "sans serif", + "families": [ + "string" + ], + "italic": true, + "weight": "thin", + "width": "condensed", + "match": { + "face_id": "face_id", + "family_id": "family_id", + "family_name": "family_name", + "style": "normal", + "weight": 0 + } + } + } + } + } + ] +} +``` diff --git a/pipeline/provider_docs/luma__docs.agents.lumalabs.ai_guides_faq_index.md b/pipeline/provider_docs/luma__docs.agents.lumalabs.ai_guides_faq_index.md new file mode 100644 index 0000000000000000000000000000000000000000..19f64eefd33412d886c8f6c313f5172468d51a22 --- /dev/null +++ b/pipeline/provider_docs/luma__docs.agents.lumalabs.ai_guides_faq_index.md @@ -0,0 +1,728 @@ +--- +title: FAQ | Luma Agents +description: Frequently asked questions about the Luma Agents API — uni-1, uni-1-max, Ray 3.2, prompts, aspect ratios, reference images, image editing, video editing and reframing, rate limits, billing, moderation, and more. +--- + +Answers to common questions about the Luma Agents API — [`uni-1`](/guides/model/index.md#uni-1) and [`uni-1-max`](/guides/model/index.md#uni-1-max) for images, and [`ray-3.2`](/guides/model/index.md#ray-32) for video. Each section links into the relevant guide for deeper detail; the [API Reference](/api/index.md) is the complete schema. + +Can’t find your question? Email . Include the `X-Request-Id` from the affected response — see [Request tracing](/guides/rate-limits/index.md#using-x-request-id-for-tracing). + +## Getting started + +What is the Luma Agents API? + +A REST API for generating and editing images and videos with Luma’s models — `uni-1` and `uni-1-max` for images, `ray-3.2` for video. A single endpoint, `POST /v1/generations`, handles image generation, image editing, video generation / extension, video editing, and video reframing. Submit a job, poll `GET /v1/generations/{id}`, then download the image or video from the presigned URL. See the [Quickstart](/index.md) for an end-to-end example. + +What is uni-1? + +`uni-1` is Luma’s unified image generation and editing model. It handles text-to-image and image-to-image through the same endpoint, with support for text rendering, spatial reasoning, multi-panel output, and style transfer. See [Models](/guides/model/index.md) for the capability matrix. + +What is uni-1-max? + +`uni-1-max` produces higher-quality output than `uni-1`. Same wire format and parameter set — same prompts, same `aspect_ratio`, same `image_ref` semantics. See [Pricing](/guides/pricing/index.md) for the exact per-image table. Available to all accounts — pass `"model": "uni-1-max"` on `POST /v1/generations`. + +When should I use uni-1-max vs uni-1? + +Use `uni-1` for the broad set of generation and editing tasks — it’s the default and the lowest cost. Use `uni-1-max` when you want higher-quality output and the per-image cost increase is justified for the workload (e.g. final hero images, ad creative, anything where re-generations are expensive). The two models accept identical parameters; you can switch by changing only the `model` field on the request. + +What is Ray 3.2? + +Ray 3.2 is Luma’s video model on the Agents API. It handles text-to-video and image-to-video (`type: "video"`, with optional `video.start_frame` / `video.end_frame` anchor images), single-keyframe video extend, video editing (`type: "video_edit"`), and aspect-ratio reframing (`type: "video_reframe"`). See [Models — `ray-3.2`](/guides/model/index.md#ray-32), [Video generation](/guides/videos/generation/index.md), [Video editing](/guides/videos/editing/index.md), and [Video reframing](/guides/videos/reframing/index.md). + +What is `source.generation_id`? + +`source.generation_id` is the top-level `id` of a prior completed video generation owned by the same client. Pass it on `type: "video_edit"` to edit a video, or on `type: "video_reframe"` to reframe it. It’s one of three ways to supply the source video — you can also pass a hosted `source.url` or inline base64 `source.data`, each with a `video/*` `source.media_type`. See [How do I supply the source video for an edit or reframe?](#video-editing-and-reframing-ray-32) below, and [Video editing — source video](/guides/videos/editing/index.md#referencing-the-source-video). + +How do I get an API key? + +Create an account at [platform.lumalabs.ai](https://platform.lumalabs.ai), generate a key from the developer dashboard, and set it as `LUMA_AGENTS_API_KEY`: + +```bash +export LUMA_AGENTS_API_KEY="luma-api-..." +``` + +Keys start with the prefix `luma-api-`. Treat them like passwords; never commit them to source control or ship them to client-side code. + +I lost my API key. Can I retrieve it? + +No. The raw key is shown exactly once, at creation. The server stores only a hash. Revoke the lost key from the dashboard and create a new one. + +Can I have multiple API keys? + +Yes. Create as many keys as you need and name each one (e.g. `production`, `staging`) for tracking and selective revocation. + +Generations, rate limits, and concurrent-job slots are scoped to the **client**, not the individual key. Multiple keys belonging to the same client share quota and can poll each other’s generations. To get isolated quota or visibility, ask support to provision a separate client, not just another key. + +What is the base URL? + +```plaintext +https://agents.lumalabs.ai/v1 +``` + +There is no staging or sandbox environment. Use a test key and small generations to experiment. + +How do I authenticate requests? + +Pass your API key as a Bearer token in the `Authorization` header. Both endpoints require authentication; missing or malformed auth is rejected. + +```bash +curl -X POST https://agents.lumalabs.ai/v1/generations \ + -H "Authorization: Bearer $LUMA_AGENTS_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{"prompt": "A sunset over the ocean"}' +``` + +Which SDKs are available? + +Official Python, TypeScript, Go, and CLI SDKs are available — generated from the OpenAPI spec. Generation request types cover both image options (`uni-1` / `uni-1-max`) and video options (`VideoOptions`, including the `edit` controls for `ray-3.2`). See [SDKs](/index.md#sdks) in the Quickstart for install commands. + +Is the API synchronous or asynchronous? + +Asynchronous. `POST /v1/generations` returns `201` immediately with a job ID and `state: "queued"`. Poll `GET /v1/generations/{id}` until the state reaches `completed` or `failed`. Image generations typically take 30–60 seconds; video generations take longer — tune your initial wait and deadline accordingly. See the [Quickstart](/index.md) for the full pattern. + +--- + +## Prompts + +What is the maximum prompt length? + +6,000 characters. Prompts must be between 1 and 6,000 characters; anything outside that range is rejected. Clarity matters more than length — most production prompts fit comfortably under 1,000 characters. + +What is the minimum prompt length? + +1 character. Empty strings are rejected. A few words is usually enough; longer, more specific prompts produce better results. + +Does uni-1 support non-English prompts? + +`uni-1` is optimized for English. Other languages may work to varying degrees, but results are less reliable. Write prompts in English, or translate before sending, for best output. + +Does the API support negative prompts? + +No. There is no `negative_prompt` parameter. Describe what you do want, positively — “a serene empty beach at dawn” works better than “a beach without people”. + +How do I render text inside an image? + +Put the exact text in quotes inside your prompt so the model knows to render it literally: + +```json +{ + "prompt": "A coffee shop storefront with a wooden sign that reads \"MORNING BREW\" in hand-painted serif letters" +} +``` + +Shorter strings (under roughly 20 characters) render most reliably. Long passages of text may be partially garbled. + +Can I reproduce the same image from the same prompt? + +Not deterministically. Each generation uses a different random seed and there is no public `seed` parameter. For visual consistency across multiple images, pair the same prompt with one or more `image_ref` references as style anchors — see [Image generation: image\_ref](/guides/images/generation/index.md#image_ref). + +How should I structure my prompts? + +Be specific about subject, setting, lighting, style, and composition. Name styles explicitly (“oil painting”, “35mm film photograph”) rather than hoping the model infers them. For edits, describe only the change. For multi-reference requests, label each reference’s role (“use the color palette from the first reference”). See the [Image generation guide](/guides/images/generation/index.md) for worked examples. + +--- + +## Aspect ratios and output + +Which aspect ratios are supported? + +Twelve values total across image and video models, but the valid set is **model-and-type-dependent**. Image models (`uni-1`, `uni-1-max`) accept nine: `3:1`, `2:1`, `16:9`, `3:2`, `1:1`, `2:3`, `9:16`, `1:2`, `1:3`. Ray 3.2 video accepts six: `9:16`, `3:4`, `1:1`, `4:3`, `16:9`, `21:9`. Video edits derive the aspect ratio from the source video and ignore the request value. See [Image generation — `aspect_ratio`](/guides/images/generation/index.md#aspect_ratio) and [Video generation — `aspect_ratio`](/guides/videos/generation/index.md#aspect_ratio). + +What is the default aspect ratio? + +There is no fixed default. When `aspect_ratio` is omitted or `null`, the model selects a ratio based on the prompt. Pass `"16:9"` explicitly if you want a consistent widescreen default — `uni-1` is generally tuned best at 16:9. Defaults differ per model; for video, see [Video generation — `aspect_ratio`](/guides/videos/generation/index.md#aspect_ratio). + +What output formats does uni-1 support? + +Two: `png` (lossless, best for graphics and sharp-edged content) and `jpeg` (smaller files, best for photographs). Omit `output_format` to let the model pick based on the prompt. + +What is the output resolution? + +For `type: "image"`, the model picks the resolution based on the chosen aspect ratio — there is no `1K/2K/4K` selector. For `type: "image_edit"`, the output preserves the source image’s original dimensions. For video, set the output resolution explicitly via `video.resolution` (`540p` / `720p` / `1080p`). + +What colour space are EXR video outputs in? + +EXR files exported with `video.exr_export: true` are in the **AP0 (ACES2065-1)** colour space — the linear, scene-referred ACES interchange primaries used across professional colour-grading pipelines. `exr_export` requires `video.hdr: true`; the MP4 delivered alongside is HDR-encoded, while the EXR carries the wider-gamut ACES data for grading. See [Video generation — `video.exr_export`](/guides/videos/generation/index.md#videoexr_export). + +Can I generate multiple images in a single request? + +No. Each request returns one image. To generate variations, submit multiple requests in parallel, up to your plan’s concurrent-job ceiling (see [Rate limits](/guides/rate-limits/index.md)). + +For multi-panel layouts (e.g. a 4-panel storyboard on one canvas), describe the layout in the prompt and pick an appropriate aspect ratio. + +How long do output URLs remain valid? + +Output URLs are presigned and valid for 1 hour. After that the link stops working. To get a fresh URL, call `GET /v1/generations/{id}` again — every poll mints a new presigned URL with a fresh 1-hour window. Download to your own storage promptly; do not hand presigned URLs to end users. + +--- + +## Image editing and reference images + +Can I edit existing images, or is this text-to-image only? + +`uni-1` supports both. Use `type: "image"` for text-to-image (with optional `image_ref` for style or content guidance) and `type: "image_edit"` for image-to-image editing (provide a `source` image and describe the change). See [Image editing](/guides/images/editing/index.md) for full details. + +What is the difference between `source` and `image_ref`? + +`source` is the image you want to edit on `type: "image_edit"`; it is rejected for `type: "image"`. `image_ref` is an optional list of reference images for style, color, or composition guidance, available on both image types. On `image_edit`, the `source` occupies one of the 9 reference slots, leaving up to 8 entries for `image_ref`. Videos reuse `source` for a different media contract: `source.generation_id` (a prior video generation), a hosted `source.url`, or inline `source.data` — the last two with a `video/*` `source.media_type` — on `type: "video_edit"` and `type: "video_reframe"`. See [Video editing — source video](/guides/videos/editing/index.md#referencing-the-source-video). + +How many reference images can I pass? + +Up to 9 for `type: "image"`, or up to 8 for `type: "image_edit"` (the `source` image takes the ninth slot). Exceeding either limit is rejected. + +What is the maximum image size for `source` and `image_ref`? + +50 MB per image (52,428,800 bytes). The limit applies to both URL-fetched and base64-encoded images, and to both `source` and `image_ref` entries. Oversized payloads are rejected, with the offending field name in the `detail`: + +```json +{ "detail": "source: image exceeds 50 MB limit" } +{ "detail": "image_ref[2]: image exceeds 50 MB limit" } +``` + +For URL fetches the proxy streams the response and aborts when it crosses 50 MB. For base64, the limit is checked on the decoded byte length. For production traffic, target under 4 MB per image at JPEG quality 85–92. + +There’s also a dimension cap: each side must be **8000 px or less**. Larger images are rejected before any generation runs: + +```json +{ + "detail": "source: image is 12000x8000px but each side must be <= 8000px. Resize and try again." +} +``` + +What image formats can I upload for reference or source? + +Common raster formats — JPEG, PNG, WebP, and still-frame GIF — are accepted. When you send base64 `data`, `media_type` is required (e.g. `"image/jpeg"`, `"image/png"`). Non-image content (PDF, video, HTML) is rejected with `"image_ref[0]: content-type is not an image"`. + +URL or base64: which should I use? + +Each `source` and `image_ref` entry must provide exactly one of `url` or `data`. Never both, never neither: + +| Entry shape | Result | +| --------------------------------------------- | ----------------------------------------------------------------------- | +| `{"url": "https://..."}` | Valid | +| `{"data": "...", "media_type": "image/jpeg"}` | Valid | +| `{"url": "...", "data": "..."}` | Rejected: `"image_ref[0]: provide either 'url' or 'data', not both"` | +| `{}` | Rejected: `"image_ref[0]: provide either 'url' or 'data', not neither"` | +| `{"data": "..."}` without `media_type` | Rejected: `"image_ref[0]: 'media_type' is required with 'data'"` | + +Use a URL when the image is already hosted publicly; it avoids upload bandwidth on your side. Use base64 for **small** private images, local files, dev environments, or when the URL ingestion subsystem is temporarily unavailable (see [Service unavailable](/guides/error-handling/index.md#503--service-unavailable)). For anything large, prefer a hosted `url` — or, when editing, a prior `generation_id` — instead of inlining. + +What requirements does a reference URL need to meet? + +URLs are fetched server-side through a Cloudflare edge proxy with strict SSRF protection. The URL must: + +- Use `https://` (plain `http://` is rejected). +- Resolve to a public IP. RFC1918, loopback, and link-local addresses are rejected. +- Not redirect from HTTPS to HTTP at any point in the chain. +- Resolve via public DNS (the proxy cannot reach VPNs or internal hostnames). +- Return a successful response with an `image/*` content-type. +- Be under 50 MB and respond within roughly 18 seconds. + +Signed URLs (e.g. S3 presigned, Cloudinary signed delivery) work as long as the signature is valid at request time. If you can’t meet these requirements, send the image as base64 `data`. + +Does uni-1 support inpainting or outpainting with masks? + +No. There is no mask parameter. Editing is prompt-based: describe the change in natural language and `uni-1` applies it while preserving unmentioned parts of the image. Examples — “replace the background with a tropical beach at sunset”, “change the car’s color to midnight blue”, “convert to a bold manga illustration with clean ink outlines”. + +Can I control how closely the output follows a reference image? + +There is no explicit strength or adherence slider; control is through the prompt. For loose guidance, name the attribute you want (“use the color palette from the reference”). For tight guidance, be specific (“closely match the composition, color grading, and lighting of the reference, but change the subject to a jazz musician”). With multiple references, label each one’s role so the model doesn’t have to guess. + +Does an edit preserve the source image’s dimensions? + +Yes. For `type: "image_edit"`, the output matches the source image’s width and height. Do not pass `aspect_ratio` on edit requests — it is silently ignored. + +--- + +## Advanced generation features + +What styles are supported? + +Two `style` values: `auto` (the default; the model picks based on your prompt) and `manga` (multi-panel comic-page aesthetic with ink outlines and screentone shading). `manga` requires a portrait aspect ratio — `2:3`, `9:16`, `1:2`, or `1:3` — and is rejected for landscape or square ratios. For other stylized looks (oil painting, film noir, anime illustration, ukiyo-e), leave `style` at `auto` and describe the style in the prompt. + +Which aspect ratios work with `style: "manga"`? + +Four portrait values: `2:3`, `9:16`, `1:2`, and `1:3`. You can also omit `aspect_ratio` entirely and let the model pick a portrait one. Pairing `style: "manga"` with any of the landscape or square ratios (`3:1`, `2:1`, `16:9`, `3:2`, `1:1`) is rejected at submit time on `type: "image"` requests: + +```json +{ + "detail": "aspect_ratio='1:1' is not allowed when style='manga'. Valid aspect_ratio: 1:2, 1:3, 2:3, 9:16" +} +``` + +The response is HTTP 422. The `Valid aspect_ratio:` list always names the four portrait ratios you can use. On `type: "image_edit"` the constraint does not apply — output dimensions come from the source image, not the body — so `style: "manga"` works on edits regardless of the source’s ratio. See [Image generation — `style: "manga"` aspect-ratio constraint](/guides/images/generation/index.md#style-manga-aspect-ratio-constraint). + +Which aspect ratios work with `style: "auto"`? + +All nine — `3:1`, `2:1`, `16:9`, `3:2`, `1:1`, `2:3`, `9:16`, `1:2`, `1:3`. There is no `style="auto"`-specific restriction. Omit `aspect_ratio` and the model picks one based on the prompt; pass a value to force a specific ratio. + +Does `aspect_ratio` apply to image edits? + +No. For `type: "image_edit"`, the output dimensions are determined by the source image and `aspect_ratio` is silently ignored. To change an image’s aspect ratio, crop the source yourself before sending. + +What does `web_search: true` do? + +The model searches the web for visual references before generating, then uses what it finds to ground the output. This noticeably improves accuracy for prompts that name real-world landmarks, products, or public figures. Web search adds a few seconds of latency, so leave it off for purely imaginative prompts. + +```json +{ + "prompt": "The Eiffel Tower at golden hour with cherry blossoms in the foreground", + "web_search": true +} +``` + +Can I generate a video with this API? + +Yes. Set `model: "ray-3.2"` and `type: "video"` for text-to-video, image-to-video, or single-keyframe extend; use `type: "video_edit"` with a source video (`source.generation_id`, `source.url`, or `source.data`) for video editing; use `type: "video_reframe"` to change a video’s aspect ratio. See [Video generation](/guides/videos/generation/index.md), [Video editing](/guides/videos/editing/index.md), and [Video reframing](/guides/videos/reframing/index.md). [Dream Machine](https://lumalabs.ai/dream-machine) remains the consumer-facing product; the Agents API exposes the same model programmatically. + +Can I cancel a running generation? + +There is no cancel endpoint. A generation runs until it reaches `completed`, `failed`, or the 1-hour active-job TTL. To stop caring about a result in practice, stop polling — your client won’t see the output, and the concurrent-job slot is released when the job terminates. + +--- + +## Video editing and reframing (Ray 3.2) + +How do I supply the source video for an edit or reframe? + +Both `type: "video_edit"` and `type: "video_reframe"` require exactly one source video, supplied in one of three ways: + +- **`source.generation_id`** — the top-level `id` of a prior completed video generation owned by the same client. +- **`source.url`** — a publicly reachable video URL, with `source.media_type` set to a `video/*` MIME (e.g. `"video/mp4"`). +- **`source.data`** — inline base64-encoded video, also with a `video/*` `source.media_type`. Use this only for small media files; for anything larger prefer `source.generation_id` or a hosted `source.url`. + +`source.media_type` is **required** for `url` and `data`: the route uses the MIME prefix to pick the video ingest path before fetching any bytes, so a missing or non-`video/*` value is rejected. + +```json +{ + "detail": "source.media_type must be a video/* type (e.g. 'video/mp4') when providing source.url / source.data on type='video_edit'" +} +``` + +See [Video editing — source video](/guides/videos/editing/index.md#referencing-the-source-video). + +Is there a length limit on source videos? + +Yes, and the limit depends on the operation — each one caps the source at its own output ceiling. The cap applies whichever channel you use (`generation_id`, `url`, or `data`). + +| Operation | Source video limit | +| -------------------------------------------------------- | ------------------ | +| `video_reframe` | ≤10s | +| `video_edit` | ≤18s | +| Extend (`type: "video"` with a `generation_id` keyframe) | ≤30s | + +Longer clips are rejected at submit time, with the applicable limit in the error: + +```json +{ + "detail": "source: source video is 42.0s but must be ≤10s. Trim the clip and retry." +} +``` + +Trim the clip and resubmit. For a clip longer than the cap, split it into segments within the limit and submit each one. + +Is there a file-size limit on source videos? + +Yes — the source video must be **200 MB or smaller**, applied to both `url` fetches and base64 `data`. Oversized payloads are rejected: + +```json +{ "detail": "source: video exceeds 200 MB limit" } +``` + +For large clips, prefer `source.generation_id` (no upload) or a hosted `source.url` over inline base64. This is the default cap and may be adjusted per account, so treat 200 MB as the baseline. + +What’s the difference between `video_edit` and `video_reframe`? + +Both take a source video, but they do different things: + +- **`video_edit`** restyles or reinterprets the content — it re-renders the source under a new prompt, preserving motion to the degree you choose. Use it to change the look, lighting, or subject. +- **`video_reframe`** changes only the **aspect ratio**. The source content is preserved frame-for-frame and Ray 3.2 outpaints the newly exposed canvas around it. Use it to take a portrait clip to widescreen, and vice versa. + +See [Video editing](/guides/videos/editing/index.md) and [Video reframing](/guides/videos/reframing/index.md). + +How do I control how much a video edit changes the source? + +Through `video.edit`. Start with `auto_controls: true` — the model derives the conditioning schedule from the source video, and it’s the recommended default. For finer control: + +- **`video.edit.strength`** — a preservation-vs-reimagination preset with nine values across three bands: `adhere_1`–`adhere_3` (closely follow the source), `flex_1`–`flex_3` (balanced; `flex_2` is a common default), and `reimagine_1`–`reimagine_3` (the prompt drives most of the output). +- **`video.edit.controls`** — per-signal conditioning (`pose`, `depth`, `normals`, `trajectory`, `face`), each with an `enabled` flag and its own tuning parameter. + +`controls` cannot be combined with `auto_controls: true` — auto mode derives the schedule and would ignore manual controls, so the API rejects the combination: + +```json +{ + "detail": "video.edit.auto_controls=true cannot be combined with video.edit.controls (auto mode derives the schedule and ignores manual per-signal controls)" +} +``` + +See [Video editing — edit controls](/guides/videos/editing/index.md). + +Can I anchor a video edit to specific frames? + +Yes — in two mutually exclusive ways: + +- **Single guide frame** — `video.start_frame`, an `ImageRef` used as one anchor for the edit. +- **Multiple keyframes** — two parallel arrays under `video.edit`: `keyframes` (up to 64 guide-frame `ImageRef`s, each a `url`, inline `data`, or a `generation_id`) and `keyframe_indexes` (the matching non-negative, unique frame positions in the source video’s frame grid). Each `keyframes[i]` is anchored at `keyframe_indexes[i]`, so the two arrays must be the same length, and you provide both or neither — one without the other is a 400. + +`keyframes` is the multi-anchor generalization of `video.start_frame` (a single `start_frame` is equivalent to one keyframe at index 0), so the two are mutually exclusive — use one or the other. See [Video editing — keyframes](/guides/videos/editing/index.md#keyframes--the-control-surface-for-edits). + +Can I pass reference images (`image_ref`) on a video edit? + +No. `image_ref` is rejected on `type: "video_edit"`: + +```json +{ "detail": "image_ref is not supported for type 'video_edit'" } +``` + +Guide the edit through the prompt, the `video.edit` conditioning controls, and guide frames (`video.start_frame` or `video.edit.keyframes`). + +Can I control where the source sits inside a reframed video? + +Yes. By default reframe fits the source into the new canvas with a centered crop and outpaints around it. To place it precisely, pass `video.source_position` — a normalized rectangle measured as fractions of the **output** canvas, with all four fields required: + +| Field | Range | Meaning | +| -------- | ------------ | ------------------------------------------------------ | +| `x_norm` | `-2.0`–`2.0` | Left edge of the source, as a fraction of canvas width | +| `y_norm` | `-2.0`–`2.0` | Top edge of the source, as a fraction of canvas height | +| `w_norm` | `>0`–`2.0` | Source width, as a fraction of canvas width | +| `h_norm` | `>0`–`2.0` | Source height, as a fraction of canvas height | + +It’s valid only on `type: "video_reframe"`; setting it on any other type returns `"video.source_position is only valid for type 'video_reframe'"`. See [Video reframing](/guides/videos/reframing/index.md). + +Do HDR and looping work on edits and reframes? + +- **HDR** (`video.hdr`, plus `video.exr_export` which requires `hdr: true`) applies to `video_edit` the same way it does to generation, but is **not supported on `video_reframe`** — reframe is standard dynamic range only. +- **Looping** (`video.loop`) is valid only for `type: "video"`. It’s rejected on edits and reframes, whose output timing mirrors the source: `"video.loop is only valid for type 'video'"`. + +Does an edit or reframe keep the source’s aspect ratio? + +They behave oppositely. A `video_edit` preserves the source’s aspect ratio — passing `aspect_ratio` is silently ignored, same as on image edits. A `video_reframe` is the whole point of changing it: `aspect_ratio` is **required** and sets the new target shape (one of the six Ray 3.2 video ratios — `9:16`, `3:4`, `1:1`, `4:3`, `16:9`, `21:9`). + +--- + +## Polling, states, and timing + +What are the generation states? + +Four values: `queued` (waiting to be picked up), `processing` (running), `completed` (success — `output` contains download URLs), and `failed` (check `failure_reason` and `failure_code`). `completed` and `failed` are terminal; poll until you reach one of them. + +How often should I poll? + +Every 2–3 seconds is fine. uni-1 generations typically take 30–60 seconds, so even a fixed interval is only \~15–30 GETs per job — exponential backoff doesn’t buy you anything here. The two things worth adding are a short initial wait (the first poll won’t be ready) and a hard timeout (\~2 minutes for standard generations) so a stalled job doesn’t hang your worker. See the [Quickstart](/index.md) for a template. + +Is the GET endpoint rate limited? + +Not by the documented generation RPM bucket (the one reflected in `X-RateLimit-*` headers on submit). Poll cadences of every 1–5 seconds are fine. + +An API-wide abuse-prevention ceiling does exist as a backstop against runaway loops, sized so well-behaved integrators never see it. If you hit it, the response is a rate-limit error with `Retry-After` only, no `X-RateLimit-*` headers. Back off to a more reasonable interval. + +How long does a generation typically take? + +Standard generations and edits typically complete in 15–60 seconds. `web_search: true` adds a few seconds for the search phase. Always set a timeout in your polling loop — never wait indefinitely. + +My generation has been queued for a long time. What should I do? + +Check three things: + +1. Concurrent-job slot is free. If you’ve already hit your plan’s concurrent-job ceiling, new submissions are rejected with HTTP 429 until an active one terminates. +2. Wait an additional 30–60 seconds and poll again — short queue spikes are normal. +3. If still stuck after a few minutes, contact support and include the `X-Request-Id` from the submit response. + +--- + +## Rate limits and concurrency + +What are the default rate limits? + +Two limits, both per client: + +| Limit | Applies to | +| ------------------------- | ------------------------------------------------ | +| Requests per minute (RPM) | `POST /v1/generations`, rolling 60-second window | +| Concurrent jobs | Active (non-terminal) generations at any time | + +Specific allowances depend on your plan — check your [usage dashboard](https://platform.lumalabs.ai), or read the `X-RateLimit-Limit` header on a successful POST. Exceeding either limit returns a rate-limit error. See [Rate limits and headers](/guides/rate-limits/index.md) for full detail. + +How does the RPM sliding window work? + +Each request is timestamped, and the API counts how many requests landed in the last 60 seconds at the moment a new one arrives. There is no fixed reset — requests age out individually after 60 seconds. See [the timeline example](/guides/rate-limits/index.md#how-the-rpm-limit-works) for a walk-through. + +What do the rate-limit headers mean? + +Successful `POST /v1/generations` responses include three headers describing your current quota: + +| Header | Description | +| ----------------------- | -------------------------------------------------- | +| `X-RateLimit-Limit` | Your maximum RPM | +| `X-RateLimit-Remaining` | Requests remaining in the current 60-second window | +| `X-RateLimit-Reset` | Unix timestamp when the current window ends | + +When you’re rate-limited, `Retry-After` reports the minimum seconds to wait before retrying. + +How do I tell RPM from concurrent-job rate limiting? + +Both surface as the same rate-limit error. Read the `detail` field to distinguish them: + +| `detail` | Cause | What to do | +| ---------------------------- | ---------- | ----------------------------------------------- | +| `"Rate limit exceeded"` | RPM | Wait `Retry-After` seconds, then retry | +| `"Too many concurrent jobs"` | Concurrent | Wait for an active job to terminate, then retry | + +Concurrent-job rejections use a fixed `Retry-After: 60` and do not include `X-RateLimit-*` headers. + +How can I increase my rate limits? + +Rate limits vary by plan. Your current limits are reflected in `X-RateLimit-Limit` on every successful response. For higher limits, contact support with your use case and expected traffic. + +--- + +## Errors + +Where can I find the full list of error responses? + +The [Error handling](/guides/error-handling/index.md) guide is the source of truth — it lists every status the API can return, the exact `detail` string for each case, and whether the error is retryable. Branch on the status code in your client and consult the guide when adding handling for a new case. + +What is the difference between synchronous and asynchronous failures? + +Synchronous errors are returned immediately from the POST with a `detail` message; branch on the status code. Asynchronous failures happen after the submit has already been accepted and are surfaced when polling: `state` becomes `failed`, with `failure_reason` (human-readable) and `failure_code` (machine-readable). A robust client handles both. + +What are the asynchronous `failure_code` values? + +| `failure_code` | Description | Action | +| -------------------- | ---------------------------------------------------------------- | --------------------------------------------- | +| `content_moderated` | Input or output flagged by content moderation | Modify the prompt, do not retry | +| `generation_failed` | Internal model error | Retry the same request | +| `budget_exhausted` | Ran out of funds mid-generation | Add funds, then retry | +| `output_not_found` | Generated output could not be retrieved | Retry the same request | +| `image_too_large` | Input image exceeded the size limit (detected during processing) | Resize/compress the input, do not retry as-is | +| `unsupported_format` | Input media was in an unsupported format | Convert to a supported format, then resubmit | +| `corrupt_input` | Input media could not be decoded | Re-encode or replace the input | +| `invalid_request` | Request rejected as invalid during generation | Fix the request parameters | +| `rate_limited` | Upstream provider rate-limited the generation | Retry with backoff | + +See [Error handling — Asynchronous failures](/guides/error-handling/index.md#asynchronous-failures). + +What does `content_moderated` mean? Can I retry? + +It indicates the prompt, reference images, or generated output was flagged by content moderation. Do not retry the same request — the decision will be the same. Modify the prompt or swap reference images, then resubmit. + +My output URL stopped working. What’s wrong? + +Presigned URLs expire after 1 hour; once the signature has expired, storage refuses the download. Call `GET /v1/generations/{id}` to mint a new presigned URL with a fresh 1-hour window. + +My reference image was rejected as unprocessable. Now what? + +The reference was syntactically valid but couldn’t be processed. The `detail` field tells you exactly what to fix: + +| `detail` | Fix | +| ---------------------------------------------- | ------------------------------------------------------------------------------------- | +| `"image_ref[0]: invalid base64 data"` | Re-encode the image (e.g. `base64.b64encode(bytes).decode("utf-8")`) | +| `"image_ref[0]: failed to fetch URL"` | Confirm the URL is publicly reachable | +| `"source: failed to fetch URL"` | The origin did not return the image successfully — confirm it serves a valid response | +| `"image_ref[0]: content-type is not an image"` | The URL is not serving an image — check for HTML or PDF redirects | + +What should I do with the `X-Request-Id` header? + +Log the value from every response and include it in support requests. You can also send your own `X-Request-Id` to trace requests through your own system; the server echoes it back. See [Request tracing](/guides/rate-limits/index.md#using-x-request-id-for-tracing). + +--- + +## Content moderation and safety + +What content is not allowed? + +The full policy lives in the [Terms of Service](https://lumalabs.ai/legal/tos) and acceptable-use policy. The model blocks: + +- Child sexual abuse material (zero tolerance) +- Sexually explicit content +- Non-consensual intimate imagery and deepfakes of real people +- Graphic violence and gore +- Content promoting self-harm or dangerous acts +- Hateful content targeting protected groups +- Infringing or trademarked imagery in misleading contexts + +Moderation runs on inputs (`prompt`, `source`, `image_ref`) and outputs. + +Can I disable content moderation? + +No. Moderation is enforced on every input and output and cannot be disabled. + +My prompt was moderated but feels benign. What happened? + +Moderation is conservative by design. Common causes of false positives include named public figures, words with dual meanings (violence-adjacent verbs, medical terminology), and reference images depicting real people. Rephrase with a more generic subject (“a jazz musician” instead of a specific name), swap reference images if needed, and resubmit. + +--- + +## Billing + +See the [Pricing](/guides/pricing/index.md) page for current per-image rates and Provisioned Throughput plans. The answers below describe how billing works mechanically. + +How is pricing calculated? + +Two options: + +- **Pay-as-you-go** — pay per generation. For images, the price depends on the model (`uni-1` or `uni-1-max`), the action type (`image` vs. `image_edit`), and the number of reference images. For video (`ray-3.2`), the price depends on request type, resolution, dynamic range (standard / HDR / HDR+EXR), and duration. +- **Provisioned Throughput** — billed monthly per unit of guaranteed capacity (1 unit = 1 RPM on `uni-1`, 0.4 RPM on `uni-1-max`; video models bill against a separate capacity class — contact sales). Minimum 8 units; longer commitments unlock bigger discounts. + +See the [Pricing](/guides/pricing/index.md) page for current rates. + +Does video pricing differ from image pricing? + +Yes. Image generations are billed per image. Video pricing depends on request type: `type: "video"` and `type: "video_edit"` have separate 5-second and 10-second totals, extend bills one 5-second block, and reframe bills per second. Video rates can also depend on dynamic range — standard, HDR (`video.hdr: true`), or HDR + EXR (`exr_export: true`). See [Pricing — `ray-3.2` per-video pricing](/guides/pricing/index.md#ray-32--per-video-pricing) for the full grid. + +Do I pay for failed generations? + +Synchronous errors are never charged; the reserve is released the moment the request is rejected. For asynchronous failures, the charge depends on the `failure_code`: + +| `failure_code` | Charge | +| ------------------- | ----------------------- | +| `content_moderated` | Refunded | +| `generation_failed` | Refunded | +| `output_not_found` | Refunded | +| `budget_exhausted` | Partial charge possible | + +If you believe you were charged for a failure that should have been refunded, contact support with the generation ID and `X-Request-Id`. + +How do I check my balance? + +From the developer dashboard at [platform.lumalabs.ai](https://platform.lumalabs.ai), or with `GET /v1/credits` and `GET /v1/usage` from your own code. See [Usage and credits](/guides/usage/index.md). + +What happens if I run out of funds at submit time? + +`POST /v1/generations` rejects the request immediately. The request is not queued and nothing is charged. Add funds and resubmit. + +```json +{ "detail": "Insufficient balance. Please add funds to continue." } +``` + +What happens if I run out of funds mid-generation? + +A reserve is placed at submit time covering the maximum possible charge. If consumption exceeds the reserve mid-generation (rare), the generation fails with `failure_code: "budget_exhausted"`. Add funds and resubmit. + +```json +{ + "state": "failed", + "failure_code": "budget_exhausted", + "failure_reason": "Insufficient balance to complete this generation." +} +``` + +Can I set up auto-reload? + +Yes. Configure a `threshold_credits` and `reload_amount_credits` from the dashboard at [platform.lumalabs.ai](https://platform.lumalabs.ai); when your balance drops below the threshold, Stripe charges your default payment method for the reload amount. + +Is there a free tier? + +No. The API is Pay-as-you-go from the first image, with no minimum spend or contract. See [Pricing](/guides/pricing/index.md) for current rates. + +--- + +## Data handling and privacy + +Does Luma train on my API inputs or outputs? + +Review the current data-handling policy in the [Terms of Service](https://lumalabs.ai/legal/tos) and privacy policy. For enterprise agreements with custom data-handling guarantees, contact sales. + +How long are my generations stored? + +Generation metadata (IDs, prompts, state) is retained for operational and billing purposes. Output images are stored long enough to serve presigned URLs, with new URLs minted on every poll. Retention beyond that follows the published privacy policy. To delete a generation and the content it produced, see [Generation deletion](/guides/generation-deletion/index.md). For data-export requests, email . + +Who owns the generated images? + +Ownership and licensing are governed by Luma’s [Terms of Service](https://lumalabs.ai/legal/tos), which covers commercial-use rights. When in doubt, review the TOS or contact sales. + +--- + +## Troubleshooting + +My API key is rejected, but it works elsewhere. + +The `detail` field on the auth error tells you exactly which case you’re in — branch on it to debug: + +| `detail` | Likely fix | +| ------------------------------ | ------------------------------------------------------------------------------------ | +| `"Missing or invalid API key"` | Add `Authorization: Bearer ` and confirm the key starts with `luma-api-` | +| `"Invalid API key"` | Key value doesn’t match any active key — re-copy the full key, or generate a new one | +| `"API key has been revoked"` | Generate a new key — revoked keys cannot be restored | +| `"API key has expired"` | Generate a new key — keys can have an `expires_at` | + +Other things to check: + +1. **Environment variable not expanded** — verify `LUMA_AGENTS_API_KEY` is set in the shell running your code. +2. **Whitespace or newline** — common when copy-pasting from a dashboard. Trim before use. +3. **Bearer scheme is case-sensitive** — `bearer` (lowercase) is not accepted. + +I just created a generation but GET says it doesn’t exist. + +Three possible causes, all returning the same `"Generation not found"` to prevent enumeration: + +1. **Wrong account or client.** Generations are scoped per client. A key from a different client cannot see it even with a correct ID. +2. **Typo in the ID.** Copy it directly from the `id` field of the submit response. +3. **Invalid UUID format.** The path parameter must parse as a UUID. + +My reference URL works in a browser but the API rejects it. + +The fetch proxy is stricter than a browser. Common causes: + +1. The URL redirects to HTML (e.g. a login wall); the proxy sees HTML, not an image. +2. The URL is `http://` (proxy is HTTPS-only) or resolves to a private IP. +3. A short-lived signed URL expired between copy and fetch. +4. The origin returns a non-200 status, or a content-type that is not `image/*`. + +When in doubt, download the image yourself and send it as base64 `data`. + +Reference URLs are failing with a service-unavailable error. + +The URL ingestion subsystem is temporarily unavailable. Send the image as base64 `data` instead: + +```python +import base64, httpx + +resp = httpx.get("https://example.com/reference.jpg") +b64 = base64.b64encode(resp.content).decode("utf-8") + +generation = client.generations.create( + prompt="A similar scene but at sunset", + image_ref=[{"data": b64, "media_type": "image/jpeg"}], +) +``` + +If you don’t need reference images, retry the request without them. + +How do I report a bug or get support? + +Email . Include: + +1. The **generation ID** (the top-level `id` from the submit response). This is the fastest way for support to pull up your generation — always share it. +2. The `X-Request-Id` from the affected response (submit and/or poll). +3. Request parameters, with API keys redacted. +4. Expected versus actual behavior. + +**Best practice:** log both the generation `id` and the `X-Request-Id` for every request you make. The generation ID is the quickest lookup for a specific generation; `X-Request-Id` traces a single HTTP call (submit or poll) through our logs. Capturing both up front means you can hand support an exact reference instead of reconstructing it later. + +--- + +## Versioning + +What API version am I using? + +Every response includes `X-API-Version`. The current value is `2026-04-01`. You do not need to send a version header — there is currently a single version. + +How are breaking changes communicated? + +Breaking changes ship behind a new `X-API-Version` value; the previous version remains available during a deprecation window. Watch the [API Reference](/api/index.md) and changelog for announcements. + +--- + +## Next steps + +- [**Quickstart**](/index.md) — Submit your first generation +- [**Models**](/guides/model/index.md) — Capabilities for `uni-1`, `uni-1-max`, `ray-3.2` +- [**Image generation**](/guides/images/generation/index.md) — Every parameter with examples +- [**Image editing**](/guides/images/editing/index.md) — Edit existing images with natural language +- [**Video generation**](/guides/videos/generation/index.md) — Ray 3.2 text-to-video and image-to-video +- [**Video editing**](/guides/videos/editing/index.md) — Ray 3.2 video editing +- [**Pricing**](/guides/pricing/index.md) — Pay-as-you-go and Provisioned Throughput +- [**Rate limits and headers**](/guides/rate-limits/index.md) — Rate limiting and retry strategies +- [**Error handling**](/guides/error-handling/index.md) — Every error code with troubleshooting +- [**API Reference**](/api/index.md) — Complete endpoint specifications diff --git a/pipeline/provider_docs/meta__dev.meta.ai_docs_api-reference_images_schemas b/pipeline/provider_docs/meta__dev.meta.ai_docs_api-reference_images_schemas new file mode 100644 index 0000000000000000000000000000000000000000..26af9a834717bd9c7ad6670cef17183eaa2a9c2f --- /dev/null +++ b/pipeline/provider_docs/meta__dev.meta.ai_docs_api-reference_images_schemas @@ -0,0 +1,40 @@ +Images schemas - Meta Model API
        Skip to content
        +

        Images schemas

        +

        The full schema and model definitions referenced by the Images endpoints. Each endpoint page links here for the detailed shape of its request and response objects.

        +

        Schemas

        + +

        Create Image Edit Request

        +
        FieldTypeRequiredDescription
        imagestring (binary)NoImage to edit. PNG format.
        promptstringYesText description of the edits to apply.
        modelstringYesModel ID.
        nintegerNoNumber of edited images to generate. Range: 1-10. Defaults to 1. (minimum: 1, maximum: 10, default: 1)
        sizestringNoRequested image shape as width x height (e.g., '1024x1024'). The values set the aspect ratio; the image is produced at the generator's own resolution, so the returned pixel dimensions will not necessarily match the numbers supplied.
        response_formatenum ('url', 'b64_json')NoFormat for the edited images. One of url or b64_json. Default: b64_json. (default: b64_json)
        reasoning_strengthenum ('low', 'high')NoHow much reasoning the image generator applies before producing the edited image. One of low or high. low returns after a single generation pass (no self-refinement); high (the default) lets the generator iteratively refine. (default: high)
        moderationstringNoModeration level for the safety pipeline. One of auto or low. Enabled per model: on models where it is not enabled, any moderation value returns 400 (code: unsupported_parameter, param: moderation); omitting moderation is always valid. On enabled models, unknown or empty values return 400.
        streambooleanNoIf true, streams the response as server-sent events. Defaults to false. (default: false)
        partial_imagesintegerNoNumber of partial images to generate during streaming. Range: 0-3. Accepted but ignored. (minimum: 0, maximum: 3, default: 0)
        tool_enablementImageToolEnablementNoPer-tool controls for the image generator's planner. Omit to keep the default (all tools available).
        +

        Create Image Request

        +
        FieldTypeRequiredDescription
        modelstringYesModel ID for image generation.
        promptstringYesText description of the images to generate.
        nintegerNoNumber of images to generate. Range: 1-10. Defaults to 1. (minimum: 1, maximum: 10, default: 1)
        sizestringNoRequested image shape as width x height (e.g., '1024x1024'). The value is converted into an aspect ratio only; the image is produced at the generator's own fixed output resolution, so the returned pixel dimensions stay constant regardless of the numbers supplied — only the aspect ratio changes.
        response_formatenum ('url', 'b64_json')NoFormat for returned images. One of: url, b64_json. Defaults to b64_json. (default: b64_json)
        moderationstringNoModeration level for the safety pipeline. One of auto or low. Enabled per model: on models where it is not enabled, any moderation value returns 400 (code: unsupported_parameter, param: moderation); omitting moderation is always valid. On enabled models, unknown or empty values return 400.
        output_formatstringNoRequested file type for the generated images. One of png, jpeg, or webp. Defaults to webp when omitted; any other value is rejected.
        reasoning_strengthenum ('low', 'high')NoHow much reasoning the image generator applies before producing the image. One of low or high. low returns after a single generation pass (no self-refinement); high (the default) lets the generator iteratively refine. (default: high)
        temperaturenumberNoSampling temperature for the model's planning step (prompt writing and refinement), between 0 and 2. It does not change how the image itself is sampled. Omit it to keep the model default. (minimum: 0, maximum: 2)
        userstringNoA stable end-user identifier that helps detect and mitigate abuse. Use it on the images endpoints; on the Responses and Chat Completions endpoints, use safety_identifier instead.
        streambooleanNoIf true, streams the response as server-sent events. Defaults to false. (default: false)
        tool_enablementImageToolEnablementNoPer-tool controls for the image generator's planner. Omit to keep the default (all tools available).
        +

        Edit Image Body Json Param

        +
        FieldTypeRequiredDescription
        modelstringYesModel ID.
        promptstringYesText description of the edits to apply.
        imagesarray of ImageInputItemYesImages to edit. (minItems: 1)
        nintegerNoNumber of edited images to generate. Range: 1-10. Defaults to 1. (minimum: 1, maximum: 10, default: 1)
        sizestringNoRequested image shape as width x height (e.g., '1024x1024'). The value is converted into an aspect ratio only; the image is produced at the generator's own fixed output resolution, so the returned pixel dimensions stay constant regardless of the numbers supplied — only the aspect ratio changes.
        response_formatenum ('url', 'b64_json')NoFormat for the edited images. One of url or b64_json. Default: b64_json. (default: b64_json)
        output_formatstringNoRequested file type for the edited images. One of png, jpeg, or webp. Defaults to webp when omitted; any other value is rejected.
        reasoning_strengthenum ('low', 'high')NoHow much reasoning the image generator applies before producing the edited image. One of low or high. low returns after a single generation pass (no self-refinement); high (the default) lets the generator iteratively refine. (default: high)
        temperaturenumberNoSampling temperature for the model's planning step (prompt writing and refinement), between 0 and 2. It does not change how the image itself is sampled. Omit it to keep the model default. (minimum: 0, maximum: 2)
        moderationstringNoModeration level for the safety pipeline. One of auto or low. Enabled per model: on models where it is not enabled, any moderation value returns 400 (code: unsupported_parameter, param: moderation); omitting moderation is always valid. On enabled models, unknown or empty values return 400.
        streambooleanNoIf true, streams the response as server-sent events. Defaults to false. (default: false)
        userstringNoA stable end-user identifier that helps detect and mitigate abuse. Use it on the images endpoints; on the Responses and Chat Completions endpoints, use safety_identifier instead.
        tool_enablementImageToolEnablementNoPer-tool controls for the image generator's planner. Omit to keep the default (all tools available).
        +

        Image Edit Completed Event

        +

        Image edit completed event.

        +
        FieldTypeRequiredDescription
        typeenum ('image_edit.completed')YesEvent type; always image_edit.completed.
        b64_jsonstringYesBase64-encoded edited image data.
        created_atintegerYesUnix timestamp (seconds) for when the event was created.
        output_indexinteger (int64)YesZero-based index of the edited image in the response.
        sizestringNoRequested image shape as width x height. The values set the aspect ratio; the image is produced at the generator's own resolution, so the returned pixel dimensions will not necessarily match the numbers supplied.
        qualitystringNoQuality setting for the edited images. Accepted but ignored.
        backgroundstringNoBackground setting for the edited images. Accepted but ignored.
        output_formatstringNoOutput format for the edited images.
        usageImageGenUsageNoAggregate token usage for the image edit request. Present only on the final completed event.
        +

        Image Edit Partial Image Event

        +

        Image edit partial image event.

        +
        FieldTypeRequiredDescription
        typeenum ('image_edit.partial_image')YesEvent type; always image_edit.partial_image.
        b64_jsonstringYesBase64-encoded partial image data.
        created_atintegerYesUnix timestamp (seconds) for when the event was created.
        sizestringNoRequested image shape as width x height. The values set the aspect ratio; the image is produced at the generator's own resolution, so the returned pixel dimensions will not necessarily match the numbers supplied.
        qualitystringNoQuality setting for the edited images. Accepted but ignored.
        backgroundstringNoBackground setting for the edited images. Accepted but ignored.
        output_formatstringNoOutput format for the edited images. Accepted but ignored.
        partial_image_indexintegerYesZero-based index for the partial image.
        +

        Image Edit Stream Event

        +

        Type: ImageEditPartialImageEvent | ImageEditCompletedEvent

        +

        Image Gen Completed Event

        +

        Image generation completed event.

        +
        FieldTypeRequiredDescription
        typeenum ('image_generation.completed')YesEvent type; always image_generation.completed.
        b64_jsonstringYesBase64-encoded image data.
        created_atintegerYesUnix timestamp (seconds) for when the event was created.
        output_indexinteger (int64)YesZero-based index of the generated image in the response.
        sizestringNoRequested image shape as width x height. The values set the aspect ratio; the image is produced at the generator's own resolution, so the returned pixel dimensions will not necessarily match the numbers supplied.
        qualitystringNoQuality setting for the generated images. Accepted but ignored.
        backgroundstringNoBackground setting for the generated images. Accepted but ignored.
        output_formatstringNoOutput format for the generated images.
        usageImageGenUsageNoAggregate token usage for the image generation request. Present only on the final completed event.
        +

        Image Gen Partial Image Event

        +

        Image generation partial image event.

        +
        FieldTypeRequiredDescription
        typeenum ('image_generation.partial_image')YesEvent type; always image_generation.partial_image.
        b64_jsonstringYesBase64-encoded partial image data.
        created_atintegerYesUnix timestamp (seconds) for when the event was created.
        sizestringNoRequested image shape as width x height. The values set the aspect ratio; the image is produced at the generator's own resolution, so the returned pixel dimensions will not necessarily match the numbers supplied.
        qualitystringNoQuality setting for the generated images. Accepted but ignored.
        backgroundstringNoBackground setting for the generated images. Accepted but ignored.
        output_formatstringNoOutput format for the generated images. Accepted but ignored.
        partial_image_indexintegerYesZero-based index of the partial image in the streaming sequence.
        +

        Image Gen Stream Event

        +

        Type: ImageGenPartialImageEvent | ImageGenCompletedEvent

        +

        Image Gen Usage

        +
        FieldTypeRequiredDescription
        input_tokensintegerNoNumber of input tokens.
        input_tokens_detailsobjectNoBreakdown of input tokens by modality.
        input_tokens_details.image_tokensintegerNoNumber of image tokens in the input.
        input_tokens_details.text_tokensintegerNoNumber of text tokens in the input.
        output_tokensintegerNoNumber of output tokens.
        total_tokensintegerNoTotal number of tokens.
        +

        Image Input Item

        +
        FieldTypeRequiredDescription
        image_urlstringNoImage URL.
        file_idstringNoFile ID.
        +

        Image Object

        +
        FieldTypeRequiredDescription
        b64_jsonstringNoBase64-encoded image data.
        urlstringNoImage URL.
        revised_promptstringNoRevised prompt used for the image.
        +

        Image Tool Enablement

        +

        Per-tool controls for the image generator's agentic planner. Omit to keep the default (all tools available); set a field to false to disable that tool for the request.

        +
        FieldTypeRequiredDescription
        enable_image_searchbooleanNoWhether the image generator may search the web for visual references. false disables it.
        enable_web_searchbooleanNoWhether the image generator may search the web for facts. false disables it (also drops the browser tools).
        enable_shellbooleanNoWhether the image generator may run code to build layouts and charts. false disables it.
        +

        Images Response

        +
        FieldTypeRequiredDescription
        createdintegerYesUnix timestamp (seconds) for when the images were created.
        dataarray of ImageObjectYesArray of generated images.
        output_formatstringNoFile type of the generated images. Echoes the requested output_format (png, jpeg, or webp); webp when omitted.
        backgroundstringNoBackground setting for the generated images. Accepted but ignored.
        usageImageGenUsageNoToken usage for the image generation request.
        +
        \ No newline at end of file diff --git a/pipeline/provider_docs/microsoft__learn.microsoft.com_en-us_azure_foundry_foundry-models_how-to_use-foundry-models-mai b/pipeline/provider_docs/microsoft__learn.microsoft.com_en-us_azure_foundry_foundry-models_how-to_use-foundry-models-mai new file mode 100644 index 0000000000000000000000000000000000000000..c56280907bb9afb7f89c42fe1adae33a362422ff --- /dev/null +++ b/pipeline/provider_docs/microsoft__learn.microsoft.com_en-us_azure_foundry_foundry-models_how-to_use-foundry-models-mai @@ -0,0 +1,2073 @@ + + + + + Deploy and use MAI image models in Microsoft Foundry - Microsoft Foundry | Microsoft Learn + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
        + + + Skip to main content + + + + + + + + + +
        +
        + + +
        + + +
        +
        + +
        + + +
        +
        +
        + + + +
        + +
        + +
        +
        + + +
        +
        +
        + +
        +
        + +
        +
        + +
        + + + +
        +
        + + + +
        + + + + + + +
        + +
        + + + + + + + + + + + + + + + +
        + + + + + + +
        +
        +
        + +
        +
        + + + + +

        Deploy and use MAI image models in Microsoft Foundry (preview)

        + +
        + + + +
        + +
        +
        + + +
        + +
        +
        + + +
        +

        Important

        +

        Items marked preview in this article are currently in preview. This preview is provided without a service-level agreement, and Microsoft doesn't recommend it for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews.

        +
        +

        MAI Image models are a family of image models developed by Microsoft AI that deliver state-of-the-art text-to-image generation and for some models, image-to-image edits. These models are offered as part of Microsoft Foundry Models sold by Azure, providing secure, enterprise-grade access through Microsoft Foundry.

        +

        In this article, you learn how to:

        +
          +
        • Deploy MAI image models in Microsoft Foundry
          • +
        • Authenticate by using Microsoft Entra ID or API keys
          • +
        • Generate images by using the MAI image generations API
          • +
        • Run an image edit by using the MAI image edits API
          • +
        +

        Prerequisites

        + +

        MAI image models at a glance

        +

        MAI image models in Microsoft Foundry include:

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Model nameModel versionDeployment typeAPI type
        MAI-Image-2.6-Flash (Preview)2026-07-31Global StandardText-to-image generation
        Image-to-image edits
        MAI-Image-2.6 (Preview)2026-07-31Global StandardText-to-image generation
        Image-to-image edits
        MAI-Image-2.5-Pro (Preview)2026-06-19Global StandardText-to-image generation
        Image-to-image edits
        MAI-Image-2.5-Flash (Preview)2026-06-02Global StandardText-to-image generation
        Image-to-image edits
        MAI-Image-2.5 (Preview)2026-06-02Global StandardText-to-image generation
        Image-to-image edits
        +

        For each model's supported deployment regions, see Region availability for Foundry Models sold by Azure.

        +

        To learn more about the individual models, see MAI image model capabilities.

        +

        Deploy MAI image models

        +

        To deploy an MAI image model, follow the instructions in Deploy Microsoft Foundry Models in the Foundry portal.

        +

        Alternatively, you can deploy the model by using the Azure CLI. The following code shows deployment of MAI-Image-2.5. To deploy a different model, replace the model name and version in the lines --model-name MAI-Image-2.5 and --model-version 2026-06-02 with the values for your desired model.

        +

        Replace <ACCOUNT_NAME>, <RESOURCE_GROUP>, <DEPLOYMENT_NAME> with your values.

        +
        az cognitiveservices account deployment create \
+  --name <ACCOUNT_NAME> \
+  --resource-group <RESOURCE_GROUP> \
+  --deployment-name <DEPLOYMENT_NAME> \
+  --model-name "MAI-Image-2.5" \
+  --model-format Microsoft \
+  --model-version 2026-06-02 \
+  --sku-name GlobalStandard \
+  --sku-capacity 1
+
        +

        Reference: az cognitiveservices account deployment create

        +

        To list all available deployments on your resource:

        +
        az cognitiveservices account deployment list \
+  --resource-group <RESOURCE_GROUP> \
+  --name <ACCOUNT_NAME> \
+  -o table
+
        +

        Reference: az cognitiveservices account deployment list

        +

        After deployment, use the Foundry playground to interactively test the model.

        +

        Run text-to-image generation

        +

        MAI image models can generate high-quality images from natural language prompts, enabling users to translate textual descriptions into visually coherent outputs suitable for a wide range of creative and design use cases.

        +

        The following example shows how to generate an image from a text prompt using an MAI image model with the MAI image generations API.

        +
        + +
        +

        Use API key authentication

        +
          +

        1. Install the requests library:

          +
          pip install requests
+
          +
          2. +

        2. Set environment variables:

          +
          export AZURE_ENDPOINT="https://<resource-name>.services.ai.azure.com"
+export AZURE_API_KEY="<your-api-key>"
+export DEPLOYMENT_NAME="<your-deployment-name>"
+
          +
          3. +

        3. Run the following code:

          +
          import os
+import base64
+import requests
+
+endpoint = os.environ["AZURE_ENDPOINT"]
+api_key = os.environ["AZURE_API_KEY"]
+deployment_name = os.environ["DEPLOYMENT_NAME"]
+
+width = 1024
+height = 1024
+
+url = f"{endpoint}/mai/v1/images/generations"
+
+payload = {
+    "model": deployment_name,
+    "prompt": "A photorealistic concept art poster of a university at sunset, cinematic lighting",
+    "width": width,
+    "height": height
+}
+
+response = requests.post(
+    url,
+    headers={
+        "Content-Type": "application/json",
+        "api-key": api_key,
+    },
+    json=payload,
+)
+response.raise_for_status()
+
+result = response.json()
+print(result)
+
+image_data = [
+    output
+    for output in result.get("data", [])
+    if "b64_json" in output
+]
+
+if image_data:
+    image_base64 = image_data[0]["b64_json"]
+    output_path = "output.png"
+    with open(output_path, "wb") as f:
+        f.write(base64.b64decode(image_base64))
+    print(f"Image saved to {output_path}")
+else:
+    print("Unexpected response format:", result)
+
          +

          Expected output: A JSON response containing the generated image data in base64 format. The response includes the image data, which you decode and save as output.png in the current directory. For more information, see Response format.

          +
          4. +
        +

        Use Microsoft Entra ID authentication

        +

        To use Microsoft Entra ID instead of an API key, replace the api-key header with a bearer token obtained using the DefaultAzureCredential:

        +
          +

        1. Install the Azure Identity library:

          +
          pip install azure-identity
+
          +
          2. +

        2. Update the request headers in the API key authentication code:

          +
          from azure.identity import DefaultAzureCredential, get_bearer_token_provider
+
+token_provider = get_bearer_token_provider(
+    DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"
+)
+token = token_provider()
+
+headers = {
+    "Content-Type": "application/json",
+    "Authorization": f"Bearer {token}",
+}
+
          +

          Reference: DefaultAzureCredential

          +
          3. +
        +
        + +
        +

        Run an image-to-image edit

        +

        Some MAI image models support precise, controllable edits to existing images, including object removal, replacement, attribute changes, inpainting, text updates, and artifact cleanup while preserving composition and layout. +For the list of models that support image-to-image edits, see MAI image models at a glance.

        +

        The following example shows how to perform an image-to-image edit by using an MAI image model with the MAI image edits API.

        +
        +

        Note

        +

        Requests for image-to-image edits use multipart form data and accept up to five reference images. Repeat the image field for each file.

        +
        +
        + +
        +

        Use API key authentication

        +
          +

        1. Install the requests library:

          +
          pip install requests
+
          +
          2. +

        2. Set environment variables:

          +
          export AZURE_ENDPOINT="https://<resource-name>.services.ai.azure.com"
+export AZURE_API_KEY="<your-api-key>"
+export DEPLOYMENT_NAME="<your-deployment-name>"
+
          +
          3. +

        3. Run the following code:

          +
          import os
+import base64
+import requests
+
+endpoint = os.environ["AZURE_ENDPOINT"]
+api_key = os.environ["AZURE_API_KEY"]
+deployment_name = os.environ["DEPLOYMENT_NAME"]
+
+width = 1024
+height = 1024
+
+url = f"{endpoint}/mai/v1/images/edits"
+
+files = [
+    ("image", ("first.png", open("first.png", "rb"), "image/png")),
+    ("image", ("second.png", open("second.png", "rb"), "image/png")),
+]
+
+payload={
+    "model": deployment_name,
+    "prompt": "Combine both source images into a clean futuristic product shot",
+}
+
+response = requests.post(
+    url,
+    headers={
+        "api-key": api_key,
+    },
+    data=payload,
+    files=files
+)
+
+response.raise_for_status()
+
+result = response.json()
+print(result)
+
+
+image_data = [
+    output
+    for output in result.get("data", [])
+    if "b64_json" in output
+]
+
+if image_data:
+    image_base64 = image_data[0]["b64_json"]
+    output_path = "output.png"
+    with open(output_path, "wb") as f:
+        f.write(base64.b64decode(image_base64))
+    print(f"Image saved to {output_path}")
+else:
+    print("Unexpected response format:", result)
+
          +

          Expected output: A JSON response containing the edited image data in base64 format. The response includes the image data, which you decode and save as output.png in the current directory. For more information, see Response format.

          +
          4. +
        +

        To use Microsoft Entra ID instead of an API key, modify this code as described in the earlier section: Use Microsoft Entra ID authentication.

        +
        + +
        +

        MAI image model capabilities

        +

        MAI image models are diffusion-based generative models designed for both high-quality text-to-image generation and precise, controllable image-to-image editing. Each model uses a diffusion-based approach to progressively refine images from a natural language prompt, enabling strong alignment between the input text and the generated output.

        +

        Core capabilities

        +

        All MAI image models in this article share these core capabilities:

        +
          +
        • Text-to-image generation: Generates high-quality images from natural language prompts, enabling users to translate textual descriptions into visually coherent outputs suitable for a wide range of creative and design use cases.
          • +
        • Image-to-image editing: Supports precise, controllable edits to existing images, including object removal, replacement, attribute changes, inpainting, text updates, and artifact cleanup while preserving composition and layout.
          • +
        • Photorealistic image synthesis: Generates realistic imagery with consistent visual structure, making it suitable for concept visualization and content creation scenarios.
          • +
        • High-fidelity portraits: Generates expressive, natural-looking portraits with accurate facial structure, lighting, and texture.
          • +
        • Product, branding, and commercial design: Well suited for product imagery, marketing visuals, brand assets, and commercial creative workflows.
          • +
        • Accurate text rendering: Improved rendering of text within generated images, including labels, posters, packaging, and signage.
          • +
        • Visual reasoning: Reasons across objects, scene structure, lighting, scale, and spatial positioning to produce consistent outputs, even from ambiguous prompts.
          • +
        +

        The following table highlights what distinguishes each model and the scenarios it best fits.

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        ModelKey capabilitiesBest for
        MAI-Image-2.6-Flash (Preview)Same generation and editing capabilities as MAI-Image-2.6, offered as a faster, lower-cost variant.The same scenarios as MAI-Image-2.6 when you need lower cost and faster generation.
        MAI-Image-2.6 (Preview)Core capabilities, with stronger text rendering, improved portraits and 3D imagery, and more polished commercial and photorealistic output.Projects that need the latest quality gains in text rendering, portraits, and commercial or photorealistic imagery.
        MAI-Image-2.5-Pro (Preview)Highest-quality model in the Image-2.5 series, at a higher cost than the other Image-2.5 models. Adds object consistency across complex scenes, character consistency across views and moments, material and physical-property accuracy, and spatial and geometric reasoning to the core family capabilities.Visually dense compositions that require consistent object identity, materials, and spatial relationships.
        MAI-Image-2.5-Flash (Preview)Same generation and editing capabilities as MAI-Image-2.5, offered as a faster, lower-cost variant.Concept visualization, creative content generation, image editing workflows, and production design when you need lower cost and faster generation.
        MAI-Image-2.5 (Preview)Core capabilities.Concept visualization, creative content generation, image editing workflows, and production design.
        +

        For more details, see the individual model cards in the Foundry model catalog and the capabilities comparison table in Foundry Models sold by Azure.

        +

        API endpoints

        +

        After you deploy an MAI image model, use the MAI image generations API to generate images and the MAI image edits API for image-to-image edits.

        +
          +

        • Image generations API endpoint: A Microsoft-managed endpoint that accepts a text prompt and returns a PNG image. The API endpoint has the following form:

          +
          https://<resource-name>.services.ai.azure.com/mai/v1/images/generations
+
          +
          • +

        • Image edits API endpoint: A Microsoft-managed endpoint that accepts up to five JPEG or PNG reference images and returns a PNG image. The API endpoint has the following form:

          +
          https://<resource-name>.services.ai.azure.com/mai/v1/images/edits
+
          +
          • +
        +

        To authenticate, you need your resource endpoint and either a Microsoft Entra ID token or an API key. You can find these values in the Keys and Endpoint section of your resource in the Azure portal, or on the deployment details page in the Foundry portal.

        +

        Request parameters

        +

        The following table lists the request parameters for the image APIs:

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        ParameterAPITypeRequiredDescription
        modelBothstringYesThe deployment name you assigned when you deployed the model.
        promptBothstringYesThe text prompt that describes the image to generate or edits to make.
        Maximum context length: 32,000 tokens.
        imageImage editsfileYesA JPEG or PNG reference image passed as multipart form data. Provide up to five images by repeating the image field for each file.
        widthImage generationsintegerNoWidth of the output image in pixels.
        Minimum: 768. For MAI-Image-2.6 models, the product of width × height must not exceed 2,359,296. For MAI-Image-2.5 models, it must not exceed 1,048,576.
        heightImage generationsintegerNoHeight of the output image in pixels.
        Minimum: 768. For MAI-Image-2.6 models, the product of width × height must not exceed 2,359,296. For MAI-Image-2.5 models, it must not exceed 1,048,576.
        auto_aspect_ratioBothbooleanNoApplies only to MAI-Image-2.6 (Preview) and MAI-Image-2.6-Flash (Preview). Enables model-directed aspect ratio selection. When enabled, the model evaluates the prompt and any provided image inputs to select the output aspect ratio it determines is best suited to the requested content, composition, and framing. When disabled, the configured or default aspect ratio is used instead.
        web_groundingBothbooleanNoApplies only to MAI-Image-2.6 (Preview) and MAI-Image-2.6-Flash (Preview). Enables web-grounded image generation. When enabled, the model can retrieve current, relevant information from Bing Search and use the results as additional context when interpreting the prompt and generating the image. This can improve accuracy for requests involving real-world entities, places, events, or other information that might change over time. When disabled, no web search is performed.
        +

        Response format

        +

        Both the MAI image generations and image edits APIs return a JSON object that contains the generated PNG image as base64-encoded data. Decode the b64_json value to save the image as a PNG file.

        +
        +

        Note

        +

        The output format is always PNG. The maximum total pixel count is 2,359,296 (equivalent to 1536×1536) for MAI-Image-2.6 and MAI-Image-2.6-Flash, and 1,048,576 (equivalent to 1024×1024) for MAI-Image-2.5 models. Both width and height must be at least 768 pixels each. Either dimension can exceed the equivalent square dimensions as long as the total pixel count stays within the applicable limit.

        +
        + + + + + + + + + + + + + + + + + + + + +
        FieldTypeDescription
        dataarrayCollection of generated image results.
        data[].b64_jsonstringBase64-encoded PNG image data. Decode this value to create an image file.
        +

        The following example shows a successful response:

        +
        {
+    "data": [
+        {
+            "b64_json": "<base64-encoded PNG image data>"
+        }
+    ]
+}
+
        +

        API quotas and limits

        +

        MAI image models have the following rate limits measured in Requests Per Minute (RPM). The tier available to you depends on your subscription and deployment configuration.

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Deployment TypeTierMAI-Image-2.6-Flash
        (RPM)        		MAI-Image-2.6
        (RPM)        		MAI-Image-2.5-Pro
        (RPM)        		MAI-Image-2.5-Flash
        (RPM)        		MAI-Image-2.5
        (RPM)
        Global Standard0
        (Free)        		00000
        Global Standard166222
        Global Standard21212444
        Global Standard31818666
        Global Standard42424888
        Global Standard53030101010
        Global Standard63636121212
        +

        To request a quota increase, submit the quota increase request form. Requests are processed in the order they're received, and priority goes to customers who actively use their existing quota allocation.

        +

        Troubleshoot

        +

        Use the following table to resolve common errors when working with MAI image models:

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        ErrorCauseFix
        401 UnauthorizedInvalid API key or expired tokenRegenerate the key in the Azure portal. For Entra ID authentication, ensure the token scope is https://cognitiveservices.azure.com/.default.
        404 Not FoundIncorrect deployment name or endpoint URLVerify the deployment name and endpoint in the Foundry portal under Deployments.
        400 Bad RequestA required field is missing, a reference image uses an unsupported format, image dimensions are invalid, or a parameter isn't supported by the deployed modelInclude the required model and prompt fields and, for edits, at least one image field containing a JPEG or PNG file. Use auto_aspect_ratio and web_grounding only with MAI-Image-2.6 models. Ensure width and height are each at least 768. Keep width × height at or below 2,359,296 for MAI-Image-2.6 models or 1,048,576 for MAI-Image-2.5 models.
        429 Too Many RequestsRate limit exceededWait and retry, or request a quota increase.
        +

        Responsible AI considerations

        +

        When using MAI image models in Foundry, consider these responsible AI practices:

        +
          +
        • Be aware of known limitations: Despite technical mitigations such as data filtering and content classifiers applied at the system level, image generation models can produce harmful or unexpected content based on user requests. Common risk areas include violent or gory content, sexual content or nudity, depictions of public figures, and replication of trademarked or other protected material.
          • +
        • Configure content safety: Apply additional mitigations appropriate to your use case, because no generative model is immune to adversarial prompts.
          • +
        • Comply with applicable terms: Ensure your use of generated images complies with Microsoft's terms of service and applicable copyright and intellectual property laws.
          • +
        • Be transparent: Disclose that content is AI-generated when sharing or publishing images.
          • +
        • Avoid harmful content: Don't generate content that could be harmful, misleading, or in violation of privacy.
          • +
        +

        Special considerations for editing images of minors

        +

        Photorealistic image edits involving minors are blocked by default. Customers can request access to this model capability. Enterprise-tier customers are automatically approved.

        +

        Related content

        + +
        + +
        + + + + + + + + + +
        + +
        + + + + + + + + + +
        + +
        +
        +
          +
        • + + Last updated on + +
          • +
        +
        + +
        + +
        +
        +
        +
        + + + + \ No newline at end of file diff --git a/pipeline/provider_docs/openai__developers.openai.com_api_reference_resources_images_methods_edit b/pipeline/provider_docs/openai__developers.openai.com_api_reference_resources_images_methods_edit new file mode 100644 index 0000000000000000000000000000000000000000..e008c59e4adb0fdffdc72f550875ea6f85e32047 --- /dev/null +++ b/pipeline/provider_docs/openai__developers.openai.com_api_reference_resources_images_methods_edit @@ -0,0 +1,1425 @@ + Create image edit | OpenAI API Reference +Skip to content +
        +For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending +.md to the page URL. +
        Primary navigation

        Suggested
        Overview Models Agents Tools Audio & voice Production API reference

        Create image edit

        POST
        /images/edits

        Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models.

        +
        Body Parameters
        JSON
        images: array of object { file_id, image_url }

        Input image references to edit. +For GPT image models, you can provide up to 16 images.

        +
        minItems1
        maxItems16
        file_id: optional string

        The File API ID of an uploaded image to use as input.

        +
        image_url: optional string

        A fully qualified URL or base64-encoded data URL.

        +
        maxLength20971520
        formaturi
        prompt: string

        A text description of the desired image edit.

        +
        minLength1
        maxLength32000
        background: optional "transparent" or "opaque" or "auto" or null (default: "auto")

        Set the background of the generated image output. gpt-image-2.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, support opaque and transparent backgrounds. Transparent backgrounds are available for supported GPT Image models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in preview. When using transparent, set the output format to png or webp.

        +
        One of the following:
        "transparent"
        "opaque"
        "auto"
        input_fidelity: optional "high" or "low" or null

        Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports high and low on gpt-image-1.5; gpt-image-1-mini supports only low. For gpt-image-2, omit this parameter. Defaults to low on supported models.

        +
        One of the following:
        "high"
        "low"
        markup: optional object { file_id, image_url }

        A transparent PNG overlaid on the first image, referenced by file ID, HTTPS URL, or base64 data URL. Must match that image’s dimensions after orientation and contain transparent pixels. Supports GPT Image 2.5 and 2.6. Cannot be combined with mask.

        +
        file_id: optional string

        The File API ID of an uploaded image to use as input.

        +
        image_url: optional string

        A fully qualified URL or base64-encoded data URL.

        +
        maxLength20971520
        formaturi
        mask: optional object { file_id, image_url }

        Reference an input image by either URL or uploaded file ID. +Provide exactly one of image_url or file_id.

        +
        file_id: optional string

        The File API ID of an uploaded image to use as input.

        +
        image_url: optional string

        A fully qualified URL or base64-encoded data URL.

        +
        maxLength20971520
        formaturi
        model: optional string or "gpt-image-1.5" or "gpt-image-2" or "gpt-image-2-2026-04-21" or 7 more or null (default: "gpt-image-2.5-sunburst")

        The GPT image model to use for image editing, including gpt-image-2, its dated +snapshot gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, +gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and +gpt-image-2.5-flare-2026-09-08. Defaults to gpt-image-2.5-sunburst.

        +

        gpt-image-1 was shut down on October 23, 2026. Use +gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.

        +
        One of the following:
        string
        "gpt-image-1.5" or "gpt-image-2" or "gpt-image-2-2026-04-21" or 7 more

        The GPT image model to use for image editing, including gpt-image-2, its dated +snapshot gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, +gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and +gpt-image-2.5-flare-2026-09-08. Defaults to gpt-image-2.5-sunburst.

        +

        gpt-image-1 was shut down on October 23, 2026. Use +gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.

        +
        One of the following:
        "gpt-image-1.5"
        "gpt-image-2"
        "gpt-image-2-2026-04-21"
        "gpt-image-2.5-sunburst"
        "gpt-image-2.5-sunburst-2026-09-08"
        "gpt-image-2.5-flare"
        "gpt-image-2.5-flare-2026-09-08"
        "gpt-image-1-mini"
        "chatgpt-image-latest"
        "gpt-image-1"

        Deprecated. GPT Image 1 was shut down on October 23, 2026. Use gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.

        +
        moderation: optional "low" or "auto" or null (default: "auto")

        Moderation level for GPT image models.

        +
        One of the following:
        "low"
        "auto"
        n: optional integer or null (default: 1)

        The number of edited images to generate.

        +
        minimum1
        maximum10
        output_compression: optional integer or null

        Compression level for jpeg or webp output.

        +
        minimum0
        maximum100
        output_format: optional "png" or "jpeg" or "webp" or null (default: "png")

        Output image format. Supported for GPT image models.

        +
        One of the following:
        "png"
        "jpeg"
        "webp"
        partial_images: optional integer or null (default: 0)

        The number of partial images to generate. This parameter is used for +streaming responses that return partial images. Value must be between 0 and 3. +When set to 0, the response will be a single image sent in one streaming event.

        +

        Note that the final image may be sent before the full number of partial images +are generated if the full image is generated more quickly.

        +
        minimum0
        maximum3
        quality: optional "low" or "medium" or "high" or 3 more or null (default: "auto")

        Output quality for GPT image models. The GPT image models support low, medium, +and high. gpt-image-2.5-sunburst and gpt-image-2.5-flare, including their +2026-09-08 snapshots, also support xhigh and max. Defaults to auto.

        +
        One of the following:
        "low"
        "medium"
        "high"
        "xhigh"
        "max"
        "auto"
        safety_identifier: optional string or null

        A stable identifier for an end user in your organization, used for safety monitoring and abuse detection. Hash a username or email address to avoid sending identifying information. A non-empty value takes precedence over the deprecated user parameter. If omitted, null, or empty, the API uses user when available. Learn more.

        +
        maxLength128
        size: optional string or "auto" or "1024x1024" or "1536x1024" or "1024x1536" or null (default: "auto")

        The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.

        +
        One of the following:
        string
        "auto" or "1024x1024" or "1536x1024" or "1024x1536"

        The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.

        +
        One of the following:
        "auto"
        "1024x1024"
        "1536x1024"
        "1024x1536"
        stream: optional boolean or null (default: false)

        Stream partial image results as events.

        +
        user: optional string

        Deprecated.

        +

        Deprecated: use safety_identifier instead. This parameter remains accepted for backward compatibility and is used when safety_identifier is omitted, null, or empty. Learn more.

        +
        Returns
        ImagesResponse object { created, background, data, 5 more }

        The response from the image generation endpoint.

        +
        created: integer

        The Unix timestamp (in seconds) of when the image was created.

        +
        formatunixtime
        background: optional "transparent" or "opaque"

        The background parameter used for the image generation. Either transparent or opaque.

        +
        One of the following:
        "transparent"
        "opaque"
        data: optional array of Image { b64_json, revised_prompt, url }

        The list of generated images.

        +
        b64_json: optional string

        The base64-encoded JSON of the generated image. Returned by default for GPT image models, or when response_format is set to b64_json for models that support that parameter.

        +
        revised_prompt: optional string

        The revised prompt used to generate the image, for models that support prompt revision. Not returned by GPT image models.

        +
        url: optional string

        The URL of the generated image when response_format is set to url for models that support that parameter. Unsupported for GPT image models.

        +
        formaturi
        output_format: optional "png" or "webp" or "jpeg"

        The output format of the image generation. Either png, webp, or jpeg.

        +
        One of the following:
        "png"
        "webp"
        "jpeg"
        quality: optional "low" or "medium" or "high" or 2 more

        The quality of the image generated. One of low, medium, high, xhigh, or max.

        +
        One of the following:
        "low"
        "medium"
        "high"
        "xhigh"
        "max"
        safety_identifier: optional string or null

        The effective safety identifier used for safety monitoring and abuse detection. This is the non-empty safety_identifier from the request, or the deprecated user value when safety_identifier is omitted, null, or empty.

        +
        size: optional string or "1024x1024" or "1024x1536" or "1536x1024"

        The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.

        +
        One of the following:
        string
        "1024x1024" or "1024x1536" or "1536x1024"

        The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.

        +
        One of the following:
        "1024x1024"
        "1024x1536"
        "1536x1024"
        usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }

        For gpt-image-1 only, the token usage information for the image generation.

        +
        input_tokens: integer

        The number of tokens (images and text) in the input prompt.

        +
        input_tokens_details: object { image_tokens, text_tokens }

        The input tokens detailed information for the image generation.

        +
        image_tokens: integer

        The number of image tokens in the input prompt.

        +
        text_tokens: integer

        The number of text tokens in the input prompt.

        +
        output_tokens: integer

        The number of output tokens generated by the model.

        +
        total_tokens: integer

        The total number of tokens (images and text) used for the image generation.

        +
        output_tokens_details: optional object { image_tokens, text_tokens }

        The output token details for the image generation.

        +
        image_tokens: integer

        The number of image output tokens generated by the model.

        +
        text_tokens: integer

        The number of text output tokens generated by the model.

        +

        Create image edit

        curl -s -D >(grep -i x-request-id >&2) \
+  -o >(jq -r '.data[0].b64_json' | base64 --decode > gift-basket.png) \
+  -X POST "https://api.openai.com/v1/images/edits" \
+  -H "Authorization: Bearer $OPENAI_API_KEY" \
+  -F "model=gpt-image-1.5" \
+  -F "image[]=@body-lotion.png" \
+  -F "image[]=@bath-bomb.png" \
+  -F "image[]=@incense-kit.png" \
+  -F "image[]=@soap.png" \
+  -F 'prompt=Create a lovely gift basket with these four items in it'
+
        Returns Examples
        200 — Example
        {
+  "created": 0,
+  "background": "transparent",
+  "data": [
+    {
+      "b64_json": "b64_json",
+      "revised_prompt": "revised_prompt",
+      "url": "https://example.com"
+    }
+  ],
+  "output_format": "png",
+  "quality": "low",
+  "safety_identifier": "safety_identifier",
+  "size": "1024x1024",
+  "usage": {
+    "input_tokens": 0,
+    "input_tokens_details": {
+      "image_tokens": 0,
+      "text_tokens": 0
+    },
+    "output_tokens": 0,
+    "total_tokens": 0,
+    "output_tokens_details": {
+      "image_tokens": 0,
+      "text_tokens": 0
+    }
+  }
+}
        \ No newline at end of file diff --git a/pipeline/provider_docs/urls.txt b/pipeline/provider_docs/urls.txt new file mode 100644 index 0000000000000000000000000000000000000000..64418113891614779a34e0bf2d11d78eef376f69 --- /dev/null +++ b/pipeline/provider_docs/urls.txt @@ -0,0 +1,17 @@ +openai https://developers.openai.com/api/reference/resources/images/methods/edit +google https://ai.google.dev/gemini-api/docs/image-generation +google https://ai.google.dev/api/generate-content +bytedance https://docs.byteplus.com/en/docs/modelark/image-generation-api +meta https://dev.meta.ai/docs/api-reference/images/schemas +bfl https://api.bfl.ai/openapi.json +bfl https://docs.bfl.ml/flux_3/flux3_image_layout.md +ideogram https://api.ideogram.ai/openapi.json +microsoft https://learn.microsoft.com/en-us/azure/foundry/foundry-models/how-to/use-foundry-models-mai +xai https://docs.x.ai/developers/rest-api-reference/inference/images.md +xai https://docs.x.ai/developers/model-capabilities/images/generation.md +kling https://kling.ai/document-api/api/image/3-0-omni/image-omni +alibaba https://www.alibabacloud.com/help/en/model-studio/wan-image-generation-and-editing-api-reference +alibaba https://www.alibabacloud.com/help/en/model-studio/wan-image-edit +alibaba https://www.alibabacloud.com/help/en/model-studio/qwen-image-generation-and-editing-api-reference +luma https://docs.agents.lumalabs.ai/guides/faq/index.md +luma https://docs.agents.lumalabs.ai/api/resources/generations/methods/create/index.md diff --git a/pipeline/provider_docs/wayback_retry.tsv b/pipeline/provider_docs/wayback_retry.tsv new file mode 100644 index 0000000000000000000000000000000000000000..8f09cedf13c6b761100af00c79e7ef6d1c760e81 --- /dev/null +++ b/pipeline/provider_docs/wayback_retry.tsv @@ -0,0 +1,5 @@ +302 https://web.archive.org/web/20261030162131/https://docs.x.ai/developers/rest-api-reference/inference/images.md https://docs.x.ai/developers/rest-api-reference/inference/images.md +302 https://web.archive.org/web/20261030162311/https://docs.x.ai/developers/model-capabilities/images/generation.md https://docs.x.ai/developers/model-capabilities/images/generation.md +302 https://web.archive.org/web/20261030162446/https://kling.ai/document-api/api/image/3-0-omni/image-omni https://kling.ai/document-api/api/image/3-0-omni/image-omni +302 https://web.archive.org/web/20261030165233/https://docs.agents.lumalabs.ai/guides/faq/index.md https://docs.agents.lumalabs.ai/guides/faq/index.md +302 https://web.archive.org/web/20261030165409/https://docs.agents.lumalabs.ai/api/resources/generations/methods/create/index.md https://docs.agents.lumalabs.ai/api/resources/generations/methods/create/index.md diff --git a/pipeline/provider_docs/xai__docs.x.ai_developers_model-capabilities_images_generation.md b/pipeline/provider_docs/xai__docs.x.ai_developers_model-capabilities_images_generation.md new file mode 100644 index 0000000000000000000000000000000000000000..0a4b01fa7f41f84a72ca6f28796860c5a12ea3e2 --- /dev/null +++ b/pipeline/provider_docs/xai__docs.x.ai_developers_model-capabilities_images_generation.md @@ -0,0 +1,593 @@ +#### Model Capabilities + +# Image Generation + +Generate images from text prompts with Grok Imagine models. The API supports batch generation of multiple images, and control over aspect ratio, resolution, and quality. + +## Quick Start + +Generate an image with a single API call: + +```javascript customLanguage="javascriptAISDK" +import { xai } from "@ai-sdk/xai"; +import { generateImage } from "ai"; + +const { image } = await generateImage({ + model: xai.image("grok-imagine-image-2.0"), + prompt: "A collage of London landmarks in a stenciled street‑art style", +}); + +console.log(image.base64); +``` + +```python customLanguage="pythonOpenAISDK" +from openai import OpenAI + +client = OpenAI( + base_url="https://api.x.ai/v1", + api_key="YOUR_API_KEY", +) + +response = client.images.generate( + model="grok-imagine-image-2.0", + prompt="A collage of London landmarks in a stenciled street‑art style", +) + +print(response.data[0].url) +``` + +```bash +curl -X POST https://api.x.ai/v1/images/generations \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $XAI_API_KEY" \ + -d '{ + "model": "grok-imagine-image-2.0", + "prompt": "A collage of London landmarks in a stenciled street‑art style" + }' +``` + +```javascript customLanguage="javascriptOpenAISDK" +import OpenAI from "openai"; + +const client = new OpenAI({ + apiKey: process.env.XAI_API_KEY, + baseURL: 'https://api.x.ai/v1', +}); + +const response = await client.images.generate({ + model: "grok-imagine-image-2.0", + prompt: "A collage of London landmarks in a stenciled street‑art style", +}); + +console.log(response.data[0].url); +``` + +```python customLanguage="pythonXAI" +import xai_sdk + +client = xai_sdk.Client() + +response = client.image.sample( + prompt="A collage of London landmarks in a stenciled street‑art style", + model="grok-imagine-image-2.0", +) + +print(response.url) +``` + +Images are returned as URLs by default. URLs are temporary, so download or process promptly. You can also request [base64 output](#base64-output) for embedding images directly. + +## Configuration + +### Multiple Images + +Generate multiple images in a single request with the `n` parameter (`1`–`10`). On the REST API and OpenAI-compatible SDKs, `n` is optional and defaults to `1`. The xAI Python SDK uses `sample()` for a single image and `sample_batch(n=...)` for more than one — `n` is required on `sample_batch()`. + +```javascript customLanguage="javascriptAISDK" +import { xai } from "@ai-sdk/xai"; +import { generateImage } from "ai"; + +const { images } = await generateImage({ + model: xai.image("grok-imagine-image-2.0"), + prompt: "A futuristic city skyline at night", + n: 4, +}); + +images.forEach((image, i) => { + console.log(`Variation ${i + 1}: ${image.base64.slice(0, 50)}...`); +}); + +``` + +```python customLanguage="pythonOpenAISDK" +from openai import OpenAI + +client = OpenAI( + base_url="https://api.x.ai/v1", + api_key="YOUR_API_KEY", +) + +response = client.images.generate( + model="grok-imagine-image-2.0", + prompt="A futuristic city skyline at night", + n=4, +) + +for i, image in enumerate(response.data): + print(f"Variation {i + 1}: {image.url}") +``` + +```javascript customLanguage="javascriptOpenAISDK" +import OpenAI from "openai"; + +const client = new OpenAI({ + apiKey: process.env.XAI_API_KEY, + baseURL: "https://api.x.ai/v1", +}); + +const response = await client.images.generate({ + model: "grok-imagine-image-2.0", + prompt: "A futuristic city skyline at night", + n: 4, +}); + +response.data.forEach((image, i) => { + console.log(`Variation ${i + 1}: ${image.url}`); +}); + +``` + +```bash +curl -X POST https://api.x.ai/v1/images/generations \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $XAI_API_KEY" \ + -d '{ + "model": "grok-imagine-image-2.0", + "prompt": "A futuristic city skyline at night", + "n": 4 + }' +``` + +```python customLanguage="pythonXAI" +import xai_sdk + +client = xai_sdk.Client() + +responses = client.image.sample_batch( + prompt="A futuristic city skyline at night", + model="grok-imagine-image-2.0", + n=4, +) + +for i, image in enumerate(responses): + print(f"Variation {i + 1}: {image.url}") +``` + +### Aspect Ratio + +Control image dimensions with the `aspect_ratio` parameter. When omitted, the default is `auto`, which lets the model pick the best ratio for the prompt. + +| Ratio | Use case | +|-------|----------| +| `1:1` | Social media, thumbnails | +| `16:9` / `9:16` | Widescreen, mobile, stories | +| `4:3` / `3:4` | Presentations, portraits | +| `3:2` / `2:3` | Photography | +| `2:1` / `1:2` | Banners, headers | +| `19.5:9` / `9:19.5` | Modern smartphone displays (iPhone) | +| `20:9` / `9:20` | Modern smartphone displays (Android) | +| `21:9` | Cinematic widescreen | +| `5:2` | Wide banners | +| `auto` | Model auto-selects the best ratio for the prompt | + +```javascript customLanguage="javascriptAISDK" +import { xai } from "@ai-sdk/xai"; +import { generateImage } from "ai"; + +const { image } = await generateImage({ + model: xai.image("grok-imagine-image-2.0"), + prompt: "Mountain landscape at sunrise", + aspectRatio: "16:9", +}); + +console.log(image.base64); +``` + +```python customLanguage="pythonOpenAISDK" +from openai import OpenAI + +client = OpenAI( + base_url="https://api.x.ai/v1", + api_key="YOUR_API_KEY", +) + +response = client.images.generate( + model="grok-imagine-image-2.0", + prompt="Mountain landscape at sunrise", + extra_body={"aspect_ratio": "16:9"}, +) + +print(response.data[0].url) +``` + +```javascript customLanguage="javascriptOpenAISDK" +import OpenAI from "openai"; + +const client = new OpenAI({ + apiKey: process.env.XAI_API_KEY, + baseURL: "https://api.x.ai/v1", +}); + +const response = await client.images.generate({ + model: "grok-imagine-image-2.0", + prompt: "Mountain landscape at sunrise", + + aspect_ratio: "16:9", +}); + +console.log(response.data[0].url); +``` + +```bash +curl -X POST https://api.x.ai/v1/images/generations \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $XAI_API_KEY" \ + -d '{ + "model": "grok-imagine-image-2.0", + "prompt": "Mountain landscape at sunrise", + "aspect_ratio": "16:9" + }' +``` + +```python customLanguage="pythonXAI" +import xai_sdk + +client = xai_sdk.Client() + +response = client.image.sample( + prompt="Mountain landscape at sunrise", + model="grok-imagine-image-2.0", + aspect_ratio="16:9", +) + +print(response.url) +``` + +### Resolution + +You can specify different resolutions of the output image with the `resolution` parameter. Currently supported image resolutions are: + +* `1k` (default when omitted) +* `2k` + +```javascript customLanguage="javascriptAISDK" +import { xai } from "@ai-sdk/xai"; +import { generateImage } from "ai"; + +const { image } = await generateImage({ + model: xai.image("grok-imagine-image-2.0"), + prompt: "An astronaut performing EVA in LEO.", + providerOptions: { + xai: { resolution: "2k" }, + }, +}); + +console.log(image.base64); +``` + +```python customLanguage="pythonOpenAISDK" +from openai import OpenAI + +client = OpenAI( + base_url="https://api.x.ai/v1", + api_key="YOUR_API_KEY", +) + +response = client.images.generate( + model="grok-imagine-image-2.0", + prompt="An astronaut performing EVA in LEO.", + extra_body={"resolution": "2k"}, +) + +print(response.data[0].url) +``` + +```javascript customLanguage="javascriptOpenAISDK" +import OpenAI from "openai"; + +const client = new OpenAI({ + apiKey: process.env.XAI_API_KEY, + baseURL: "https://api.x.ai/v1", +}); + +const response = await client.images.generate({ + model: "grok-imagine-image-2.0", + prompt: "An astronaut performing EVA in LEO.", + + resolution: "2k", +}); + +console.log(response.data[0].url); +``` + +```bash +curl -X POST https://api.x.ai/v1/images/generations \ +-H "Content-Type: application/json" \ +-H "Authorization: Bearer $XAI_API_KEY" \ +-d '{ + "model": "grok-imagine-image-2.0", + "prompt": "An astronaut performing EVA in LEO.", + "resolution": "2k" +}' +``` + +```python customLanguage="pythonXAI" +import xai_sdk + +client = xai_sdk.Client() + +response = client.image.sample( + prompt="An astronaut performing EVA in LEO.", + model="grok-imagine-image-2.0", + resolution="2k" +) + +print(response.url) +``` + +### Quality + +Control generation quality with the optional `quality` parameter. Allowed values are `low`, `medium`, and `auto`. When omitted, the default is `auto`, which lets the service choose the quality for each request. Auto currently uses `low` for image generation and `medium` for [image editing](/developers/model-capabilities/images/editing). Images are billed at the quality they are served at (see [Pricing](/developers/pricing)). Pass `low` or `medium` to pin a specific quality. The parameter is only supported for `grok-imagine-image-2.0`. + +```bash +curl -X POST https://api.x.ai/v1/images/generations \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $XAI_API_KEY" \ + -d '{ + "model": "grok-imagine-image-2.0", + "prompt": "A watercolor painting of a lighthouse at dawn", + "quality": "low" + }' +``` + +```python customLanguage="pythonXAI" +import xai_sdk + +client = xai_sdk.Client() + +response = client.image.sample( + prompt="A watercolor painting of a lighthouse at dawn", + model="grok-imagine-image-2.0", + quality="low", +) + +print(response.url) +``` + +### Base64 Output + +Control the output format with the `response_format` parameter. When omitted, the default is `url`, which returns temporary hosted URLs. For embedding images directly without downloading, request base64: + +```javascript customLanguage="javascriptAISDK" +import { xai } from "@ai-sdk/xai"; +import { generateImage } from "ai"; +import fs from "fs"; + +const { image } = await generateImage({ + model: xai.image("grok-imagine-image-2.0"), + prompt: "A serene Japanese garden", +}); + +// Save to file (AI SDK returns base64 by default) +const imageBuffer = Buffer.from(image.base64, "base64"); +fs.writeFileSync("garden.jpg", imageBuffer); +``` + +```python customLanguage="pythonOpenAISDK" +import base64 +from openai import OpenAI + +client = OpenAI( + base_url="https://api.x.ai/v1", + api_key="YOUR_API_KEY", +) + +response = client.images.generate( + model="grok-imagine-image-2.0", + prompt="A serene Japanese garden", + response_format="b64_json", +) + +# Save to file +image_bytes = base64.b64decode(response.data[0].b64_json) +with open("garden.jpg", "wb") as f: + f.write(image_bytes) +``` + +```javascript customLanguage="javascriptOpenAISDK" +import OpenAI from "openai"; +import fs from "fs"; + +const client = new OpenAI({ + apiKey: process.env.XAI_API_KEY, + baseURL: "https://api.x.ai/v1", +}); + +const response = await client.images.generate({ + model: "grok-imagine-image-2.0", + prompt: "A serene Japanese garden", + response_format: "b64_json", +}); + +// Save to file +const imageBuffer = Buffer.from(response.data[0].b64_json, "base64"); +fs.writeFileSync("garden.jpg", imageBuffer); +``` + +```bash +curl -X POST https://api.x.ai/v1/images/generations \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $XAI_API_KEY" \ + -d '{ + "model": "grok-imagine-image-2.0", + "prompt": "A serene Japanese garden", + "response_format": "b64_json" + }' +``` + +```python customLanguage="pythonXAI" +import xai_sdk + +client = xai_sdk.Client() + +response = client.image.sample( + prompt="A serene Japanese garden", + model="grok-imagine-image-2.0", + image_format="base64", +) + +# Save to file +with open("garden.jpg", "wb") as f: + f.write(response.image) +``` + +### Deferred Generation + +Image generation normally completes within the request. For long-running batches, or to avoid holding a connection open, set `deferred: true` on `/v1/images/generations` or `/v1/images/edits`. The request returns a `request_id` immediately; poll `GET /v1/images/{request_id}` for the result. Deferred requests support `response_format: "url"` only (the default). Results are stored alongside [deferred chat completions](/developers/advanced-api-usage/deferred-chat-completions) and retained for 24 hours. + +The poll response carries a `status`: + +* `pending` (HTTP `202`): still generating +* `done` (HTTP `200`): `data` and `usage` are populated, in the same shape as a synchronous response +* `failed` (HTTP `200`): `error` holds a `code` and `message` + +```python customLanguage="pythonRequests" +import os +import time +import requests + +headers = { + "Authorization": f"Bearer {os.getenv('XAI_API_KEY')}", + "Content-Type": "application/json", +} + +# Step 1: Start generation +response = requests.post( + "https://api.x.ai/v1/images/generations", + headers=headers, + json={ + "model": "grok-imagine-image-2.0", + "prompt": "A serene Japanese garden", + "deferred": True, + }, +) +request_id = response.json()["request_id"] + +# Step 2: Poll for the result +while True: + result = requests.get( + f"https://api.x.ai/v1/images/{request_id}", + headers={"Authorization": headers["Authorization"]}, + ) + data = result.json() + + if data["status"] == "done": + print(f"Image URL: {data['data'][0]['url']}") + break + elif data["status"] == "failed": + print(f"Generation failed: {data['error']['message']}") + break + else: + print("Still processing...") + time.sleep(5) +``` + +```bash +# Step 1: Start generation +curl -X POST https://api.x.ai/v1/images/generations \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $XAI_API_KEY" \ + -d '{ + "model": "grok-imagine-image-2.0", + "prompt": "A serene Japanese garden", + "deferred": true + }' +# => {"request_id": "..."} + +# Step 2: Poll for the result +curl https://api.x.ai/v1/images/ \ + -H "Authorization: Bearer $XAI_API_KEY" +# => 202 {"request_id": "...", "status": "pending"} +# => 200 {"request_id": "...", "status": "done", "data": [{"url": "...", "mime_type": "image/jpeg"}], "usage": {...}} +``` + +You can also register a [webhook](/developers/rest-api-reference/management/webhooks) for the `image.generation.completed`, `image.generation.failed`, `image.edit.completed` and `image.edit.failed` events instead of polling. + +### Response Details + +The xAI SDK exposes additional metadata on the response object beyond the image URL or base64 data. + +**Moderation** — Check whether the generated image passed content moderation: + +```python customLanguage="pythonXAI" +if response.respect_moderation: + print(response.url) +else: + print("Image filtered by moderation") +``` + +**Model** — Get the actual model used (resolving any aliases): + +```python customLanguage="pythonXAI" +print(f"Model: {response.model}") +``` + +## Concurrent Requests + +When you need to generate multiple images with **different prompts**, such as generating unrelated images in parallel, use `AsyncClient` with `asyncio.gather` to fire requests concurrently. This is significantly faster than issuing them one at a time. + +> [!TIP] +> +> If you want multiple variations from the **same prompt**, use [`sample_batch()` with the `n` parameter\`](#multiple-images) instead. That generates all images in a single request and is the most efficient approach for same-prompt generation. + +```python customLanguage="pythonXAI" +import asyncio +import xai_sdk + +async def generate_concurrently(): + client = xai_sdk.AsyncClient() + + # Each request uses a different prompt + prompts = [ + "A futuristic city skyline at sunset", + "A serene Japanese garden in winter", + "An astronaut floating above Earth", + "A medieval castle on a misty mountain", + ] + + # Fire all requests concurrently + tasks = [ + client.image.sample( + prompt=prompt, + model="grok-imagine-image-2.0", + ) + for prompt in prompts + ] + + results = await asyncio.gather(*tasks) + + for prompt, result in zip(prompts, results): + print(f"{prompt}: {result.url}") + +asyncio.run(generate_concurrently()) +``` + +## Related + +* [Models](/developers/models) — Available image models +* [Image Editing](/developers/model-capabilities/images/editing) — Edit images with natural language +* [Image Prompting Guide](/developers/model-capabilities/images/prompting-guide) — Write prompts that keep the subject recognizable +* [Image Generation Tool](/developers/tools/image-generation) — Let Grok generate and edit images inside a conversation +* [Video Generation](/developers/model-capabilities/video/generation) — Generate videos from text prompts +* [API Reference](/developers/rest-api-reference) — Full endpoint documentation +* [Imagine API Landing Page](https://x.ai/api/imagine) — Showcase of the Imagine API in action diff --git a/pipeline/provider_docs/xai__docs.x.ai_developers_rest-api-reference_inference_images.md b/pipeline/provider_docs/xai__docs.x.ai_developers_rest-api-reference_inference_images.md new file mode 100644 index 0000000000000000000000000000000000000000..a1a380dd6dba372f58f02936f8bed5d105a89a64 --- /dev/null +++ b/pipeline/provider_docs/xai__docs.x.ai_developers_rest-api-reference_inference_images.md @@ -0,0 +1,495 @@ +#### Inference API + +# Images + +## POST /v1/images/generations + +Generate an image based on a prompt. This is the endpoint for making generation requests to image generation models. + +### Request Body + +* `aspect_ratio` ("1:1" | "3:4" | "4:3" | "9:16" | "16:9" | "2:3" | "3:2" | "9:19.5" | "19.5:9" | "9:20" | "20:9" | "1:2" | "2:1" | "21:9" | "5:2" | "auto") + +* `deferred` (boolean | null) — If set, the request returns immediately with a \`request\_id\` and the + image is generated in the background. Poll \`GET /v1/images/\{request\_id}\` + for the result. Only \`response\_format: "url"\` is supported in this mode. + +* `model` (string | null) — Model to be used. + +* `n` (integer | null) — Number of images to be generated + +* `output` (object) + + * `upload_urls` (array\, required) — Signed URLs to upload the generated images via HTTP PUT, one per + image: the list length must equal \`n\` (default 1). Each PUT sends a + \`Content-Type\` equal to the image's \`mime\_type\` in the response + (\`image/jpeg\` unless the requested quality produces PNG), so sign the + URL for that type or without a Content-Type constraint. Azure Blob SAS + URLs also get \`x-ms-blob-type: BlockBlob\`. + +* `prompt` (string) — Prompt for image generation. + +* `resolution` ("1k" | "2k" | "1.5k") + +* `response_format` (string | null) — Response format to return the image in. Can be url or b64\_json. If b64\_json is specified, the image will be returned as a base64-encoded string instead of a url to the generated image file. + +* `storage_options` (object) + + * `expires_after` (integer | null) — Seconds from now until the file auto-expires. Maximum 2592000 (30 days). + If omitted, the file does not expire. + + * `filename` (string, required) — Filename for the stored file. + + * `public_url` (boolean | object) + +* `user` (string | null) — A unique identifier representing your end-user, which can help xAI to monitor and detect abuse. + +### Response Body + +* `data` (array\, required) — A list of generated image objects. + + * `b64_json` (string | null) — A base64-encoded string representation of the generated image (without the data-URI prefix), if \`b64\_json\` is specified as \`response\_format\` in the request. + + * `file_output` (object) + + * `expires_at` (integer | null) — Unix timestamp (seconds) when the stored file expires and will be + automatically deleted. Only present when the file has an expiration. + + * `file_id` (string, required) — Files API file\_id of the stored file. + + * `filename` (string, required) — Filename of the stored file. + + * `public_url` (string | null) — Public URL for the stored file. Only present when the request included + \`storage\_options.public\_url\` and creation succeeded. + + * `public_url_error` (string | null) — Human-readable error when \`storage\_options.public\_url\` was set but + public URL creation failed. The file was stored successfully. + + * `public_url_expires_at` (integer | null) — Unix timestamp (seconds) when the public URL expires. Present when + the public URL has an expiry, either from an explicit \`expires\_after\` + in the request or inherited from the file's TTL. + + * `mime_type` (string | null) — The MIME type of the generated image (e.g. \`image/png\`, \`image/jpeg\`, \`image/webp\`). + + * `storage_error` (string | null) — Human-readable error when \`storage\_options\` was set but the upload + failed. Absent on success or when storage was not requested. + + * `url` (string | null) — A url to the generated image, if \`response\_format\` is not specified or with \`url\` in the request. + +* `usage` (object) + + * `cost_in_usd_ticks` (integer, required) — The cost of this request expressed in USD ticks. + One USD cent equals 100,000,000 ticks, so one US dollar equals + 10,000,000,000 ticks. + + * `input_tokens` (integer | null) — Total input tokens: prompt text tokens + input image tokens + (the sum of \`input\_tokens\_details\`, where \`cached\_tokens\` is a subset + of \`text\_tokens\`, not additive). + + * `input_tokens_details` (object) + + * `cached_tokens` (integer, required) — Text tokens served from cache from previous requests (a subset of + \`text\_tokens\`). + + * `image_tokens` (integer, required) — Input image tokens, as reported by the image engine. + + * `text_tokens` (integer, required) — Prompt text tokens consumed by the prompt-rewriting (upsampler) LLM, + including any served from cache. + + * `output_tokens` (integer | null) — Total output tokens: rewritten-prompt text tokens + reasoning tokens + \+ generated image tokens (the sum of \`output\_tokens\_details\`). + + * `output_tokens_details` (object) + + * `image_tokens` (integer, required) — Generated image tokens, as reported by the image engine. + + * `reasoning_tokens` (integer, required) — Reasoning (thinking) tokens generated by the prompt-rewriting + (upsampler) LLM. + + * `text_tokens` (integer, required) — Rewritten-prompt text tokens generated by the prompt-rewriting + (upsampler) LLM, excluding reasoning tokens. + + * `total_tokens` (integer | null) — Total tokens (input + output). + +### Code Examples + +```pythonOpenAISDK +import os + +from openai import OpenAI + +client = OpenAI( + api_key=os.environ["XAI_API_KEY"], + base_url="https://api.x.ai/v1", +) + +response = client.images.generate( + model="grok-imagine-image-2.0", + prompt="A collage of London landmarks in a stenciled street‑art style", +) + +print(response.model_dump_json(indent=2)) +``` + +```bash +curl -s https://api.x.ai/v1/images/generations \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $XAI_API_KEY" \ + -d '{ + "model": "grok-imagine-image-2.0", + "prompt": "A collage of London landmarks in a stenciled street‑art style" + }' +``` + +```javascriptOpenAISDK +import OpenAI from "openai"; + +const client = new OpenAI({ + apiKey: process.env.XAI_API_KEY, + baseURL: "https://api.x.ai/v1", +}); + +const response = await client.images.generate({ + model: "grok-imagine-image-2.0", + prompt: "A collage of London landmarks in a stenciled street‑art style", +}); + +console.log(JSON.stringify(response, null, 2)); +``` + +\*\*Response example:\*\* + +```json +{ + "data": [ + { + "url": "..." + }, + { + "url": "..." + } + ] +} +``` + +*** + +## POST /v1/images/edits + +Edit an image based on a prompt. This is the endpoint for making edit requests to image generation models. + +### Request Body + +* `aspect_ratio` ("1:1" | "3:4" | "4:3" | "9:16" | "16:9" | "2:3" | "3:2" | "9:19.5" | "19.5:9" | "9:20" | "20:9" | "1:2" | "2:1" | "21:9" | "5:2" | "auto") + +* `deferred` (boolean | null) — If set, the request returns immediately with a \`request\_id\` and the + edit is generated in the background. Poll \`GET /v1/images/\{request\_id}\` + for the result. Only \`response\_format: "url"\` is supported in this mode. + +* `image` (object) + + * `file_id` (string | null) — File ID from the xAI Files API. Mutually exclusive with \`url\`. + The file must be an image (JPEG, PNG, or WebP) and fully uploaded. + + * `url` (string) — Public URL or base64-encoded data URL of the image (JPEG, PNG, or WebP). + Also accepts \`image\_url\` for compatibility. + Required when \`file\_id\` is not set. + +* `images` (array\) — List of input images for multi-reference editing. + Mutually exclusive with \`image\`. When multiple images are provided, + refer to them as \\\, \\\, etc. in the prompt. + + * `file_id` (string | null) — File ID from the xAI Files API. Mutually exclusive with \`url\`. + The file must be an image (JPEG, PNG, or WebP) and fully uploaded. + + * `url` (string) — Public URL or base64-encoded data URL of the image (JPEG, PNG, or WebP). + Also accepts \`image\_url\` for compatibility. + Required when \`file\_id\` is not set. + +* `model` (string | null) — Model to be used. + +* `n` (integer | null) — Number of image edits to be generated. + +* `output` (object) + + * `upload_urls` (array\, required) — Signed URLs to upload the generated images via HTTP PUT, one per + image: the list length must equal \`n\` (default 1). Each PUT sends a + \`Content-Type\` equal to the image's \`mime\_type\` in the response + (\`image/jpeg\` unless the requested quality produces PNG), so sign the + URL for that type or without a Content-Type constraint. Azure Blob SAS + URLs also get \`x-ms-blob-type: BlockBlob\`. + +* `prompt` (string, required) — Prompt for image editing. + +* `resolution` ("1k" | "2k" | "1.5k") + +* `response_format` (string | null) — Response format to return the image in. Can be \`url\` or \`b64\_json\`. If \`b64\_json\` is specified, the image will be returned as a base64-encoded string instead of a url to the generated image file. + +* `storage_options` (object) + + * `expires_after` (integer | null) — Seconds from now until the file auto-expires. Maximum 2592000 (30 days). + If omitted, the file does not expire. + + * `filename` (string, required) — Filename for the stored file. + + * `public_url` (boolean | object) + +* `user` (string | null) — A unique identifier representing your end-user, which can help xAI to monitor and detect abuse. + +### Response Body + +* `data` (array\, required) — A list of generated image objects. + + * `b64_json` (string | null) — A base64-encoded string representation of the generated image (without the data-URI prefix), if \`b64\_json\` is specified as \`response\_format\` in the request. + + * `file_output` (object) + + * `expires_at` (integer | null) — Unix timestamp (seconds) when the stored file expires and will be + automatically deleted. Only present when the file has an expiration. + + * `file_id` (string, required) — Files API file\_id of the stored file. + + * `filename` (string, required) — Filename of the stored file. + + * `public_url` (string | null) — Public URL for the stored file. Only present when the request included + \`storage\_options.public\_url\` and creation succeeded. + + * `public_url_error` (string | null) — Human-readable error when \`storage\_options.public\_url\` was set but + public URL creation failed. The file was stored successfully. + + * `public_url_expires_at` (integer | null) — Unix timestamp (seconds) when the public URL expires. Present when + the public URL has an expiry, either from an explicit \`expires\_after\` + in the request or inherited from the file's TTL. + + * `mime_type` (string | null) — The MIME type of the generated image (e.g. \`image/png\`, \`image/jpeg\`, \`image/webp\`). + + * `storage_error` (string | null) — Human-readable error when \`storage\_options\` was set but the upload + failed. Absent on success or when storage was not requested. + + * `url` (string | null) — A url to the generated image, if \`response\_format\` is not specified or with \`url\` in the request. + +* `usage` (object) + + * `cost_in_usd_ticks` (integer, required) — The cost of this request expressed in USD ticks. + One USD cent equals 100,000,000 ticks, so one US dollar equals + 10,000,000,000 ticks. + + * `input_tokens` (integer | null) — Total input tokens: prompt text tokens + input image tokens + (the sum of \`input\_tokens\_details\`, where \`cached\_tokens\` is a subset + of \`text\_tokens\`, not additive). + + * `input_tokens_details` (object) + + * `cached_tokens` (integer, required) — Text tokens served from cache from previous requests (a subset of + \`text\_tokens\`). + + * `image_tokens` (integer, required) — Input image tokens, as reported by the image engine. + + * `text_tokens` (integer, required) — Prompt text tokens consumed by the prompt-rewriting (upsampler) LLM, + including any served from cache. + + * `output_tokens` (integer | null) — Total output tokens: rewritten-prompt text tokens + reasoning tokens + \+ generated image tokens (the sum of \`output\_tokens\_details\`). + + * `output_tokens_details` (object) + + * `image_tokens` (integer, required) — Generated image tokens, as reported by the image engine. + + * `reasoning_tokens` (integer, required) — Reasoning (thinking) tokens generated by the prompt-rewriting + (upsampler) LLM. + + * `text_tokens` (integer, required) — Rewritten-prompt text tokens generated by the prompt-rewriting + (upsampler) LLM, excluding reasoning tokens. + + * `total_tokens` (integer | null) — Total tokens (input + output). + +### Code Examples + +```bash +curl -s https://api.x.ai/v1/images/edits \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $XAI_API_KEY" \ + -d '{ + "model": "grok-imagine-image-2.0", + "prompt": "Render this as a pencil sketch with detailed shading", + "image": { + "url": "https://docs.x.ai/assets/api-examples/images/style-realistic.png", + "type": "image_url" + } + }' +``` + +```javascriptWithoutSDK +const response = await fetch("https://api.x.ai/v1/images/edits", { + method: "POST", + headers: { + Authorization: `Bearer ${process.env.XAI_API_KEY}`, + "Content-Type": "application/json", + }, + body: JSON.stringify({ + model: "grok-imagine-image-2.0", + prompt: "Render this as a pencil sketch with detailed shading", + image: { + url: "https://docs.x.ai/assets/api-examples/images/style-realistic.png", + type: "image_url", + }, + }), +}); + +console.log(JSON.stringify(await response.json(), null, 2)); +``` + +```pythonWithoutSDK +import json +import os + +import requests + +response = requests.post( + "https://api.x.ai/v1/images/edits", + headers={ + "Authorization": f"Bearer {os.environ['XAI_API_KEY']}", + "Content-Type": "application/json", + }, + json={ + "model": "grok-imagine-image-2.0", + "prompt": "Render this as a pencil sketch with detailed shading", + "image": { + "url": "https://docs.x.ai/assets/api-examples/images/style-realistic.png", + "type": "image_url", + }, + }, +) + +print(json.dumps(response.json(), indent=2)) +``` + +\*\*Response example:\*\* + +```json +{ + "data": [ + { + "url": "..." + } + ] +} +``` + +*** + +## GET /v1/images/\{request\_id} + +\`GET /v1/images/\{request\_id}\`: 202 while pending, 200 with \`data\` when +done or with \`error\` when failed (a failed generation is a body, not an +HTTP error, so pollers do not retry-storm). + +### Path Parameters + +* `request_id` (string, required) — The deferred request id returned by a previous image request. + +### Response Body + +* `data` (array | null) — The generated images. Present when done. + +* `error` (object) + + * `code` (string, required) — Machine-readable error code: \`invalid\_argument\`, \`permission\_denied\`, + \`failed\_precondition\`, \`service\_unavailable\` or \`internal\_error\`. + + * `message` (string, required) — Human-readable error message describing the failure. + +* `request_id` (string, required) — The polled request id. + +* `status` (string, required) — \`"pending"\`, \`"done"\` or \`"failed"\`. + +* `usage` (object) + + * `cost_in_usd_ticks` (integer, required) — The cost of this request expressed in USD ticks. + One USD cent equals 100,000,000 ticks, so one US dollar equals + 10,000,000,000 ticks. + + * `input_tokens` (integer | null) — Total input tokens: prompt text tokens + input image tokens + (the sum of \`input\_tokens\_details\`, where \`cached\_tokens\` is a subset + of \`text\_tokens\`, not additive). + + * `input_tokens_details` (object) + + * `cached_tokens` (integer, required) — Text tokens served from cache from previous requests (a subset of + \`text\_tokens\`). + + * `image_tokens` (integer, required) — Input image tokens, as reported by the image engine. + + * `text_tokens` (integer, required) — Prompt text tokens consumed by the prompt-rewriting (upsampler) LLM, + including any served from cache. + + * `output_tokens` (integer | null) — Total output tokens: rewritten-prompt text tokens + reasoning tokens + \+ generated image tokens (the sum of \`output\_tokens\_details\`). + + * `output_tokens_details` (object) + + * `image_tokens` (integer, required) — Generated image tokens, as reported by the image engine. + + * `reasoning_tokens` (integer, required) — Reasoning (thinking) tokens generated by the prompt-rewriting + (upsampler) LLM. + + * `text_tokens` (integer, required) — Rewritten-prompt text tokens generated by the prompt-rewriting + (upsampler) LLM, excluding reasoning tokens. + + * `total_tokens` (integer | null) — Total tokens (input + output). + +### Code Examples + +```bash +curl -s "https://api.x.ai/v1/images/$IMAGE_REQUEST_ID" \ + -H "Authorization: Bearer $XAI_API_KEY" +``` + +```javascriptWithoutSDK +const response = await fetch( + `https://api.x.ai/v1/images/${process.env.IMAGE_REQUEST_ID}`, + { + headers: { + Authorization: `Bearer ${process.env.XAI_API_KEY}`, + }, + }, +); + +console.log(JSON.stringify(await response.json(), null, 2)); +``` + +```pythonWithoutSDK +import json +import os + +import requests + +request_id = os.environ["IMAGE_REQUEST_ID"] + +response = requests.get( + f"https://api.x.ai/v1/images/{request_id}", + headers={ + "Authorization": f"Bearer {os.environ['XAI_API_KEY']}", + }, +) + +print(json.dumps(response.json(), indent=2)) +``` + +\*\*Response example:\*\* + +```json +{ + "request_id": "e5b1b4d4-7b6a-4a0e-9c0d-7f3c7d8a1b2c", + "status": "done", + "data": [ + { + "url": "..." + } + ], + "usage": { + "total_tokens": 0, + "image_cost": 2000000 + } +} +```