Hugging Face's logo

Datasets:
Rapidata
/
multi-step-image-edit

Modalities:
Image
Text
Formats:
parquet
Size:
10K - 100K
Tags:
image-editing
human-preference
benchmark
identity
Libraries:
Datasets
Dask
Polars
License:
Dataset card Data Studio Files
xet
 Community
7
s-aniruddha commited on
Commit
23ec548
·
verified ·
1 Parent(s): 7dafdd9

Card, photo credits, model settings, standings and settings evidence for the 19 ranked models

Browse files
Files changed (50) hide show
  1. ATTRIBUTION.md +217 -0
  2. README.md +81 -0
  3. metadata/attribution.csv +200 -0
  4. metadata/models.json +444 -0
  5. metadata/photos.jsonl +0 -0
  6. metadata/standings.json +292 -0
  7. pipeline/fal_schemas/_fetched.txt +2 -0
  8. pipeline/fal_schemas/blackforestlabs__flux-3__edit-image.json +437 -0
  9. pipeline/fal_schemas/bytedance__seedream__v5__lite__edit.json +502 -0
  10. pipeline/fal_schemas/bytedance__seedream__v5__pro__edit.json +500 -0
  11. pipeline/fal_schemas/fal-ai__kling-image__o1.json +539 -0
  12. pipeline/fal_schemas/fal-ai__kling-image__o3__image-to-image.json +556 -0
  13. pipeline/fal_schemas/fal-ai__nano-banana-2__edit.json +1 -0
  14. pipeline/fal_schemas/fal-ai__nano-banana-pro__edit.json +1085 -0
  15. pipeline/fal_schemas/fal-ai__qwen-image-edit-2511.json +1 -0
  16. pipeline/fal_schemas/fal-ai__wan__v2.7__pro__edit.json +449 -0
  17. pipeline/fal_schemas/google__nano-banana-2.1__edit.json +539 -0
  18. pipeline/fal_schemas/ideogram__v4.5__edit.json +537 -0
  19. pipeline/fal_schemas/luma__agent__uni-1__v1__max__edit.json +378 -0
  20. pipeline/fal_schemas/meta__muse-image__edit.json +410 -0
  21. pipeline/fal_schemas/microsoft__mai-image-2.5-pro__edit.json +404 -0
  22. pipeline/fal_schemas/openai__gpt-image-2.5__flare__edit.json +512 -0
  23. pipeline/fal_schemas/openai__gpt-image-2.5__sunburst__edit.json +512 -0
  24. pipeline/fal_schemas/openai__gpt-image-2.6__flare__edit.json +1 -0
  25. pipeline/fal_schemas/openai__gpt-image-2.6__sunburst__edit.json +1 -0
  26. pipeline/fal_schemas/wayback_2026-11-06.tsv +4 -0
  27. pipeline/fal_schemas/xai__grok-imagine-image__v2.0__edit.json +459 -0
  28. pipeline/judge_prompt.txt +80 -0
  29. pipeline/provider_docs/ARCHIVE_NOTES.md +6 -0
  30. pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_qwen-image-generation-and-editing-api-reference +787 -0
  31. pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_wan-image-edit +0 -0
  32. pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_wan-image-generation-and-editing-api-reference +0 -0
  33. pipeline/provider_docs/bfl__api.bfl.ai_openapi.json +1 -0
  34. pipeline/provider_docs/bfl__docs.bfl.ml_flux_3_flux3_image_layout.md +243 -0
  35. pipeline/provider_docs/bytedance__docs.byteplus.com_en_docs_modelark_image-generation-api +0 -0
  36. pipeline/provider_docs/fetch_log.tsv +17 -0
  37. pipeline/provider_docs/google__ai.google.dev_api_generate-content +0 -0
  38. pipeline/provider_docs/google__ai.google.dev_gemini-api_docs_image-generation +0 -0
  39. pipeline/provider_docs/ideogram__api.ideogram.ai_openapi.json +0 -0
  40. pipeline/provider_docs/kling__kling.ai_document-api_api_image_3-0-omni_image-omni +364 -0
  41. pipeline/provider_docs/kling__rendered_text.txt +1 -0
  42. pipeline/provider_docs/luma__docs.agents.lumalabs.ai_api_resources_generations_methods_create_index.md +677 -0
  43. pipeline/provider_docs/luma__docs.agents.lumalabs.ai_guides_faq_index.md +728 -0
  44. pipeline/provider_docs/meta__dev.meta.ai_docs_api-reference_images_schemas +0 -0
  45. pipeline/provider_docs/microsoft__learn.microsoft.com_en-us_azure_foundry_foundry-models_how-to_use-foundry-models-mai +2073 -0
  46. pipeline/provider_docs/openai__developers.openai.com_api_reference_resources_images_methods_edit +0 -0
  47. pipeline/provider_docs/urls.txt +17 -0
  48. pipeline/provider_docs/wayback_retry.tsv +5 -0
  49. pipeline/provider_docs/xai__docs.x.ai_developers_model-capabilities_images_generation.md +593 -0
  50. pipeline/provider_docs/xai__docs.x.ai_developers_rest-api-reference_inference_images.md +495 -0
ATTRIBUTION.md ADDED
@@ -0,0 +1,217 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Photo credits
2
+
3
+ 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.
4
+
5
+ ## CC BY-SA 4.0 (106 photos, https://creativecommons.org/licenses/by-sa/4.0)
6
+
7
+ - `wc61267439`: "BandoneonistaMDP-jul2017.jpg" by Ezarate, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:BandoneonistaMDP-jul2017.jpg)
8
+ - `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)
9
+ - `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)
10
+ - `wc98796115`: "Francesco Maselli.jpg" by Giacomo Alessandroni, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Francesco_Maselli.jpg)
11
+ - `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)
12
+ - `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)
13
+ - `wc49640230`: "Alon Ben David.jpg" by Channel10israel, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Alon_Ben_David.jpg)
14
+ - `wc127813216`: "Bakhtiyor Rakhman.jpg" by Umarxon III, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Bakhtiyor_Rakhman.jpg)
15
+ - `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)
16
+ - `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)
17
+ - `wc164397906`: "Captain Joe, Friedrichshafen (P1046580).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Captain_Joe,_Friedrichshafen_(P1046580).jpg)
18
+ - `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)
19
+ - `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)
20
+ - `wc68327807`: "Darshan Singh, Village Akbarpur Afghana.jpg" by Satdeep Gill, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Darshan_Singh,_Village_Akbarpur_Afghana.jpg)
21
+ - `wc45337546`: "Ak55-Busy afternoon.jpg" by Zuraj studio, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Ak55-Busy_afternoon.jpg)
22
+ - `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)
23
+ - `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)
24
+ - `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)
25
+ - `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)
26
+ - `wc110020707`: "Michelin at IAA 2021 1X7A0159.jpg" by Alexander Migl, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Michelin_at_IAA_2021_1X7A0159.jpg)
27
+ - `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)
28
+ - `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)
29
+ - `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)
30
+ - `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)
31
+ - `wc48134404`: "Cobbler in Udaipur.jpg" by Clément Bardot, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Cobbler_in_Udaipur.jpg)
32
+ - `wc187580499`: "Chechia Maker in his shop.jpg" by IssamBarhoumi, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Chechia_Maker_in_his_shop.jpg)
33
+ - `wc9590173`: "Potter and his wife.jpg" by © Yann Forget / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Potter_and_his_wife.jpg)
34
+ - `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)
35
+ - `wc64396409`: "Beignet maker.jpg" by IssamBarhoumi, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Beignet_maker.jpg)
36
+ - `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)
37
+ - `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)
38
+ - `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)
39
+ - `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)
40
+ - `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)
41
+ - `wc37036117`: "Cheek - Rakuuna Rock 2014 1.jpg" by Tuomas Vitikainen, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Cheek_-_Rakuuna_Rock_2014_1.jpg)
42
+ - `wc6900196`: "Sari 2.jpg" by © Yann Forget / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sari_2.jpg)
43
+ - `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)
44
+ - `wc81720138`: "Tambourin.jpg" by Bertrand Fanonnel | Eight Studio, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Tambourin.jpg)
45
+ - `wc79628058`: "P2N2019ClaraLuciani 03.jpg" by Selbymay, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:P2N2019ClaraLuciani_03.jpg)
46
+ - `wc62403000`: "Kia, IAA 2017 (1Y7A2595).jpg" by MB-one, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Kia,_IAA_2017_(1Y7A2595).jpg)
47
+ - `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)
48
+ - `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)
49
+ - `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)
50
+ - `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)
51
+ - `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)
52
+ - `wc77297064`: "Sanni - Ilosaarirock 2018 - 02.jpg" by Tuomas Vitikainen, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sanni_-_Ilosaarirock_2018_-_02.jpg)
53
+ - `wc71365077`: "IAA 2017, Frankfurt (1Y7A1813).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:IAA_2017,_Frankfurt_(1Y7A1813).jpg)
54
+ - `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)
55
+ - `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)
56
+ - `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)
57
+ - `wc70180444`: "Mermaid Parade (60015).jpg" by Rhododendrites, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Mermaid_Parade_(60015).jpg)
58
+ - `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)
59
+ - `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)
60
+ - `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)
61
+ - `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)
62
+ - `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)
63
+ - `wc43469543`: "Groupe Tribal Percussions - 248.jpg" by © William Crochot / Wikimedia Commons, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Groupe_Tribal_Percussions_-_248.jpg)
64
+ - `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)
65
+ - `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)
66
+ - `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)
67
+ - `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)
68
+ - `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)
69
+ - `wc55676665`: "Tunisian Musicians 04.jpg" by Hamed Gamaoun, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Tunisian_Musicians_04.jpg)
70
+ - `wc45035857`: "GedFunerailles0.JPG" by Mbiele Happi, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:GedFunerailles0.JPG)
71
+ - `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)
72
+ - `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)
73
+ - `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)
74
+ - `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)
75
+ - `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)
76
+ - `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)
77
+ - `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)
78
+ - `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)
79
+ - `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)
80
+ - `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)
81
+ - `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)
82
+ - `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)
83
+ - `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)
84
+ - `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)
85
+ - `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)
86
+ - `wc110020721`: "Michelin at IAA 2021 1X7A0161.jpg" by Alexander Migl, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Michelin_at_IAA_2021_1X7A0161.jpg)
87
+ - `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)
88
+ - `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)
89
+ - `wc69984498`: "OutDoor 2018, Friedrichshafen (1X7A9907).jpg" by Matti Blume, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:OutDoor_2018,_Friedrichshafen_(1X7A9907).jpg)
90
+ - `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)
91
+ - `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)
92
+ - `wc164201681`: "Farmer at harvest.jpg" by Photobyamin, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Farmer_at_harvest.jpg)
93
+ - `wc77740619`: "Woman harvesting tea, West Bengal.jpg" by Bernard Gagnon, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Woman_harvesting_tea,_West_Bengal.jpg)
94
+ - `wc87211151`: "The water transfer.jpg" by Mikhail Kapychka, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:The_water_transfer.jpg)
95
+ - `wc36791367`: "PersonaMardel.jpg" by Ezarate, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:PersonaMardel.jpg)
96
+ - `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)
97
+ - `wc34178099`: "EmanuelHarrold.JPG" by Eric Magnan, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:EmanuelHarrold.JPG)
98
+ - `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)
99
+ - `wc87403339`: "Yuyuan Garden 3.jpg" by kallerna, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Yuyuan_Garden_3.jpg)
100
+ - `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)
101
+ - `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)
102
+ - `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)
103
+ - `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)
104
+ - `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)
105
+ - `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)
106
+ - `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)
107
+ - `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)
108
+ - `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)
109
+ - `wc37667675`: "Yair Aharoni.jpg" by Arielinson, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Yair_Aharoni.jpg)
110
+ - `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)
111
+ - `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)
112
+ - `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)
113
+
114
+ ## CC BY-SA 3.0 (57 photos, https://creativecommons.org/licenses/by-sa/3.0)
115
+
116
+ - `wc15467676`: "FarmWorker.JPG" by Arne Hückelheim, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:FarmWorker.JPG)
117
+ - `wc31140258`: "Antti Kiiski - Rakuunarock 2013.jpg" by Tuomas Vitikainen, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Antti_Kiiski_-_Rakuunarock_2013.jpg)
118
+ - `wc22487838`: "Geneetik Riin Tamm.jpg" by Lauri Kulpsoo, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Geneetik_Riin_Tamm.jpg)
119
+ - `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)
120
+ - `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)
121
+ - `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)
122
+ - `wc7231228`: "Woman doing laundry.jpg" by Bernard Gagnon, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Woman_doing_laundry.jpg)
123
+ - `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)
124
+ - `wc12185576`: "Quito Accordion player.jpg" by Cayambe, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Quito_Accordion_player.jpg)
125
+ - `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)
126
+ - `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)
127
+ - `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)
128
+ - `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)
129
+ - `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)
130
+ - `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)
131
+ - `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)
132
+ - `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)
133
+ - `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)
134
+ - `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)
135
+ - `wc18749683`: "Cody ChesnuTT - Ilosaarirock 2011.jpg" by Tuomas Vitikainen, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Cody_ChesnuTT_-_Ilosaarirock_2011.jpg)
136
+ - `wc18529819`: "John Petrucci - 02.jpg" by Carlos Delgado, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:John_Petrucci_-_02.jpg)
137
+ - `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)
138
+ - `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)
139
+ - `wc15099922`: "Agnes Milowka by J Axford.jpg" by James Axford, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Agnes_Milowka_by_J_Axford.jpg)
140
+ - `wc12797457`: "7th Marquis of Colmondeley 2.jpg" by Allan Warren, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:7th_Marquis_of_Colmondeley_2.jpg)
141
+ - `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)
142
+ - `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)
143
+ - `wc11127070`: "Nottingham Pride MMB 67 Kenelis.jpg" by mattbuck, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Nottingham_Pride_MMB_67_Kenelis.jpg)
144
+ - `wc47590527`: "Cañari woman 02.jpg" by Bernard Gagnon, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Ca%C3%B1ari_woman_02.jpg)
145
+ - `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)
146
+ - `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)
147
+ - `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)
148
+ - `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)
149
+ - `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)
150
+ - `wc16957573`: "Tatort vier Ermittler 2.jpg" by Superbass, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Tatort_vier_Ermittler_2.jpg)
151
+ - `wc15739979`: "Giorgio Moroder.jpg" by Wolfgang Moroder, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Giorgio_Moroder.jpg)
152
+ - `wc49316526`: "Kadavar-Bandfoto.jpg" by Henry W. Laurisch, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Kadavar-Bandfoto.jpg)
153
+ - `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)
154
+ - `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)
155
+ - `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)
156
+ - `wc4695242`: "NRWTag W Sonnborn 40 ies.jpg" by Frank Vincentz, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:NRWTag_W_Sonnborn_40_ies.jpg)
157
+ - `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)
158
+ - `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)
159
+ - `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)
160
+ - `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)
161
+ - `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)
162
+ - `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)
163
+ - `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)
164
+ - `wc15690652`: "Valdi Totev.jpg" by Plamen Agov • studiolemontree, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Valdi_Totev.jpg)
165
+ - `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)
166
+ - `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)
167
+ - `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)
168
+ - `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)
169
+ - `wc28942287`: "13-06 Budapest Dancing Show.jpg" by Achim Raschka, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:13-06_Budapest_Dancing_Show.jpg)
170
+ - `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)
171
+ - `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)
172
+ - `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)
173
+
174
+ ## CC BY-SA 2.0 fr (1 photos, https://creativecommons.org/licenses/by-sa/2.0/fr/deed.en)
175
+
176
+ - `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)
177
+
178
+ ## CC BY 4.0 (8 photos, https://creativecommons.org/licenses/by/4.0)
179
+
180
+ - `wc197117660`: "Suha Al-Masri.jpg" by Fuad Al-Qrize, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Suha_Al-Masri.jpg)
181
+ - `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)
182
+ - `wc143058460`: "Eva Nogales in 2023 06.jpg" by Cmichel67, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Eva_Nogales_in_2023_06.jpg)
183
+ - `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)
184
+ - `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)
185
+ - `wc64787263`: "Adrian Horridge FRS.jpg" by Thennicke, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Adrian_Horridge_FRS.jpg)
186
+ - `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)
187
+ - `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)
188
+
189
+ ## CC0 (27 photos, no attribution required; listed for provenance)
190
+
191
+ - `f25a67e0-e2c3-4918-a19b-fe9e1a65bd8f`: "Couple Park" by Senior Living, Stocksnap via Openverse (https://stocksnap.io/photo/couple-park-GL9XJQTLJK)
192
+ - `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)
193
+ - `ba7f0e82-efc6-4fe8-a12b-804c45c1c361`: "Woman Reading" by Burst, Stocksnap via Openverse (https://stocksnap.io/photo/woman-reading-VJM1ZWXLPY)
194
+ - `wc25393535`: "Coconut water vendor.jpg" by Wilfredor, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Coconut_water_vendor.jpg)
195
+ - `wc145843601`: "Khasi Lady in a Kitchen.jpg" by Wann Majaw, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Khasi_Lady_in_a_Kitchen.jpg)
196
+ - `ba231d2e-b834-4898-b6a0-2f154e708c09`: "Hospital Waiting" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/hospital-waiting-SSDEQHS17S)
197
+ - `wc25152397`: "Sad tomato seller.jpg" by Wilfredor, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Sad_tomato_seller.jpg)
198
+ - `dc5c1ac5-784d-469a-a37f-e313079908ee`: "Stairs Stairway" by Brooke Cagle, Stocksnap via Openverse (https://stocksnap.io/photo/stairs-stairway-D4XWI5PN82)
199
+ - `63a89c1d-dc76-41e5-95e9-5157825cd504`: "People Man" by Glen McCallum, Stocksnap via Openverse (https://stocksnap.io/photo/people-man-RWMC95HRC0)
200
+ - `b036af66-8c49-403b-9f0b-38ff46a89f73`: "Man Entering" by Bruce Mars, Stocksnap via Openverse (https://stocksnap.io/photo/man-entering-7GXMY2JMR4)
201
+ - `c70bc7ee-1701-4a79-94cd-f5325b6d5e30`: "Male Nurse" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/male-nurse-8OYPFEL4K8)
202
+ - `04e3d2a8-27ca-431c-92e1-402527e6b824`: "Wheelchair Person" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/wheelchair-person-OQZYXPNK5H)
203
+ - `6e58849a-cb37-4b82-930f-5546480e7417`: "Doctor Patient" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/doctor-patient-RZCTEGBC2V)
204
+ - `3b81d7c7-3cf6-4be8-8f01-75c9919c9bb8`: "Male Nurse" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/male-nurse-U1PTBWATO7)
205
+ - `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)
206
+ - `wc25393546`: "Palms seller for Palm Sunday.jpg" by Wilfredor, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Palms_seller_for_Palm_Sunday.jpg)
207
+ - `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)
208
+ - `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)
209
+ - `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)
210
+ - `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)
211
+ - `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)
212
+ - `255d4a22-4470-4638-9128-f10a6ebb503e`: "Happy Couple" by Senior Living, Stocksnap via Openverse (https://stocksnap.io/photo/happy-couple-7HBHYQSHPL)
213
+ - `40f1c4c5-b84c-42a0-a81d-ae528001bd7c`: "Diverse Workplace" by Direct Media, Stocksnap via Openverse (https://stocksnap.io/photo/diverse-workplace-UJ1P4WLT4N)
214
+ - `wc24642095`: "Cepillao ice cream vendor.jpg" by Wilfredor, Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Cepillao_ice_cream_vendor.jpg)
215
+ - `10494e50-fd2e-47f6-9295-0248b1eeed09`: "Happy Couple" by Senior Living, Stocksnap via Openverse (https://stocksnap.io/photo/happy-couple-VXFRCXXFG6)
216
+ - `4cc5938a-c9bd-4377-a4c6-d57192056040`: "Man Desk" by LinkedIn Sales Navigator, Stocksnap via Openverse (https://stocksnap.io/photo/man-desk-QPJWWR3W2E)
217
+ - `5f2648aa-cf39-42f7-b53a-e5fa703a296f`: "Man Exiting" by Bruce Mars, Stocksnap via Openverse (https://stocksnap.io/photo/man-exiting-1GYKJQOTMM)
README.md ADDED
@@ -0,0 +1,81 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cc-by-sa-4.0
3
+ pretty_name: Multi-step Image Edit (identity drift at step 5)
4
+ tags:
5
+ - image-editing
6
+ - human-preference
7
+ - benchmark
8
+ - identity
9
+ size_categories:
10
+ - 10K<n<100K
11
+ ---
12
+
13
+ # Multi-step Image Edit: identity drift at step 5
14
+
15
+ Human-preference benchmark by [Rapidata](https://www.rapidata.ai) on whether a person still looks like themselves after
16
+ five everyday edits that never touch the face. 19 image-editing models, 199 photographs of real people, 292,017 votes.
17
+
18
+ ## What it measures
19
+
20
+ Each photograph gets a chain of five instructions about clothing, objects or text in the scene. Step 1 edits the
21
+ photograph; every later step gets only the model's own output from the step before as its input image, with that step's
22
+ instruction, so the model never sees the original again. An automatic check (`pipeline/judge_prompt.txt`) confirms that
23
+ each edit was made; a step has three attempts, and a model is ranked only if at least 80% of its chains reach step 5.
24
+ Annotators then see two models' faces after the fifth edit, with the original face as reference, and answer "Which
25
+ **edited face** looks **more similar** to the **original face**? Ignore changes to hair, clothes and background." Every
26
+ pair of models meets in 320 matches on photographs both completed; each match is decided by the majority of its votes,
27
+ and the matches give Bradley–Terry scores.
28
+
29
+ ## How the images were made
30
+
31
+ Every setting is the lab's own API default, sent explicitly, except: highest quality, reasoning, thinking and precision;
32
+ watermarks off; the least restrictive moderation that can be sent; a fixed seed per model, photograph, step and attempt
33
+ where the model takes one. Where a model can set the aspect ratio or keep the input's, that is set and the resolution
34
+ stays at its default; Wan 2.7 Pro and the Qwen models get the input's exact size. Each model returns the format its lab's
35
+ API returns by default (JPEG for Seedream 5.0 Pro and Lite and Grok Imagine Image 2.0, WebP for Muse Image, PNG for the
36
+ rest), and each output is passed to the next step unchanged. Every setting sent per model, and why, is in
37
+ `metadata/models.json`; the evidence for the defaults is in `pipeline/fal_schemas/` (fal's endpoint definitions) and
38
+ `pipeline/provider_docs/` (the labs' API docs as saved on 2026-10-30, with Wayback Machine snapshot links in
39
+ `fetch_log.tsv` and `wayback_retry.tsv`).
40
+
41
+ ## Standings
42
+
43
+ | # | Model | Score | Called through | List price per edit |
44
+ |---|---|---|---|---|
45
+ | 1 | Ideogram 4.5 (High Quality, High Precision) | 1901 ±33 | fal `ideogram/v4.5/edit` | $0.22 |
46
+ | 2 | FLUX 3 Image | 1742 ±29 | fal `blackforestlabs/flux-3/edit-image` | $0.048 |
47
+ | 3 | Muse Image | 1490 ±24 | fal `meta/muse-image/edit` | $0.01 |
48
+ | 4 | Qwen-Image-2.1-Pro (Thinking) | 1373 ±23 | Alibaba Model Studio `qwen-image-2.1-pro` | $0.04 |
49
+ | 5 | Seedream 5.0 Pro | 1247 ±23 | fal `bytedance/seedream/v5/pro/edit` | $0.09 |
50
+ | 6 | MAI-Image-2.5-Pro | 1209 ±22 | fal `microsoft/mai-image-2.5-pro/edit` | $0.117 |
51
+ | 7 | Qwen-Image-3.0-Pro (Thinking) | 1079 ±22 | Alibaba Model Studio `qwen-image-3.0-pro` | $0.043 |
52
+ | 8 | GPT Image 2.6 Sunburst (Max Quality, High Reasoning) | 1061 ±22 | fal `openai/gpt-image-2.6/sunburst/edit` | $0.18 |
53
+ | 9 | Nano Banana Pro | 1054 ±22 | fal `fal-ai/nano-banana-pro/edit` | $0.148 |
54
+ | 10 | Nano Banana 2.1 (High Thinking) | 984 ±22 | fal `google/nano-banana-2.1/edit` | $0.043 |
55
+ | 11 | Nano Banana 2 (High Thinking) | 955 ±22 | fal `fal-ai/nano-banana-2/edit` | $0.071 |
56
+ | 12 | Qwen-Image-Edit-2511 | 954 ±22 | fal `fal-ai/qwen-image-edit-2511` | $0.03 |
57
+ | 13 | GPT Image 2.5 Sunburst (Max Quality) | 944 ±22 | fal `openai/gpt-image-2.5/sunburst/edit` | $0.18 |
58
+ | 14 | Grok Imagine Image 2.0 (Medium Quality) | 888 ±22 | fal `xai/grok-imagine-image/v2.0/edit` | $0.04 |
59
+ | 15 | Wan 2.7 Pro | 716 ±23 | fal `fal-ai/wan/v2.7/pro/edit` | $0.075 |
60
+ | 16 | GPT Image 2.6 Flare (Max Quality, High Reasoning) | 613 ±24 | fal `openai/gpt-image-2.6/flare/edit` | $0.18 |
61
+ | 17 | GPT Image 2.5 Flare (Max Quality) | 594 ±24 | fal `openai/gpt-image-2.5/flare/edit` | $0.18 |
62
+ | 18 | Kling Image O1 | 399 ±27 | fal `fal-ai/kling-image/o1` | $0.028 |
63
+ | 19 | Seedream 5.0 Lite | −203 ±44 | fal `bytedance/seedream/v5/lite/edit` | $0.035 |
64
+
65
+ ## Files
66
+
67
+ | Path | What |
68
+ |---|---|
69
+ | `data/` | one row per matchup: the two models (`model1`, `model2`), their face crops after the fifth edit (`image1`, `image2`), the reference face crop (`reference_face`), the whole reference image (`reference_image`), the five instructions (`step_1` … `step_5`), and the votes, weighted and individual |
70
+ | `metadata/photos.jsonl` | per photograph: the five instructions with their kind and the item each edits, people visible, tags, face box, how the reference image was made, source page, creator and licence |
71
+ | `metadata/models.json` | per model: endpoint, every setting sent and why, list price and its basis |
72
+ | `metadata/standings.json` | the standings with confidence intervals |
73
+ | `metadata/attribution.csv`, `ATTRIBUTION.md` | photo credits |
74
+ | `pipeline/` | the step-check prompt, fal's endpoint definitions and the labs' API docs |
75
+
76
+ ## Credits and licence
77
+
78
+ The photographs come from Wikimedia Commons (179) and from StockSnap and Rawpixel through Openverse (20): 106 CC BY-SA
79
+ 4.0, 57 CC BY-SA 3.0, 1 CC BY-SA 2.0 fr, 8 CC BY 4.0, 27 CC0. The creator, licence and source of each are in
80
+ `ATTRIBUTION.md` and `metadata/attribution.csv`. The edited images are adaptations of these photographs; this dataset is
81
+ released under CC BY-SA 4.0, and the photographs keep their own licences.
metadata/attribution.csv ADDED
@@ -0,0 +1,200 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ photo_id,title,source,source_page,creator_as_listed,credit_line,licence,licence_url,attribution_required,share_alike,edited_images_licence,notes
2
+ wc15467676,FarmWorker.JPG,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:FarmWorker.JPG,Arne Hückelheim,Arne Hückelheim,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
3
+ wc61267439,BandoneonistaMDP-jul2017.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:BandoneonistaMDP-jul2017.jpg,Ezarate,Ezarate,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
4
+ f25a67e0-e2c3-4918-a19b-fe9e1a65bd8f,Couple Park,Stocksnap via Openverse,https://stocksnap.io/photo/couple-park-GL9XJQTLJK,Senior Living,Senior Living,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
5
+ wc31140258,Antti Kiiski - Rakuunarock 2013.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Antti_Kiiski_-_Rakuunarock_2013.jpg,Tuomas Vitikainen,Tuomas Vitikainen,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
6
+ wc177092456,Max Giesinger - 2021-09-12 - Mannheim - Sven Mandel - 1D X MK II - 0229 - B70I3683 (re-developed).jpg,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,Original: Sven Mandel Derivative work: Radomianin,"Sven Mandel (original), Radomianin (derivative work)",CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
7
+ wc61616231,Villagers from Madhya Pradesh Couple 1.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Villagers_from_Madhya_Pradesh_Couple_1.jpg,Suyash Dwivedi,Suyash Dwivedi,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
8
+ wc98796115,Francesco Maselli.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Francesco_Maselli.jpg,Giacomo Alessandroni,Giacomo Alessandroni,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
9
+ ef82c049-117e-4e35-a432-b4d6796efb0e,"Crittenden Rawlins, Critt Rawlins's tiny",Rawpixel via Openverse,https://www.rawpixel.com/image/8068533/photo-image-person-shirt-clothing,Carol M Highsmith,Carol M Highsmith,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
10
+ wc155185732,Mississippi Supreme Court Justice Jim Kitchens.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Mississippi_Supreme_Court_Justice_Jim_Kitchens.jpg,Timothy Holdiness,Timothy Holdiness,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
11
+ ba7f0e82-efc6-4fe8-a12b-804c45c1c361,Woman Reading,Stocksnap via Openverse,https://stocksnap.io/photo/woman-reading-VJM1ZWXLPY,Burst,Burst,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
12
+ wc170348170,"Dirk Zedler, Cycling World Europe 2025, Meerbusch (File1033-2-RR).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Dirk_Zedler,_Cycling_World_Europe_2025,_Meerbusch_(File1033-2-RR).jpg",Matti Blume,Matti Blume,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0/deed.en,True,True,CC BY-SA 4.0,
13
+ wc22487838,Geneetik Riin Tamm.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Geneetik_Riin_Tamm.jpg,Lauri Kulpsoo,Lauri Kulpsoo,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
14
+ wc197117660,Suha Al-Masri.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Suha_Al-Masri.jpg,Fuad Al-Qrize,Fuad Al-Qrize,CC BY 4.0,https://creativecommons.org/licenses/by/4.0,True,False,"any licence, with credit to the original author",
15
+ wc49640230,Alon Ben David.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Alon_Ben_David.jpg,Channel10israel,Channel10israel,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
16
+ wc127813216,Bakhtiyor Rakhman.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Bakhtiyor_Rakhman.jpg,Umarxon III,Umarxon III,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
17
+ wc113391732,2021-12-12 Eberspächer Luge World Cup Altenberg 1DX 4660 by Stepro.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:2021-12-12_Ebersp%C3%A4cher_Luge_World_Cup_Altenberg_1DX_4660_by_Stepro.jpg,Steffen Prößdorf,Steffen Prößdorf,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
18
+ wc128978025,2023 National Day of Brunei 52.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:2023_National_Day_of_Brunei_52.jpg,Pangalau,Pangalau,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
19
+ wc164397906,"Captain Joe, Friedrichshafen (P1046580).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Captain_Joe,_Friedrichshafen_(P1046580).jpg",Matti Blume,Matti Blume,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0/deed.en,True,True,CC BY-SA 4.0,
20
+ wc51544098,WDR-Dreharbeiten zu Tatort Köln „Wacht am Rhein“-8801.jpg,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,Raimond Spekking,© Raimond Spekking / CC BY-SA 4.0 (via Wikimedia Commons),CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
21
+ wc186877996,"Bhil community women in traditional attire, Jhabua, Madhya Pradesh, India (7).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Bhil_community_women_in_traditional_attire,_Jhabua,_Madhya_Pradesh,_India_(7).jpg",Suyash Dwivedi,Suyash Dwivedi,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
22
+ wc68327807,"Darshan Singh, Village Akbarpur Afghana.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Darshan_Singh,_Village_Akbarpur_Afghana.jpg",Satdeep Gill,Satdeep Gill,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
23
+ wc45337546,Ak55-Busy afternoon.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Ak55-Busy_afternoon.jpg,Zuraj studio,Zuraj studio,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
24
+ wc54050746,ART DANS LA RUE ALGER 2.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:ART_DANS_LA_RUE_ALGER_2.jpg,BRAHIM DJELLOUL Mustapha,BRAHIM DJELLOUL Mustapha,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
25
+ wc36840374,"Marble statue makers, near Jaipur, Rajasthan, India.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Marble_statue_makers,_near_Jaipur,_Rajasthan,_India.jpg",Yann Forget,© Yann Forget / Wikimedia Commons,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
26
+ wc78443524,Rich Kameda BBG New York April 2019.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Rich_Kameda_BBG_New_York_April_2019.jpg,King of Hearts,King of Hearts,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
27
+ wc84023793,"March of Ukraine's Defenders on Independence Day in Kyiv, 2019 373.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:March_of_Ukraine%27s_Defenders_on_Independence_Day_in_Kyiv,_2019_373.jpg",Ввласенко,Ввласенко,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
28
+ wc42363791,Semporna Sabah Regatta-Lepa-2015-08.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Regatta-Lepa-2015-08.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
29
+ wc35989646,20140808 - Ligue 2 - Créteil-Châteauroux 100.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:20140808_-_Ligue_2_-_Cr%C3%A9teil-Ch%C3%A2teauroux_100.jpg,Pierre-Yves Beaudouin,Pierre-Yves Beaudouin / Wikimedia Commons,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
30
+ wc36757782,Batangon-Darat Sabah Rungus-Woman-01.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Batangon-Darat_Sabah_Rungus-Woman-01.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
31
+ wc110020707,Michelin at IAA 2021 1X7A0159.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Michelin_at_IAA_2021_1X7A0159.jpg,Alexander Migl,Alexander Migl,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
32
+ wc51316724,"Costurera, Mahdia, Túnez, 2016-09-03, DD 04.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Costurera,_Mahdia,_T%C3%BAnez,_2016-09-03,_DD_04.jpg",Diego Delso,Diego Delso,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
33
+ wc7231228,Woman doing laundry.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Woman_doing_laundry.jpg,Bernard Gagnon,Bernard Gagnon,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
34
+ wc163677793,"2025-04-08 Fussball, UEFA Women's Nations League, Deutschland - Schottland STP 2074.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:2025-04-08_Fussball,_UEFA_Women%27s_Nations_League,_Deutschland_-_Schottland_STP_2074.jpg",Steffen Prößdorf,Steffen Prößdorf,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
35
+ wc22907497,Vendedor de agua de coco II.JPG,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Vendedor_de_agua_de_coco_II.JPG,Rjcastillo,Rjcastillo,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
36
+ wc12185576,Quito Accordion player.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Quito_Accordion_player.jpg,Cayambe,Cayambe,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
37
+ wc132567368,"Vendor at Mahankaal Temple, Kathmandu-6316.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Vendor_at_Mahankaal_Temple,_Kathmandu-6316.jpg",Bijay Chaurasia,Bijay Chaurasia,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
38
+ wc46729005,Taipei Taiwan Jiaozi-Restaurant-14th-avenue-01.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-01.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
39
+ wc36823435,"Old man smoking hookah, near Jaipur, Rajasthan, India.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Old_man_smoking_hookah,_near_Jaipur,_Rajasthan,_India.jpg",Yann Forget,© Yann Forget / Wikimedia Commons,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
40
+ wc39796818,Semporna Sabah Official-Opening-of-Tun-Sakaran-Museum-10.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Official-Opening-of-Tun-Sakaran-Museum-10.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
41
+ wc48134404,Cobbler in Udaipur.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Cobbler_in_Udaipur.jpg,Clément Bardot,Clément Bardot,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
42
+ wc25393535,Coconut water vendor.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Coconut_water_vendor.jpg,Wilfredor,Wilfredor,CC0,http://creativecommons.org/publicdomain/zero/1.0/deed.en,False,False,"any licence, no credit needed",
43
+ wc187580499,Chechia Maker in his shop.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Chechia_Maker_in_his_shop.jpg,IssamBarhoumi,IssamBarhoumi,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
44
+ wc16841673,11-10-02-barnim-by-RalfR-02.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:11-10-02-barnim-by-RalfR-02.jpg,Ralf Roletschek (talk) - Fahrradtechnik auf fahrradmonteur.de,Ralf Roletschek,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
45
+ wc9590173,Potter and his wife.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Potter_and_his_wife.jpg,Yann (talk),© Yann Forget / Wikimedia Commons,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
46
+ wc68508073,Woman with hand-rolled cigarette cutting rice.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Woman_with_hand-rolled_cigarette_cutting_rice.jpg,Basile Morin,Basile Morin,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
47
+ wc30113648,"Vendedor callejero de gallinas, Ciudad Ho Chi Minh, Vietnam, 2013-08-14, DD 01.JPG",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Vendedor_callejero_de_gallinas,_Ciudad_Ho_Chi_Minh,_Vietnam,_2013-08-14,_DD_01.JPG",Diego Delso,Diego Delso,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
48
+ wc64396409,Beignet maker.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Beignet_maker.jpg,IssamBarhoumi,IssamBarhoumi,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
49
+ wc181130944,Knitted Dress as additional warm layer over street clothing - ginger woman sitting on a park bench outside of Praha hlavní nádraží.jpg,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,Tobias ToMar Maier,Tobias ToMar Maier,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
50
+ wc74708391,Copihue de Oro 2018 - Fernanda Figueroa - 02.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Copihue_de_Oro_2018_-_Fernanda_Figueroa_-_02.jpg,Carlos Figueroa Rojas,Carlos Figueroa Rojas,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
51
+ wc164348921,"Ташкент, вики-краевед на скамейке у Шевченко 1 (2).jpg",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",Nikolai Bulykin,Nikolai Bulykin,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
52
+ wc36722719,November 11th ceremony in Toulouse in 2014 - 3826.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:November_11th_ceremony_in_Toulouse_in_2014_-_3826.jpg,Pierre-Selim Huard,Pierre-Selim Huard,CC BY 4.0,https://creativecommons.org/licenses/by/4.0,True,False,"any licence, with credit to the original author",
53
+ wc132970669,2022-08-18 European Championships 2022 – Men's 200 Metres by Sandro Halank–060.jpg,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,"Sandro Halank, Wikimedia Commons","Sandro Halank, Wikimedia Commons, CC BY-SA 4.0",CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
54
+ wc87185001,Contouring the cheekbone with makeup in proper and wrong pose.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Contouring_the_cheekbone_with_makeup_in_proper_and_wrong_pose.jpg,Tobias ToMar Maier,Tobias ToMar Maier,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
55
+ wc74785277,2018-11-24 Women's World Cup at 2018-19 Luge World Cup in Igls by Sandro Halank–372.jpg,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,"Sandro Halank, Wikimedia Commons","Sandro Halank, Wikimedia Commons, CC BY-SA 4.0",CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
56
+ wc37036117,Cheek - Rakuuna Rock 2014 1.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Cheek_-_Rakuuna_Rock_2014_1.jpg,Tuomas Vitikainen,Tuomas Vitikainen,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
57
+ wc6900196,Sari 2.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Sari_2.jpg,Yann (talk),© Yann Forget / Wikimedia Commons,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
58
+ wc54338875,The BossHoss - Oberhausen - Leonhard Kreissig - 06.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:The_BossHoss_-_Oberhausen_-_Leonhard_Kreissig_-_06.jpg,Leonhard Kreissig,Leonhard Kreissig,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
59
+ wc81720138,Tambourin.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Tambourin.jpg,Bertrand Fanonnel | Eight Studio,Bertrand Fanonnel | Eight Studio,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
60
+ wc1651809,4.FMC - Dullahan - Marek Przewłocki - 01a.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:4.FMC_-_Dullahan_-_Marek_Przew%C5%82ocki_-_01a.jpg,Lestat (Jan Mehlich),Lestat (Jan Mehlich),CC BY-SA 3.0,http://creativecommons.org/licenses/by-sa/3.0/,True,True,CC BY-SA 3.0,
61
+ wc145843601,Khasi Lady in a Kitchen.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Khasi_Lady_in_a_Kitchen.jpg,Wann Majaw,Wann Majaw,CC0,http://creativecommons.org/publicdomain/zero/1.0/deed.en,False,False,"any licence, no credit needed",
62
+ wc30778085,Dover - Dover came to me 2014 - 01.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Dover_-_Dover_came_to_me_2014_-_01.jpg,Carlos Delgado,Carlos Delgado,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
63
+ wc79628058,P2N2019ClaraLuciani 03.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:P2N2019ClaraLuciani_03.jpg,Selbymay,Selbymay,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
64
+ wc62403000,"Kia, IAA 2017 (1Y7A2595).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Kia,_IAA_2017_(1Y7A2595).jpg",MB-one,MB-one,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
65
+ wc197388139,2026 Domingo 26 de xullo. Desfile de traxes tradicionais. Santiago de Compostela 05.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:2026_Domingo_26_de_xullo._Desfile_de_traxes_tradicionais._Santiago_de_Compostela_05.jpg,Luis Miguel Bugallo Sánchez,Luis Miguel Bugallo Sánchez,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
66
+ wc71781613,David Stellner (Kunst am Kanal - 12 Jahre Werk in Wien) 11.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:David_Stellner_(Kunst_am_Kanal_-_12_Jahre_Werk_in_Wien)_11.jpg,Manfred Werner (Tsui),Manfred Werner (Tsui),CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
67
+ wc130741178,"2023-04-11 Fussball, Frauen, Länderspiel, Deutschland - Brasilien 1DX 0181 by Stepro.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:2023-04-11_Fussball,_Frauen,_L%C3%A4nderspiel,_Deutschland_-_Brasilien_1DX_0181_by_Stepro.jpg",Steffen Prößdorf,Steffen Prößdorf,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
68
+ wc57090152,2017-02-24 Emily Sweeney by Sandro Halank–1.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:2017-02-24_Emily_Sweeney_by_Sandro_Halank%E2%80%931.jpg,"Sandro Halank, Wikimedia Commons","Sandro Halank, Wikimedia Commons, CC-BY-SA 3.0",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
69
+ 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,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,Tobias ToMar Maier,Tobias ToMar Maier,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
70
+ wc61382438,DCVDNS 1 – splash! Festival 20 (2017).jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:DCVDNS_1_%E2%80%93_splash!_Festival_20_(2017).jpg,Nicolas Völcker,Nicolas Völcker,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
71
+ wc77297064,Sanni - Ilosaarirock 2018 - 02.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Sanni_-_Ilosaarirock_2018_-_02.jpg,Tuomas Vitikainen,Tuomas Vitikainen,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
72
+ wc44437091,Lady on Neva river Saint Petersburg.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Lady_on_Neva_river_Saint_Petersburg.jpg,"This Photo was taken by Wolfgang Moroder. Feel free to use my photos, but please mention me as the author and send me a message. This image is not in the public domain. Please respect the copyright protection. It may only be used according to the rules mentioned here. This specifically excludes use in social media, if applicable terms of the licenses listed here are not appropriate. Please do not upload an updated image here without consultation with the Author. The author would like to make corrections only at his own source. This ensures that the changes are preserved.Please if you think that any changes should be required, please inform the author.Otherwise you can upload a new image with a new name. Please use one of the templates derivative or extract.",Wolfgang Moroder,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,"author asks (courtesy, not a licence term) to be messaged when the photo is reused"
73
+ wc71365077,"IAA 2017, Frankfurt (1Y7A1813).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:IAA_2017,_Frankfurt_(1Y7A1813).jpg",Matti Blume,Matti Blume,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
74
+ wc144533378,Sundance Film Festival 2024 - Cynthia Okorafor-104A3488.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Cynthia_Okorafor-104A3488.jpg,Frank Schulenburg,Frank Schulenburg,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
75
+ wc198272116,2026 Músico do grupo de Felisa Segade no TradFest 2026. A Quintana. Santiago de Compostela. Galiza.jpg,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,Luis Miguel Bugallo Sánchez,Luis Miguel Bugallo Sánchez,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
76
+ wc165131491,"Ташкент, кыргызский викимедиец на Буюк Турон (2).jpg",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",Nikolai Bulykin,Nikolai Bulykin,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
77
+ wc70180444,Mermaid Parade (60015).jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Mermaid_Parade_(60015).jpg,Rhododendrites,Rhododendrites,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
78
+ wc75115465,"Geneva International Motor Show 2018, Le Grand-Saconnex (1X7A0394).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Geneva_International_Motor_Show_2018,_Le_Grand-Saconnex_(1X7A0394).jpg",Matti Blume,Matti Blume,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
79
+ wc144784911,Sundance Film Festival 2024 - Jamal Trulove-104A3197.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Jamal_Trulove-104A3197.jpg,Frank Schulenburg,Frank Schulenburg,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
80
+ wc87185004,Slightly business casual Informal wear - pose 1.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Slightly_business_casual_Informal_wear_-_pose_1.jpg,Tobias ToMar Maier,Tobias ToMar Maier,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
81
+ wc145940545,"Søren W. Rasmussen, COTY, GIMS 2024, Le Grand-Saconnex (GIMS0032).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:S%C3%B8ren_W._Rasmussen,_COTY,_GIMS_2024,_Le_Grand-Saconnex_(GIMS0032).jpg",Matti Blume,Matti Blume,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0/deed.en,True,True,CC BY-SA 4.0,
82
+ wc144339350,Sundance Film Festival 2024 - Seeking Mavis Beacon - Guetty Felin-104A2142.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Seeking_Mavis_Beacon_-_Guetty_Felin-104A2142.jpg,Frank Schulenburg,Frank Schulenburg,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
83
+ wc186877998,"Bhil community women in traditional attire, Jhabua, Madhya Pradesh, India (8).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Bhil_community_women_in_traditional_attire,_Jhabua,_Madhya_Pradesh,_India_(8).jpg",Suyash Dwivedi,Suyash Dwivedi,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
84
+ wc43469543,Groupe Tribal Percussions - 248.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Groupe_Tribal_Percussions_-_248.jpg,"Another one of my pictures: This photograph was taken by Medium69 (William Crochot) and released under the license stated below. You are free to use it for any purpose as long as you credit the author (William Crochot), the Source (Wikimedia Commons) and the license (CC-BY-SA 4.0) in close relation to the image. Please do not upload an updated image here without consultation with the Author. The author would like to make corrections only at his own source RAW. This ensures that the changes are preserved.Please if you think that any changes should be required, please inform the author.Otherwise you can upload a new image with a new name. Please use one of the templates derivative or extract.",© William Crochot / Wikimedia Commons,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
85
+ wc132970461,2022-08-18 European Championships 2022 – Men's 200 Metres by Sandro Halank–045.jpg,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,"Sandro Halank, Wikimedia Commons","Sandro Halank, Wikimedia Commons, CC BY-SA 4.0",CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
86
+ wc164861272,Khasi Woman Dress Mawphanlur Oct24 A7CR 04247.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Khasi_Woman_Dress_Mawphanlur_Oct24_A7CR_04247.jpg,Timothy A. Gonsalves,Timothy A. Gonsalves,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
87
+ wc198351927,2026 Saxofonista do grupo de Felisa Segade. TradFest. Galiza.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:2026_Saxofonista_do_grupo_de_Felisa_Segade._TradFest._Galiza.jpg,Luis Miguel Bugallo Sánchez,Luis Miguel Bugallo Sánchez,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
88
+ wc18749683,Cody ChesnuTT - Ilosaarirock 2011.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Cody_ChesnuTT_-_Ilosaarirock_2011.jpg,Tuomas Vitikainen,Tuomas Vitikainen,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
89
+ wc163677788,"2025-04-08 Fussball, UEFA Women's Nations League, Deutschland - Schottland STP 2073.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:2025-04-08_Fussball,_UEFA_Women%27s_Nations_League,_Deutschland_-_Schottland_STP_2073.jpg",Steffen Prößdorf,Steffen Prößdorf,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
90
+ wc18529819,John Petrucci - 02.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:John_Petrucci_-_02.jpg,Carlos Delgado,Carlos Delgado,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
91
+ wc87185002,Slightly business casual Informal wear - pose 2 with fishnet tights.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Slightly_business_casual_Informal_wear_-_pose_2_with_fishnet_tights.jpg,Tobias ToMar Maier,Tobias ToMar Maier,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
92
+ wc50966261,20160807 spice merchant Nyaung Shwe Myanmar 8917.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:20160807_spice_merchant_Nyaung_Shwe_Myanmar_8917.jpg,Jakub Hałun,Jakub Hałun,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
93
+ wc143058460,Eva Nogales in 2023 06.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Eva_Nogales_in_2023_06.jpg,Cmichel67,Cmichel67,CC BY 4.0,https://creativecommons.org/licenses/by/4.0,True,False,"any licence, with credit to the original author",
94
+ wc15722258,Moriarty-IMG 6846.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Moriarty-IMG_6846.jpg,Rama,"Photograph by Rama, Wikimedia Commons, Cc-by-sa-2.0-fr",CC BY-SA 2.0 fr,https://creativecommons.org/licenses/by-sa/2.0/fr/deed.en,True,True,CC BY-SA 2.0 fr,
95
+ wc27115652,13-06-07 RiP The BossHoss Boss Burns 6.JPG,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:13-06-07_RiP_The_BossHoss_Boss_Burns_6.JPG,Antje Naumann (AllSystemsRed),Antje Naumann (AllSystemsRed),CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
96
+ wc15099922,Agnes Milowka by J Axford.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Agnes_Milowka_by_J_Axford.jpg,"James Axford, Melbourne",James Axford,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
97
+ ba231d2e-b834-4898-b6a0-2f154e708c09,Hospital Waiting,Stocksnap via Openverse,https://stocksnap.io/photo/hospital-waiting-SSDEQHS17S,Direct Media,Direct Media,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
98
+ wc12797457,7th Marquis of Colmondeley 2.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:7th_Marquis_of_Colmondeley_2.jpg,Allan Warren,Allan Warren,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
99
+ wc87258958,Wolford fatal dress as a mini dress to cover the see trough part of a too thin jeggings.jpg,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,Tobias ToMar Maier,Tobias ToMar Maier,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
100
+ wc25152397,Sad tomato seller.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Sad_tomato_seller.jpg,Wilfredor,Wilfredor,CC0,http://creativecommons.org/publicdomain/zero/1.0/deed.en,False,False,"any licence, no credit needed",
101
+ dc5c1ac5-784d-469a-a37f-e313079908ee,Stairs Stairway,Stocksnap via Openverse,https://stocksnap.io/photo/stairs-stairway-D4XWI5PN82,Brooke Cagle,Brooke Cagle,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
102
+ wc55676665,Tunisian Musicians 04.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Tunisian_Musicians_04.jpg,Hamed Gamaoun,Hamed Gamaoun,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
103
+ 63a89c1d-dc76-41e5-95e9-5157825cd504,People Man,Stocksnap via Openverse,https://stocksnap.io/photo/people-man-RWMC95HRC0,Glen McCallum,Glen McCallum,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
104
+ wc45035857,GedFunerailles0.JPG,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:GedFunerailles0.JPG,Mbiele Happi,Mbiele Happi,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
105
+ wc86971536,Simple sweater dress with with turtleneck - pose 1.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Simple_sweater_dress_with_with_turtleneck_-_pose_1.jpg,Tobias ToMar Maier,Tobias ToMar Maier,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
106
+ b036af66-8c49-403b-9f0b-38ff46a89f73,Man Entering,Stocksnap via Openverse,https://stocksnap.io/photo/man-entering-7GXMY2JMR4,Bruce Mars,Bruce Mars,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
107
+ wc11127070,Nottingham Pride MMB 67 Kenelis.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Nottingham_Pride_MMB_67_Kenelis.jpg,mattbuck (category),mattbuck,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
108
+ c70bc7ee-1701-4a79-94cd-f5325b6d5e30,Male Nurse,Stocksnap via Openverse,https://stocksnap.io/photo/male-nurse-8OYPFEL4K8,Direct Media,Direct Media,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
109
+ 04e3d2a8-27ca-431c-92e1-402527e6b824,Wheelchair Person,Stocksnap via Openverse,https://stocksnap.io/photo/wheelchair-person-OQZYXPNK5H,Direct Media,Direct Media,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
110
+ 6e58849a-cb37-4b82-930f-5546480e7417,Doctor Patient,Stocksnap via Openverse,https://stocksnap.io/photo/doctor-patient-RZCTEGBC2V,Direct Media,Direct Media,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
111
+ 3b81d7c7-3cf6-4be8-8f01-75c9919c9bb8,Male Nurse,Stocksnap via Openverse,https://stocksnap.io/photo/male-nurse-U1PTBWATO7,Direct Media,Direct Media,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
112
+ wc47590527,Cañari woman 02.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Ca%C3%B1ari_woman_02.jpg,Bernard Gagnon,Bernard Gagnon,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
113
+ wc26567769,University Park MMB «N6 Students' Union Elections 2013.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:University_Park_MMB_%C2%ABN6_Students%27_Union_Elections_2013.jpg,mattbuck (category),mattbuck,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
114
+ wc40941239,Guy Sebastian ESC2015 Eurovision Village Vienna 08crop.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Guy_Sebastian_ESC2015_Eurovision_Village_Vienna_08crop.jpg,Manfred Werner - Tsui,Manfred Werner - Tsui,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
115
+ wc145784234,Sundance Film Festival 2024 - Kevin Carmant-104A3458.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Sundance_Film_Festival_2024_-_Kevin_Carmant-104A3458.jpg,Frank Schulenburg,Frank Schulenburg,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
116
+ wc154107516,"Buchmesse 2024, Frankfurt am Main (P1200850-2).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Buchmesse_2024,_Frankfurt_am_Main_(P1200850-2).jpg",Matti Blume,Matti Blume,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0/deed.en,True,True,CC BY-SA 4.0,
117
+ wc107302058,"Young men smiling with teeth, studio portrait.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Young_men_smiling_with_teeth,_studio_portrait.jpg",Dmitry Makeev,Dmitry Makeev,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
118
+ wc36507851,Austrian Sportspeople of the Year 2014 winners 09 Mirna Jukic.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Austrian_Sportspeople_of_the_Year_2014_winners_09_Mirna_Jukic.jpg,Manfred Werner - Tsui,Manfred Werner - Tsui,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
119
+ wc77136330,"IntoPIX aux Journées de l'Industrie 2019, UCLouvain (DSCF7897).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:IntoPIX_aux_Journ%C3%A9es_de_l%27Industrie_2019,_UCLouvain_(DSCF7897).jpg",Trougnouf (Benoit Brummer),Trougnouf (Benoit Brummer),CC BY 4.0,https://creativecommons.org/licenses/by/4.0,True,False,"any licence, with credit to the original author",
120
+ wc9590080,"Potter and his work, Jaura, India.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Potter_and_his_work,_Jaura,_India.jpg",Yann (talk),© Yann Forget / Wikimedia Commons,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
121
+ wc146462387,At Princeton University 2024 058 - Bruce T. Draine.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:At_Princeton_University_2024_058_-_Bruce_T._Draine.jpg,Photograph by Mike Peel (www.mikepeel.net).,Mike Peel (www.mikepeel.net),CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
122
+ wc29828836,Dalian Liaoning China Ruan-Player-in-Dalian-Labour-Park-01.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Dalian_Liaoning_China_Ruan-Player-in-Dalian-Labour-Park-01.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
123
+ wc32720436,Xian China Yang-Jide-01.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Xian_China_Yang-Jide-01.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
124
+ wc52136996,"Panadería en Yazd, Irán, 2016-09-21, DD 44.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Panader%C3%ADa_en_Yazd,_Ir%C3%A1n,_2016-09-21,_DD_44.jpg",Diego Delso,Diego Delso,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
125
+ wc133986723,"Japanese garden at Schönbrunn Palace in Vienna, Austria - teahouse Heterotopia tea ceremony-water PNr°1026.jpg",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",D-Kuru,D-Kuru,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
126
+ wc26244423,"Upholstering the seats of your own car, Margarita Island, Venezuela.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Upholstering_the_seats_of_your_own_car,_Margarita_Island,_Venezuela.jpg",Wilfredor,Wilfredor,CC0,http://creativecommons.org/publicdomain/zero/1.0/deed.en,False,False,"any licence, no credit needed",
127
+ wc16957573,Tatort vier Ermittler 2.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Tatort_vier_Ermittler_2.jpg,Superbass,Superbass,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
128
+ wc186192168,AC SO Karlspreisübergabe 14.03.2026 Gesprächsrunde VI.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:AC_SO_Karlspreis%C3%BCbergabe_14.03.2026_Gespr%C3%A4chsrunde_VI.jpg,Grunpfnul,Grunpfnul,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
129
+ wc63914699,Adrian Horridge FRS on his 90th birthday.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Adrian_Horridge_FRS_on_his_90th_birthday.jpg,Thennicke,Thennicke,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
130
+ wc15739979,Giorgio Moroder.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Giorgio_Moroder.jpg,"This Photo was taken by Wolfgang Moroder. Feel free to use my photos, but please mention me as the author and send me a message. This image is not in the public domain. Please respect the copyright protection. It may only be used according to the rules mentioned here. This specifically excludes use in social media, if applicable terms of the licenses listed here are not appropriate. Please do not upload an updated image here without consultation with the Author. The author would like to make corrections only at his own source. This ensures that the changes are preserved.Please if you think that any changes should be required, please inform the author.Otherwise you can upload a new image with a new name. Please use one of the templates derivative or extract.",Wolfgang Moroder,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,"author asks (courtesy, not a licence term) to be messaged when the photo is reused"
131
+ wc49316526,Kadavar-Bandfoto.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Kadavar-Bandfoto.jpg,Henry W. Laurisch,Henry W. Laurisch,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
132
+ wc148617194,Woman hanging out with a donkey in Louvain-la-Neuve (DSC03050).jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Woman_hanging_out_with_a_donkey_in_Louvain-la-Neuve_(DSC03050).jpg,Trougnouf (Benoit Brummer),Trougnouf (Benoit Brummer),CC BY 4.0,https://creativecommons.org/licenses/by/4.0,True,False,"any licence, with credit to the original author",
133
+ wc25393546,Palms seller for Palm Sunday.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Palms_seller_for_Palm_Sunday.jpg,Wilfredor,Wilfredor,CC0,http://creativecommons.org/publicdomain/zero/1.0/deed.en,False,False,"any licence, no credit needed",
134
+ 32b862ba-7f9b-4cac-b802-20e3661dcfe5,ORAU summer program ORNL 2014,Rawpixel via Openverse,https://www.rawpixel.com/image/8736408/orau-summer-program-ornl-2014-oak-ridge,usdoe,usdoe,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
135
+ 4114f183-6307-4f8e-8e87-b68d8620009f,FD Student Chef Team,Rawpixel via Openverse,https://www.rawpixel.com/image/8739012/student-chef-team,U.S. Army,U.S. Army,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
136
+ 16657fe8-b95c-4888-93ba-ed5a8d56735a,Young man wood workshop,Rawpixel via Openverse,https://www.rawpixel.com/image/8708782/photo-image-public-domain-person-black,The African Union Mission in Somalia,The African Union Mission in Somalia,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
137
+ wc49858555,Tachileik Myanmar Kayan-People-Woman-03.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Tachileik_Myanmar_Kayan-People-Woman-03.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
138
+ wc165584587,"Бишкек, вики-фототренинг 2025 (31).jpg",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",Nikolai Bulykin,Nikolai Bulykin,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
139
+ wc36828929,"Carpet makers, near Jaipur, Rajasthan, India.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Carpet_makers,_near_Jaipur,_Rajasthan,_India.jpg",Yann Forget,© Yann Forget / Wikimedia Commons,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
140
+ wc10677986,Royal Wedding Stockholm 2010-Slottsbacken-05.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Royal_Wedding_Stockholm_2010-Slottsbacken-05.jpg,Prolineserver (talk),"Holger Motzkau 2010, Wikipedia/Wikimedia Commons (cc-by-sa-3.0)",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
141
+ 4951796a-8d80-4937-87a6-6c40afae9dae,NTRC 3D printing 2014 Knoxville,Rawpixel via Openverse,https://www.rawpixel.com/image/8736316/ntrc-printing-2014-knoxville,usdoe,usdoe,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
142
+ wc86477420,Miriam Beizana Vigo.002 - Escritora.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Miriam_Beizana_Vigo.002_-_Escritora.jpg,Fernando Losada Rodríguez,Fernando Losada Rodríguez,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
143
+ wc46729139,Taipei Taiwan Jiaozi-Restaurant-14th-avenue-03.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-03.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
144
+ wc133986767,"Japanese garden at Schönbrunn Palace in Vienna, Austria - teahouse Heterotopia tea ceremony-whisk PNr°1027.jpg",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",D-Kuru,D-Kuru,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
145
+ wc107976362,Alexander Serov (directeur sportif Gazprom) au matin de la première étape du Tour de l'Ain 2021.jpg,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,Benoît Prieur,Benoît Prieur,CC0,http://creativecommons.org/publicdomain/zero/1.0/deed.en,False,False,"any licence, no credit needed",
146
+ 255d4a22-4470-4638-9128-f10a6ebb503e,Happy Couple,Stocksnap via Openverse,https://stocksnap.io/photo/happy-couple-7HBHYQSHPL,Senior Living,Senior Living,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
147
+ wc113139332,2021-12-07 Unterzeichnung des Koalitionsvertrages der 20. Wahlperiode des Bundestages by Sandro Halank–016.jpg,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,"Sandro Halank, Wikimedia Commons","Sandro Halank, Wikimedia Commons, CC BY-SA 4.0",CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
148
+ wc64787263,Adrian Horridge FRS.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Adrian_Horridge_FRS.jpg,Thennicke,Thennicke,CC BY 4.0,https://creativecommons.org/licenses/by/4.0,True,False,"any licence, with credit to the original author",
149
+ wc34012281,Lijiang Yunnan China-Woman-with-weaving-loom-01.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Lijiang_Yunnan_China-Woman-with-weaving-loom-01.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
150
+ wc110020721,Michelin at IAA 2021 1X7A0161.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Michelin_at_IAA_2021_1X7A0161.jpg,Alexander Migl,Alexander Migl,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
151
+ wc34473676,Mnich buddyjski w klasztorze Erdene Dzuu.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Mnich_buddyjski_w_klasztorze_Erdene_Dzuu.jpg,Marcin Konsek,Photo: Marcin Konsek / Wikimedia Commons,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
152
+ wc53784969,"Nordest music in Avenida Paulista, São Paulo, Brazil.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Nordest_music_in_Avenida_Paulista,_S%C3%A3o_Paulo,_Brazil.jpg",Wilfredor,Wilfredor,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
153
+ wc4695242,NRWTag W Sonnborn 40 ies.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:NRWTag_W_Sonnborn_40_ies.jpg,Frank Vincentz,Frank Vincentz,CC BY-SA 3.0,http://creativecommons.org/licenses/by-sa/3.0/,True,True,CC BY-SA 3.0,
154
+ wc69984498,"OutDoor 2018, Friedrichshafen (1X7A9907).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:OutDoor_2018,_Friedrichshafen_(1X7A9907).jpg",Matti Blume,Matti Blume,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
155
+ wc37097845,Penampang Sabah Dignitaries-at- Kaamatan-Celebrations-2014-01.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Penampang_Sabah_Dignitaries-at-_Kaamatan-Celebrations-2014-01.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
156
+ wc40165063,Penampang Sabah Dignitaries-at- Kaamatan-Celebrations-2014-03.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Penampang_Sabah_Dignitaries-at-_Kaamatan-Celebrations-2014-03.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
157
+ wc42363328,Semporna Sabah Regatta-Lepa-2015-06.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Semporna_Sabah_Regatta-Lepa-2015-06.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
158
+ wc37669146,Shilin Yunnan China Shilin-Stone-Forest-09.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Shilin_Yunnan_China_Shilin-Stone-Forest-09.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
159
+ wc38863393,Yogyakarta Indonesia Gamelan-players-with-gendèr-01.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Yogyakarta_Indonesia_Gamelan-players-with-gend%C3%A8r-01.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
160
+ wc29965788,Jaisalmer-Citadel-06-Peacock fan merchant-20131010.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Jaisalmer-Citadel-06-Peacock_fan_merchant-20131010.jpg,Daniel VILLAFRUELA.,Daniel VILLAFRUELA,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
161
+ wc85705501,20191206 Uliczny grajek w Udajpurze 1215 6822 DxO.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:20191206_Uliczny_grajek_w_Udajpurze_1215_6822_DxO.jpg,Jakub Hałun,Jakub Hałun,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
162
+ wc91421474,Jon Batiste in Brooklyn Juneteenth 2020 (94060).jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Jon_Batiste_in_Brooklyn_Juneteenth_2020_(94060).jpg,Rhododendrites,Rhododendrites,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
163
+ wc164201681,Farmer at harvest.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Farmer_at_harvest.jpg,Photobyamin,Photobyamin,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
164
+ wc77740619,"Woman harvesting tea, West Bengal.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Woman_harvesting_tea,_West_Bengal.jpg",Bernard Gagnon,Bernard Gagnon,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
165
+ wc87211151,The water transfer.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:The_water_transfer.jpg,Mikhail Kapychka,Mikhail Kapychka,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
166
+ wc36791367,PersonaMardel.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:PersonaMardel.jpg,Ezarate,Ezarate,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
167
+ wc45077428,Dönüş Tuncel (Donus Tuncel) - In the Lab.JPG,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:D%C3%B6n%C3%BC%C5%9F_Tuncel_(Donus_Tuncel)_-_In_the_Lab.JPG,Yigit Altay,Yigit Altay,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
168
+ wc34178099,EmanuelHarrold.JPG,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:EmanuelHarrold.JPG,Eric Magnan,Eric Magnan,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
169
+ wc171925289,Paul Cook - Sex Pistols 2025-2.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Paul_Cook_-_Sex_Pistols_2025-2.jpg,Birgit Fostervold,Birgit Fostervold,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
170
+ wc50359073,20160607 Berlin Volbeat Volbeat 0393.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:20160607_Berlin_Volbeat_Volbeat_0393.jpg,© Markus Felix | PushingPixels (contact me),© Markus Felix | PushingPixels,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
171
+ wc15690652,Valdi Totev.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Valdi_Totev.jpg,MrPanyGoff,Plamen Agov • studiolemontree,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
172
+ wc87403339,Yuyuan Garden 3.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Yuyuan_Garden_3.jpg,kallerna,kallerna,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
173
+ wc118282429,"Ribfest in Toronto (Dundas Square, May 21, 2022) (2).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Ribfest_in_Toronto_(Dundas_Square,_May_21,_2022)_(2).jpg",Maksim Sokolov (maxergon.com),Maksim Sokolov (maxergon.com),CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
174
+ wc149960906,Les Cuirs d'Agathe (DSC04126).jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Les_Cuirs_d%27Agathe_(DSC04126).jpg,Trougnouf (Benoit Brummer),Trougnouf (Benoit Brummer),CC BY 4.0,https://creativecommons.org/licenses/by/4.0,True,False,"any licence, with credit to the original author",
175
+ wc89022757,حافلة نقل حضري.jpg,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,Sofiane mohammed amri,Sofiane mohammed amri,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
176
+ wc135875647,"Sumitra Devi, a Garhwali shepherd near Lansdowne, Uttarakhand 01.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Sumitra_Devi,_a_Garhwali_shepherd_near_Lansdowne,_Uttarakhand_01.jpg",Satdeep Gill,Satdeep Gill,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
177
+ wc122361298,"Hookah shop owners in Ramallah, Palestine (DSC03509).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Hookah_shop_owners_in_Ramallah,_Palestine_(DSC03509).jpg",Trougnouf (Benoit Brummer),Trougnouf (Benoit Brummer),CC BY 4.0,https://creativecommons.org/licenses/by/4.0,True,False,"any licence, with credit to the original author",
178
+ wc41090507,Jakarta Indonesia Hawkers-in- Glodok-05.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Jakarta_Indonesia_Hawkers-in-_Glodok-05.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
179
+ wc62210997,20160807 spice merchant Nyaung Shwe Myanmar 8916 DxO.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:20160807_spice_merchant_Nyaung_Shwe_Myanmar_8916_DxO.jpg,Jakub Hałun,Jakub Hałun,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
180
+ 40f1c4c5-b84c-42a0-a81d-ae528001bd7c,Diverse Workplace,Stocksnap via Openverse,https://stocksnap.io/photo/diverse-workplace-UJ1P4WLT4N,Direct Media,Direct Media,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
181
+ wc46729207,Taipei Taiwan Jiaozi-Restaurant-14th-avenue-04.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Taipei_Taiwan_Jiaozi-Restaurant-14th-avenue-04.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
182
+ wc24879813,Pristina Bazaar February 2013 02.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Pristina_Bazaar_February_2013_02.jpg,Arild Vågen,Arild Vågen,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
183
+ wc83827597,Graveur de la place du Peuple.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Graveur_de_la_place_du_Peuple.jpg,Touam (Hervé Agnoux),Touam (Hervé Agnoux),CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
184
+ wc33355555,BSBCC Sabah Wong-Siew-Te-02.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:BSBCC_Sabah_Wong-Siew-Te-02.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
185
+ wc24642095,Cepillao ice cream vendor.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Cepillao_ice_cream_vendor.jpg,Wilfredor,Wilfredor,CC0,http://creativecommons.org/publicdomain/zero/1.0/deed.en,False,False,"any licence, no credit needed",
186
+ wc81006780,Glaces Jeff de Bruges à Saint-Étienne.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Glaces_Jeff_de_Bruges_%C3%A0_Saint-%C3%89tienne.jpg,Touam (Herve Agnoux),Touam (Herve Agnoux),CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
187
+ wc28942287,13-06 Budapest Dancing Show.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:13-06_Budapest_Dancing_Show.jpg,Achim Raschka (talk),Achim Raschka,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
188
+ wc54735536,Nubian Flute player عازف الناي.jpg,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,Ahmed Emad H,Ahmed Emad H,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
189
+ wc39110702,Ubud Bali Girl-with-selfie-stick-01.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Ubud_Bali_Girl-with-selfie-stick-01.jpg,"CEphoto, Uwe Aranas","CEphoto, Uwe Aranas",CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
190
+ 10494e50-fd2e-47f6-9295-0248b1eeed09,Happy Couple,Stocksnap via Openverse,https://stocksnap.io/photo/happy-couple-VXFRCXXFG6,Senior Living,Senior Living,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
191
+ wc118282450,"Ribfest in Toronto (Dundas Square, May 21, 2022).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Ribfest_in_Toronto_(Dundas_Square,_May_21,_2022).jpg",Maksim Sokolov (maxergon.com),Maksim Sokolov (maxergon.com),CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
192
+ wc21375193,"Paris - Crepe seller, Rue Mouffetard - 2008.jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Paris_-_Crepe_seller,_Rue_Mouffetard_-_2008.jpg",Jorge Royan,© Jorge Royan / http://www.royan.com.ar,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
193
+ wc42782992,"Puesto de comida, calle Jirón Ancash, Lima, Perú, 2015-07-28, DD 80.JPG",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",Diego Delso,Diego Delso,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
194
+ wc37667675,Yair Aharoni.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Yair_Aharoni.jpg,Arielinson,Arielinson,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
195
+ wc45734944,"Entrega de Premios Wiki Loves, Sevilla, España, 2015-12-05, DD 03.JPG",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:Entrega_de_Premios_Wiki_Loves,_Sevilla,_Espa%C3%B1a,_2015-12-05,_DD_03.JPG",Diego Delso,Diego Delso,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
196
+ 4cc5938a-c9bd-4377-a4c6-d57192056040,Man Desk,Stocksnap via Openverse,https://stocksnap.io/photo/man-desk-QPJWWR3W2E,LinkedIn Sales Navigator,LinkedIn Sales Navigator,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
197
+ wc47572063,Suzhou woman burning waste 20090926 5964.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Suzhou_woman_burning_waste_20090926_5964.jpg,Jakub Hałun,Jakub Hałun,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
198
+ wc87185005,Slightly Business casual Informal wear - pose 2.jpg,Wikimedia Commons,https://commons.wikimedia.org/wiki/File:Slightly_Business_casual_Informal_wear_-_pose_2.jpg,Tobias ToMar Maier,Tobias ToMar Maier,CC BY-SA 3.0,https://creativecommons.org/licenses/by-sa/3.0,True,True,CC BY-SA 3.0,
199
+ 5f2648aa-cf39-42f7-b53a-e5fa703a296f,Man Exiting,Stocksnap via Openverse,https://stocksnap.io/photo/man-exiting-1GYKJQOTMM,Bruce Mars,Bruce Mars,CC0 1.0,https://creativecommons.org/publicdomain/zero/1.0/,False,False,"any licence, no credit needed",
200
+ wc69428885,"ILA 2018, Schönefeld (1X7A5927).jpg",Wikimedia Commons,"https://commons.wikimedia.org/wiki/File:ILA_2018,_Sch%C3%B6nefeld_(1X7A5927).jpg",Matti Blume,Matti Blume,CC BY-SA 4.0,https://creativecommons.org/licenses/by-sa/4.0,True,True,CC BY-SA 4.0,
metadata/models.json ADDED
@@ -0,0 +1,444 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_rules": {
3
+ "principle": "every setting is the provider's own API default unless it is one of the interventions below (decided with Ani 2026-10-30)",
4
+ "shape": "aspect ratio 3:2 / 2:3 / 1:1 if the model has it; else its keep-aspect option; else exact size of that step's input",
5
+ "watermark": "off wherever there is a switch",
6
+ "effort": "quality / thinking / reasoning / precision at their maximum; resolution tiers stay at default; open-weights dials (Qwen-Image-Edit-2511 steps, acceleration, guidance) at fal's default (top effort tested, kept the face less well; Ani 2026-11-04)",
7
+ "moderation": "least restrictive setting we can send, incl. fal's safety checker off; moderation we cannot reach stays at the provider default; a refusal counts as a failed try",
8
+ "format": "the format the lab's own API returns when no format is requested, not fal's default (Ani 2026-11-05): JPEG for Seedream 5.0 Pro / Lite (BytePlus default jpeg) and Grok Imagine Image 2.0 (xAI returns JPEG), WebP for Muse Image (Meta default webp), PNG for the rest (OpenAI default png; Google returns PNG unless JPEG is requested; BFL, Ideogram, Microsoft, Kling and Alibaba have no format setting and return PNG; Qwen-Image-Edit-2511 has open weights, fal returns PNG). fal's output_format is set to that format. Checked on the files 2026-11-05: content credentials (C2PA) signed by OpenAI, Google, BytePlus, Ideogram, Microsoft and xAI, Kling's and Alibaba's AIGC labels and Meta's XMP are intact, and no PNG shows a JPEG block pattern except fal's PNG copy of Grok's JPEG",
9
+ "prompt_expansion": "provider's documented default where there is one; off where the provider has a setting without a documented default or has no expansion; fal-side expansion switches always off",
10
+ "seed": "int(sha256('model|photo|step|try')) mod 2^31 where the model takes a seed",
11
+ "request": "one image per call; the instruction text is the only prompt; every setting sent explicitly",
12
+ "fal_only_plumbing": "settings with no provider equivalent pinned to: one image per call, whole-image edit, opaque background",
13
+ "chain": "step 1 gets the reference PNG; each later step gets the previous output unchanged (its own URL), whatever format and size; raw files kept",
14
+ "check": "gpt-6.1-sol (medium) sees the raw before/after; partial accepted; 3 tries; chain stops after 3 failed tries; timeouts and server errors do not use a try",
15
+ "crop": "step-5 output resized to the reference size (Lanczos), same face box (1.7x largest face, centre raised 5%), scaled to 768 px, saved as PNG",
16
+ "exclusion": "aspect ratio changed by more than 1%; models below 80% step-5 completion are not voted (Ani 2026-11-03; Grok Imagine Image (quality) allowed just under)",
17
+ "record": "fal_schemas/ and provider_docs/ saved 2026-10-30 (Wayback links in provider_docs/fetch_log.tsv and wayback_retry.tsv); each try's final request and response logged by the runner (retries after timeouts and server errors are not)",
18
+ "calls": "fal sync endpoint (fal.run) since 2026-11-03 after fal's queue stalled; Alibaba DashScope direct for Qwen-Image-3.0-Pro and -2.1-Pro; Replicate for P-Image-Edit"
19
+ },
20
+ "approved": "2026-10-30",
21
+ "updated": "2026-11-05",
22
+ "models": [
23
+ {
24
+ "name": "gpt-image-2.5-sunburst",
25
+ "label": "GPT Image 2.5 Sunburst (Max Quality)",
26
+ "provider": "fal",
27
+ "endpoint": "openai/gpt-image-2.5/sunburst/edit",
28
+ "image_field": "image_urls",
29
+ "shape": "fixed",
30
+ "send": {
31
+ "image_size": "auto",
32
+ "quality": "max",
33
+ "background": "auto",
34
+ "output_format": "png",
35
+ "num_images": 1,
36
+ "enable_safety_checker": false
37
+ },
38
+ "seed": false,
39
+ "source": "OpenAI images/edits: output_format default png, quality default auto (max exists), size default auto, background auto, moderation auto (low not exposed on fal)",
40
+ "status": "on_leaderboard",
41
+ "participant_id": "par_1ZqchVbbZcVgKP",
42
+ "list_price_per_image_usd": 0.18,
43
+ "price_basis": "re-measured 2026-11-05 like GPT Image 2.6: 5,488 output tokens (3:2, 2:3), 8,232 (1:1) at quality max; was $0.154 from the 2026-10-27 measurement (4,667 / 7,024 tokens)",
44
+ "reached_step5": "196/199"
45
+ },
46
+ {
47
+ "name": "gpt-image-2.5-flare",
48
+ "label": "GPT Image 2.5 Flare (Max Quality)",
49
+ "provider": "fal",
50
+ "endpoint": "openai/gpt-image-2.5/flare/edit",
51
+ "image_field": "image_urls",
52
+ "shape": "fixed",
53
+ "send": {
54
+ "image_size": "auto",
55
+ "quality": "max",
56
+ "background": "auto",
57
+ "output_format": "png",
58
+ "num_images": 1,
59
+ "enable_safety_checker": false
60
+ },
61
+ "seed": false,
62
+ "source": "as Sunburst",
63
+ "status": "on_leaderboard",
64
+ "participant_id": "par_1ZqciFXwVbmuqF",
65
+ "list_price_per_image_usd": 0.18,
66
+ "price_basis": "re-measured 2026-11-05 like GPT Image 2.6: 5,488 output tokens (3:2, 2:3), 8,232 (1:1) at quality max; was $0.154 from the 2026-10-27 measurement (4,667 / 7,024 tokens)",
67
+ "reached_step5": "191/199"
68
+ },
69
+ {
70
+ "name": "nano-banana-2.1",
71
+ "label": "Nano Banana 2.1 (High Thinking)",
72
+ "provider": "fal",
73
+ "endpoint": "google/nano-banana-2.1/edit",
74
+ "image_field": "image_urls",
75
+ "shape": "aspect_ratio",
76
+ "send": {
77
+ "thinking_level": "high",
78
+ "resolution": "1K",
79
+ "output_format": "png",
80
+ "safety_tolerance": "6",
81
+ "enable_web_search": false,
82
+ "limit_generations": true,
83
+ "num_images": 1
84
+ },
85
+ "seed": true,
86
+ "source": "Gemini image generation: 1K default, thinking always on (level model-dependent), SynthID always on, png/jpeg both supported with no stated default (-> png rule), seed optional",
87
+ "status": "on_leaderboard",
88
+ "participant_id": "par_1Zqcin3reEdVrL",
89
+ "list_price_per_image_usd": 0.043,
90
+ "price_basis": "Google: 1,120 out tok x $30/M + 1,120 in x $1.50/M + ~1,000 thinking x $7.50/M",
91
+ "reached_step5": "192/199"
92
+ },
93
+ {
94
+ "name": "nano-banana-pro",
95
+ "label": "Nano Banana Pro",
96
+ "provider": "fal",
97
+ "endpoint": "fal-ai/nano-banana-pro/edit",
98
+ "image_field": "image_urls",
99
+ "shape": "aspect_ratio",
100
+ "send": {
101
+ "resolution": "1K",
102
+ "output_format": "png",
103
+ "safety_tolerance": "6",
104
+ "enable_web_search": false,
105
+ "limit_generations": true,
106
+ "num_images": 1
107
+ },
108
+ "seed": true,
109
+ "source": "as Nano Banana 2.1; thinking always on with a single level, so not sent",
110
+ "status": "on_leaderboard",
111
+ "participant_id": "par_1ZqcjI3Jy4BUCH",
112
+ "list_price_per_image_usd": 0.148,
113
+ "price_basis": "Google: 1,120 out tok x $120/M + 560 in x $2/M + ~1,000 thinking x $12/M",
114
+ "reached_step5": "185/199"
115
+ },
116
+ {
117
+ "name": "seedream-5-pro",
118
+ "label": "Seedream 5.0 Pro",
119
+ "provider": "fal",
120
+ "endpoint": "bytedance/seedream/v5/pro/edit",
121
+ "image_field": "image_urls",
122
+ "shape": "fixed",
123
+ "send": {
124
+ "image_size": "auto_2K",
125
+ "watermark": false,
126
+ "output_format": "jpeg",
127
+ "enhance_prompt_mode": "standard",
128
+ "background": "opaque",
129
+ "num_images": 1,
130
+ "enable_safety_checker": false
131
+ },
132
+ "seed": false,
133
+ "source": "BytePlus ModelArk: watermark default true (-> off, intervention), output_format default jpeg, optimize_prompt mode default standard, size 2K",
134
+ "status": "on_leaderboard",
135
+ "participant_id": "par_1ZqcjmwxM2fP66",
136
+ "list_price_per_image_usd": 0.09,
137
+ "price_basis": "BytePlus ModelArk >2.61 MP tier $0.09/image (v2 outputs 4.15 MP at the 2K default)",
138
+ "reached_step5": "192/199"
139
+ },
140
+ {
141
+ "name": "seedream-5-lite",
142
+ "label": "Seedream 5.0 Lite",
143
+ "provider": "fal",
144
+ "endpoint": "bytedance/seedream/v5/lite/edit",
145
+ "image_field": "image_urls",
146
+ "shape": "fixed",
147
+ "send": {
148
+ "image_size": "auto_2K",
149
+ "watermark": false,
150
+ "output_format": "jpeg",
151
+ "num_images": 1,
152
+ "max_images": 1,
153
+ "enable_safety_checker": false
154
+ },
155
+ "seed": false,
156
+ "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",
157
+ "status": "on_leaderboard",
158
+ "participant_id": "par_1ZqckGxhfElEwY",
159
+ "list_price_per_image_usd": 0.035,
160
+ "price_basis": "BytePlus ModelArk $0.035/image, input free",
161
+ "reached_step5": "188/199"
162
+ },
163
+ {
164
+ "name": "muse",
165
+ "label": "Muse Image",
166
+ "provider": "fal",
167
+ "endpoint": "meta/muse-image/edit",
168
+ "image_field": "image_urls",
169
+ "shape": "aspect_ratio",
170
+ "send": {
171
+ "output_format": "webp",
172
+ "num_images": 1
173
+ },
174
+ "seed": false,
175
+ "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",
176
+ "status": "on_leaderboard",
177
+ "participant_id": "par_1ZqckkPfwoUxSz",
178
+ "list_price_per_image_usd": 0.01,
179
+ "price_basis": "Meta Model API flat $0.01/image",
180
+ "reached_step5": "190/199"
181
+ },
182
+ {
183
+ "name": "flux-3",
184
+ "label": "FLUX 3 Image",
185
+ "provider": "fal",
186
+ "endpoint": "blackforestlabs/flux-3/edit-image",
187
+ "image_field": "image_urls",
188
+ "shape": "aspect_ratio",
189
+ "send": {
190
+ "resolution": "1k",
191
+ "output_format": "png",
192
+ "safety_tolerance": 4,
193
+ "enable_prompt_expansion": false
194
+ },
195
+ "seed": false,
196
+ "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",
197
+ "status": "on_leaderboard",
198
+ "participant_id": "par_1ZqclEHD4AV5Lx",
199
+ "list_price_per_image_usd": 0.048,
200
+ "price_basis": "BFL 1k tier 4.8c, reference images free",
201
+ "reached_step5": "193/199"
202
+ },
203
+ {
204
+ "name": "ideogram-4.5",
205
+ "label": "Ideogram 4.5 (High Quality, High Precision)",
206
+ "provider": "fal",
207
+ "endpoint": "ideogram/v4.5/edit",
208
+ "image_field": "image_url",
209
+ "shape": "fixed",
210
+ "send": {
211
+ "image_size": "auto",
212
+ "quality": "high",
213
+ "edit_precision": "high",
214
+ "context_window": "none",
215
+ "num_images": 1,
216
+ "enable_safety_checker": false
217
+ },
218
+ "seed": true,
219
+ "source": "Ideogram openapi precise-edit/ideogram-4-5: quality default medium (max high), seed supported, no magic_prompt on precise edit; no format setting",
220
+ "status": "on_leaderboard",
221
+ "participant_id": "par_1ZqcliNedxU86d",
222
+ "list_price_per_image_usd": 0.22,
223
+ "price_basis": "Ideogram API quality high $0.22/image",
224
+ "reached_step5": "195/199"
225
+ },
226
+ {
227
+ "name": "mai-image-2.5-pro",
228
+ "label": "MAI-Image-2.5-Pro",
229
+ "provider": "fal",
230
+ "endpoint": "microsoft/mai-image-2.5-pro/edit",
231
+ "image_field": "image_url",
232
+ "shape": "aspect_ratio",
233
+ "send": {
234
+ "output_format": "png",
235
+ "num_images": 1
236
+ },
237
+ "seed": false,
238
+ "source": "Microsoft Foundry MAI: output always PNG, edit inputs JPEG/PNG, no size field on edits, 2.5 max 1,048,576 px",
239
+ "status": "on_leaderboard",
240
+ "participant_id": "par_1ZqcmCtOtXcinz",
241
+ "list_price_per_image_usd": 0.117,
242
+ "price_basis": "Microsoft Foundry $106/M out, $8/M image in; ~1,024 tok/MP inferred",
243
+ "reached_step5": "172/199"
244
+ },
245
+ {
246
+ "name": "grok-imagine-2.0",
247
+ "label": "Grok Imagine Image 2.0 (Medium Quality)",
248
+ "provider": "fal",
249
+ "endpoint": "xai/grok-imagine-image/v2.0/edit",
250
+ "image_field": "image_urls",
251
+ "shape": "aspect_ratio",
252
+ "send": {
253
+ "quality": "medium",
254
+ "resolution": "1k",
255
+ "output_format": "jpeg",
256
+ "num_images": 1,
257
+ "enable_safety_checker": false
258
+ },
259
+ "seed": false,
260
+ "source": "xAI images: quality low/medium/auto default auto (medium = max), resolution 1k, mime jpeg unless quality produces png, aspect default auto",
261
+ "status": "on_leaderboard",
262
+ "participant_id": "par_1ZqcofFmAZr4Yi",
263
+ "list_price_per_image_usd": 0.04,
264
+ "price_basis": "xAI pricing page, flat $0.04/image",
265
+ "reached_step5": "175/199"
266
+ },
267
+ {
268
+ "name": "kling-o1",
269
+ "label": "Kling Image O1",
270
+ "provider": "fal",
271
+ "endpoint": "fal-ai/kling-image/o1",
272
+ "image_field": "image_urls",
273
+ "shape": "aspect_ratio",
274
+ "send": {
275
+ "resolution": "1K",
276
+ "output_format": "png",
277
+ "num_images": 1,
278
+ "enable_safety_checker": false
279
+ },
280
+ "seed": false,
281
+ "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)",
282
+ "status": "on_leaderboard",
283
+ "participant_id": "par_1Zqcme5IPaYe28",
284
+ "list_price_per_image_usd": 0.028,
285
+ "price_basis": "Kling API 8 units x $0.0035",
286
+ "reached_step5": "167/199"
287
+ },
288
+ {
289
+ "name": "wan-2.7-pro",
290
+ "label": "Wan 2.7 Pro",
291
+ "provider": "fal",
292
+ "endpoint": "fal-ai/wan/v2.7/pro/edit",
293
+ "image_field": "image_urls",
294
+ "shape": "exact",
295
+ "send": {
296
+ "output_format": "png",
297
+ "enable_prompt_expansion": false,
298
+ "num_images": 1,
299
+ "enable_safety_checker": false
300
+ },
301
+ "seed": true,
302
+ "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",
303
+ "status": "on_leaderboard",
304
+ "participant_id": "par_1ZqcnCQjqEzo3J",
305
+ "list_price_per_image_usd": 0.075,
306
+ "price_basis": "Alibaba Model Studio wan2.7-image-pro $0.075, output only",
307
+ "reached_step5": "178/199"
308
+ },
309
+ {
310
+ "name": "qwen-image-3.0-pro",
311
+ "label": "Qwen-Image-3.0-Pro (Thinking)",
312
+ "provider": "dashscope",
313
+ "endpoint": "qwen-image-3.0-pro",
314
+ "image_field": null,
315
+ "shape": "exact",
316
+ "send": {
317
+ "n": 1,
318
+ "watermark": false,
319
+ "prompt_extend": true,
320
+ "enable_thinking": true
321
+ },
322
+ "seed": true,
323
+ "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",
324
+ "status": "on_leaderboard",
325
+ "participant_id": "par_1Zqcnfvh0ICqlR",
326
+ "list_price_per_image_usd": 0.043,
327
+ "price_basis": "Alibaba Model Studio (Singapore) 1K $0.04 output + $0.003 input image",
328
+ "reached_step5": "191/199"
329
+ },
330
+ {
331
+ "name": "qwen-image-2.1-pro",
332
+ "label": "Qwen-Image-2.1-Pro (Thinking)",
333
+ "provider": "dashscope",
334
+ "endpoint": "qwen-image-2.1-pro",
335
+ "image_field": null,
336
+ "shape": "exact",
337
+ "send": {
338
+ "n": 1,
339
+ "watermark": false,
340
+ "prompt_extend": true,
341
+ "enable_thinking": true
342
+ },
343
+ "seed": true,
344
+ "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",
345
+ "status": "on_leaderboard",
346
+ "participant_id": "par_1ZqcoB8cEAbf76",
347
+ "list_price_per_image_usd": 0.04,
348
+ "price_basis": "Alibaba Model Studio (Singapore) $0.04/image",
349
+ "reached_step5": "191/199"
350
+ },
351
+ {
352
+ "name": "qwen-image-edit-2511",
353
+ "label": "Qwen-Image-Edit-2511",
354
+ "provider": "fal",
355
+ "endpoint": "fal-ai/qwen-image-edit-2511",
356
+ "image_field": "image_urls",
357
+ "shape": "exact",
358
+ "send": {
359
+ "num_images": 1,
360
+ "output_format": "png",
361
+ "enable_safety_checker": false
362
+ },
363
+ "seed": true,
364
+ "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",
365
+ "status": "on_leaderboard",
366
+ "participant_id": "par_1ZrTY2UFNLac98",
367
+ "list_price_per_image_usd": 0.03,
368
+ "price_basis": "Alibaba Model Studio qwen-image-edit-plus $0.03/image (open weights)",
369
+ "reached_step5": "160/199"
370
+ },
371
+ {
372
+ "name": "nano-banana-2",
373
+ "label": "Nano Banana 2 (High Thinking)",
374
+ "provider": "fal",
375
+ "endpoint": "fal-ai/nano-banana-2/edit",
376
+ "image_field": "image_urls",
377
+ "shape": "aspect_ratio",
378
+ "send": {
379
+ "thinking_level": "high",
380
+ "resolution": "1K",
381
+ "output_format": "png",
382
+ "safety_tolerance": "6",
383
+ "enable_web_search": false,
384
+ "limit_generations": true,
385
+ "num_images": 1
386
+ },
387
+ "seed": true,
388
+ "source": "as Nano Banana 2.1: Gemini 1K default, thinking high = max, png (no Google default), safety_tolerance 6 = least restrictive, web search off",
389
+ "status": "on_leaderboard",
390
+ "participant_id": "par_1ZrTYu0JqTTp2g",
391
+ "list_price_per_image_usd": 0.071,
392
+ "price_basis": "Google: 1,120 out tok x $60/M + input + ~1,000 thinking x $3/M",
393
+ "reached_step5": "183/199"
394
+ },
395
+ {
396
+ "name": "gpt-image-2.6-sunburst",
397
+ "label": "GPT Image 2.6 Sunburst (Max Quality, High Reasoning)",
398
+ "provider": "fal",
399
+ "endpoint": "openai/gpt-image-2.6/sunburst/edit",
400
+ "image_field": "image_urls",
401
+ "shape": "fixed",
402
+ "send": {
403
+ "image_size": "auto",
404
+ "quality": "max",
405
+ "reasoning_effort": "high",
406
+ "background": "auto",
407
+ "output_format": "png",
408
+ "num_images": 1,
409
+ "enable_safety_checker": false
410
+ },
411
+ "seed": false,
412
+ "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",
413
+ "status": "on_leaderboard",
414
+ "list_price_per_image_usd": 0.18,
415
+ "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",
416
+ "reached_step5": "196/199",
417
+ "participant_id": "par_1a2UkRyJ71D4J8"
418
+ },
419
+ {
420
+ "name": "gpt-image-2.6-flare",
421
+ "label": "GPT Image 2.6 Flare (Max Quality, High Reasoning)",
422
+ "provider": "fal",
423
+ "endpoint": "openai/gpt-image-2.6/flare/edit",
424
+ "image_field": "image_urls",
425
+ "shape": "fixed",
426
+ "send": {
427
+ "image_size": "auto",
428
+ "quality": "max",
429
+ "reasoning_effort": "high",
430
+ "background": "auto",
431
+ "output_format": "png",
432
+ "num_images": 1,
433
+ "enable_safety_checker": false
434
+ },
435
+ "seed": false,
436
+ "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",
437
+ "status": "on_leaderboard",
438
+ "list_price_per_image_usd": 0.18,
439
+ "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",
440
+ "reached_step5": "194/199",
441
+ "participant_id": "par_1a2UlVdJSE8VFt"
442
+ }
443
+ ]
444
+ }
metadata/photos.jsonl ADDED
The diff for this file is too large to render. See raw diff
 
metadata/standings.json ADDED
@@ -0,0 +1,292 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "benchmark_id": "bmk_1ZqZJsP7VXHeeH",
3
+ "leaderboard_id": "rlb_1Zqch9KooTHLgd",
4
+ "pulled": "2026-11-06",
5
+ "standings": [
6
+ {
7
+ "id": "par_1ZqcliNedxU86d",
8
+ "name": "Ideogram 4.5 (High Quality, High Precision)",
9
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
10
+ "status": "Idle",
11
+ "score": 1900.508830775872,
12
+ "wins": 5097.5,
13
+ "totalMatches": 5760,
14
+ "isDisabled": false,
15
+ "confidenceInterval": {
16
+ "lowerOffset": 32.87070364737633,
17
+ "upperOffset": 32.870703647376104
18
+ },
19
+ "model_id": "ideogram-4.5"
20
+ },
21
+ {
22
+ "id": "par_1ZqclEHD4AV5Lx",
23
+ "name": "FLUX 3 Image",
24
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
25
+ "status": "Idle",
26
+ "score": 1742.165015249256,
27
+ "wins": 4820,
28
+ "totalMatches": 5760,
29
+ "isDisabled": false,
30
+ "confidenceInterval": {
31
+ "lowerOffset": 29.348307475253023,
32
+ "upperOffset": 29.348307475253023
33
+ },
34
+ "model_id": "flux-3"
35
+ },
36
+ {
37
+ "id": "par_1ZqckkPfwoUxSz",
38
+ "name": "Muse Image",
39
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
40
+ "status": "Idle",
41
+ "score": 1490.2012582207722,
42
+ "wins": 4261.5,
43
+ "totalMatches": 5760,
44
+ "isDisabled": false,
45
+ "confidenceInterval": {
46
+ "lowerOffset": 24.2580440715044,
47
+ "upperOffset": 24.2580440715044
48
+ },
49
+ "model_id": "muse"
50
+ },
51
+ {
52
+ "id": "par_1ZqcoB8cEAbf76",
53
+ "name": "Qwen-Image-2.1-Pro (Thinking)",
54
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
55
+ "status": "Idle",
56
+ "score": 1373.3031513045878,
57
+ "wins": 3956,
58
+ "totalMatches": 5760,
59
+ "isDisabled": false,
60
+ "confidenceInterval": {
61
+ "lowerOffset": 22.959198477293967,
62
+ "upperOffset": 22.959198477293967
63
+ },
64
+ "model_id": "qwen-image-2.1-pro"
65
+ },
66
+ {
67
+ "id": "par_1ZqcjmwxM2fP66",
68
+ "name": "Seedream 5.0 Pro",
69
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
70
+ "status": "Idle",
71
+ "score": 1247.276446418592,
72
+ "wins": 3599.5,
73
+ "totalMatches": 5760,
74
+ "isDisabled": false,
75
+ "confidenceInterval": {
76
+ "lowerOffset": 22.56749197971635,
77
+ "upperOffset": 22.56749197971635
78
+ },
79
+ "model_id": "seedream-5-pro"
80
+ },
81
+ {
82
+ "id": "par_1ZqcmCtOtXcinz",
83
+ "name": "MAI-Image-2.5-Pro",
84
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
85
+ "status": "Idle",
86
+ "score": 1208.9017817764588,
87
+ "wins": 3486.5,
88
+ "totalMatches": 5760,
89
+ "isDisabled": false,
90
+ "confidenceInterval": {
91
+ "lowerOffset": 22.257762434175675,
92
+ "upperOffset": 22.257762434175902
93
+ },
94
+ "model_id": "mai-image-2.5-pro"
95
+ },
96
+ {
97
+ "id": "par_1Zqcnfvh0ICqlR",
98
+ "name": "Qwen-Image-3.0-Pro (Thinking)",
99
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
100
+ "status": "Idle",
101
+ "score": 1079.0684006653255,
102
+ "wins": 3094,
103
+ "totalMatches": 5760,
104
+ "isDisabled": false,
105
+ "confidenceInterval": {
106
+ "lowerOffset": 21.83557507824935,
107
+ "upperOffset": 21.83557507824935
108
+ },
109
+ "model_id": "qwen-image-3.0-pro"
110
+ },
111
+ {
112
+ "id": "par_1a2UkRyJ71D4J8",
113
+ "name": "GPT Image 2.6 Sunburst (Max Quality, High Reasoning)",
114
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
115
+ "status": "Idle",
116
+ "score": 1060.811151832436,
117
+ "wins": 3038,
118
+ "totalMatches": 5760,
119
+ "isDisabled": false,
120
+ "confidenceInterval": {
121
+ "lowerOffset": 22.12374554887515,
122
+ "upperOffset": 22.12374554887515
123
+ },
124
+ "model_id": "gpt-image-2.6-sunburst"
125
+ },
126
+ {
127
+ "id": "par_1ZqcjI3Jy4BUCH",
128
+ "name": "Nano Banana Pro",
129
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
130
+ "status": "Idle",
131
+ "score": 1054.1312276093129,
132
+ "wins": 3017.5,
133
+ "totalMatches": 5760,
134
+ "isDisabled": false,
135
+ "confidenceInterval": {
136
+ "lowerOffset": 21.946409994914575,
137
+ "upperOffset": 21.946409994914575
138
+ },
139
+ "model_id": "nano-banana-pro"
140
+ },
141
+ {
142
+ "id": "par_1Zqcin3reEdVrL",
143
+ "name": "Nano Banana 2.1 (High Thinking)",
144
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
145
+ "status": "Idle",
146
+ "score": 983.6912077859039,
147
+ "wins": 2801,
148
+ "totalMatches": 5760,
149
+ "isDisabled": false,
150
+ "confidenceInterval": {
151
+ "lowerOffset": 21.888347752630466,
152
+ "upperOffset": 21.888347752630466
153
+ },
154
+ "model_id": "nano-banana-2.1"
155
+ },
156
+ {
157
+ "id": "par_1ZrTYu0JqTTp2g",
158
+ "name": "Nano Banana 2 (High Thinking)",
159
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
160
+ "status": "Idle",
161
+ "score": 954.6773205021683,
162
+ "wins": 2712,
163
+ "totalMatches": 5760,
164
+ "isDisabled": false,
165
+ "confidenceInterval": {
166
+ "lowerOffset": 21.992605503342247,
167
+ "upperOffset": 21.992605503342247
168
+ },
169
+ "model_id": "nano-banana-2"
170
+ },
171
+ {
172
+ "id": "par_1ZrTY2UFNLac98",
173
+ "name": "Qwen-Image-Edit-2511",
174
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
175
+ "status": "Idle",
176
+ "score": 953.7017547000086,
177
+ "wins": 2709,
178
+ "totalMatches": 5760,
179
+ "isDisabled": false,
180
+ "confidenceInterval": {
181
+ "lowerOffset": 22.288547674657366,
182
+ "upperOffset": 22.288547674657366
183
+ },
184
+ "model_id": "qwen-image-edit-2511"
185
+ },
186
+ {
187
+ "id": "par_1ZqchVbbZcVgKP",
188
+ "name": "GPT Image 2.5 Sunburst (Max Quality)",
189
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
190
+ "status": "Idle",
191
+ "score": 944.3849375983875,
192
+ "wins": 2680.5,
193
+ "totalMatches": 5760,
194
+ "isDisabled": false,
195
+ "confidenceInterval": {
196
+ "lowerOffset": 22.0009544274767,
197
+ "upperOffset": 22.0009544274767
198
+ },
199
+ "model_id": "gpt-image-2.5-sunburst"
200
+ },
201
+ {
202
+ "id": "par_1ZqcofFmAZr4Yi",
203
+ "name": "Grok Imagine Image 2.0 (Medium Quality)",
204
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
205
+ "status": "Idle",
206
+ "score": 887.5219221341567,
207
+ "wins": 2507.5,
208
+ "totalMatches": 5760,
209
+ "isDisabled": false,
210
+ "confidenceInterval": {
211
+ "lowerOffset": 22.017645120747716,
212
+ "upperOffset": 22.017645120747716
213
+ },
214
+ "model_id": "grok-imagine-2.0"
215
+ },
216
+ {
217
+ "id": "par_1ZqcnCQjqEzo3J",
218
+ "name": "Wan 2.7 Pro",
219
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
220
+ "status": "Idle",
221
+ "score": 716.346281475952,
222
+ "wins": 2006,
223
+ "totalMatches": 5760,
224
+ "isDisabled": false,
225
+ "confidenceInterval": {
226
+ "lowerOffset": 22.78033609808756,
227
+ "upperOffset": 22.78033609808756
228
+ },
229
+ "model_id": "wan-2.7-pro"
230
+ },
231
+ {
232
+ "id": "par_1a2UlVdJSE8VFt",
233
+ "name": "GPT Image 2.6 Flare (Max Quality, High Reasoning)",
234
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
235
+ "status": "Idle",
236
+ "score": 613.397583080466,
237
+ "wins": 1726,
238
+ "totalMatches": 5760,
239
+ "isDisabled": false,
240
+ "confidenceInterval": {
241
+ "lowerOffset": 24.476614215175573,
242
+ "upperOffset": 24.476614215175573
243
+ },
244
+ "model_id": "gpt-image-2.6-flare"
245
+ },
246
+ {
247
+ "id": "par_1ZqciFXwVbmuqF",
248
+ "name": "GPT Image 2.5 Flare (Max Quality)",
249
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
250
+ "status": "Idle",
251
+ "score": 593.7879563396974,
252
+ "wins": 1675,
253
+ "totalMatches": 5760,
254
+ "isDisabled": false,
255
+ "confidenceInterval": {
256
+ "lowerOffset": 24.26888490878457,
257
+ "upperOffset": 24.26888490878457
258
+ },
259
+ "model_id": "gpt-image-2.5-flare"
260
+ },
261
+ {
262
+ "id": "par_1Zqcme5IPaYe28",
263
+ "name": "Kling Image O1",
264
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
265
+ "status": "Idle",
266
+ "score": 398.9956450366217,
267
+ "wins": 1214,
268
+ "totalMatches": 5760,
269
+ "isDisabled": false,
270
+ "confidenceInterval": {
271
+ "lowerOffset": 26.876688974180297,
272
+ "upperOffset": 26.876688974180297
273
+ },
274
+ "model_id": "kling-o1"
275
+ },
276
+ {
277
+ "id": "par_1ZqckGxhfElEwY",
278
+ "name": "Seedream 5.0 Lite",
279
+ "leaderboardId": "rlb_1Zqch9KooTHLgd",
280
+ "status": "Idle",
281
+ "score": -202.8718725059748,
282
+ "wins": 318.5,
283
+ "totalMatches": 5760,
284
+ "isDisabled": false,
285
+ "confidenceInterval": {
286
+ "lowerOffset": 44.143883540798925,
287
+ "upperOffset": 44.1438835407987
288
+ },
289
+ "model_id": "seedream-5-lite"
290
+ }
291
+ ]
292
+ }
pipeline/fal_schemas/_fetched.txt ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+ fetched 2026-10-30T15:39:05.269982+00:00 from https://fal.ai/api/openapi/queue/openapi.json?endpoint_id=<endpoint>
2
+ 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
pipeline/fal_schemas/blackforestlabs__flux-3__edit-image.json ADDED
@@ -0,0 +1,437 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "Flux3EditImageInput": {
5
+ "properties": {
6
+ "aspect_ratio": {
7
+ "default": "auto",
8
+ "description": "Output aspect ratio. Auto uses the first reference image when editing.",
9
+ "enum": [
10
+ "auto",
11
+ "21:9",
12
+ "2:1",
13
+ "16:9",
14
+ "3:2",
15
+ "7:5",
16
+ "4:3",
17
+ "5:4",
18
+ "1:1",
19
+ "4:5",
20
+ "3:4",
21
+ "5:7",
22
+ "2:3",
23
+ "9:16",
24
+ "1:2"
25
+ ],
26
+ "title": "Aspect Ratio",
27
+ "type": "string"
28
+ },
29
+ "enable_prompt_expansion": {
30
+ "default": false,
31
+ "description": "Expand the prompt while preserving its intent and reference roles.",
32
+ "title": "Enable Prompt Expansion",
33
+ "type": "boolean"
34
+ },
35
+ "image_urls": {
36
+ "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.",
37
+ "examples": [
38
+ [
39
+ "https://storage.googleapis.com/falserverless/example_inputs/flux2_pro_edit_input.png"
40
+ ]
41
+ ],
42
+ "items": {
43
+ "type": "string"
44
+ },
45
+ "maxItems": 10,
46
+ "minItems": 1,
47
+ "title": "Image Urls",
48
+ "type": "array"
49
+ },
50
+ "output_format": {
51
+ "default": "jpeg",
52
+ "description": "The format of the generated image.",
53
+ "enum": [
54
+ "jpeg",
55
+ "png"
56
+ ],
57
+ "title": "Output Format",
58
+ "type": "string"
59
+ },
60
+ "prompt": {
61
+ "description": "The prompt to generate an image from.",
62
+ "examples": [
63
+ "A red fox leaping over a stream in a pine forest, low-angle wildlife photograph."
64
+ ],
65
+ "title": "Prompt",
66
+ "type": "string"
67
+ },
68
+ "resolution": {
69
+ "default": "1k",
70
+ "description": "Output resolution tier. 4k can take several minutes.",
71
+ "enum": [
72
+ "768sq",
73
+ "1k",
74
+ "1.5k",
75
+ "2k",
76
+ "4k"
77
+ ],
78
+ "title": "Resolution",
79
+ "type": "string"
80
+ },
81
+ "safety_tolerance": {
82
+ "default": 2,
83
+ "description": "Safety tolerance, from 0 (strictest) to 4.",
84
+ "maximum": 4,
85
+ "minimum": 0,
86
+ "title": "Safety Tolerance",
87
+ "type": "integer"
88
+ },
89
+ "sync_mode": {
90
+ "default": false,
91
+ "description": "Return the image as a data URI instead of storing it in request history.",
92
+ "title": "Sync Mode",
93
+ "type": "boolean"
94
+ },
95
+ "version": {
96
+ "const": "latest",
97
+ "default": "latest",
98
+ "description": "The model version.",
99
+ "title": "Version",
100
+ "type": "string"
101
+ }
102
+ },
103
+ "required": [
104
+ "prompt",
105
+ "image_urls"
106
+ ],
107
+ "title": "Flux3ImageEditInput",
108
+ "type": "object",
109
+ "x-fal-order-properties": [
110
+ "prompt",
111
+ "image_urls",
112
+ "aspect_ratio",
113
+ "resolution",
114
+ "enable_prompt_expansion",
115
+ "safety_tolerance",
116
+ "output_format",
117
+ "sync_mode",
118
+ "version"
119
+ ]
120
+ },
121
+ "Flux3EditImageOutput": {
122
+ "properties": {
123
+ "images": {
124
+ "description": "The generated image.",
125
+ "items": {
126
+ "$ref": "#/components/schemas/ImageFile"
127
+ },
128
+ "title": "Images",
129
+ "type": "array"
130
+ }
131
+ },
132
+ "required": [
133
+ "images"
134
+ ],
135
+ "title": "Flux3ImageOutput",
136
+ "type": "object",
137
+ "x-fal-order-properties": [
138
+ "images"
139
+ ]
140
+ },
141
+ "ImageFile": {
142
+ "properties": {
143
+ "content_type": {
144
+ "anyOf": [
145
+ {
146
+ "type": "string"
147
+ },
148
+ {
149
+ "type": "null"
150
+ }
151
+ ],
152
+ "description": "The mime type of the file.",
153
+ "examples": [
154
+ "image/png"
155
+ ],
156
+ "title": "Content Type"
157
+ },
158
+ "file_name": {
159
+ "anyOf": [
160
+ {
161
+ "type": "string"
162
+ },
163
+ {
164
+ "type": "null"
165
+ }
166
+ ],
167
+ "description": "The name of the file. It will be auto-generated if not provided.",
168
+ "examples": [
169
+ "z9RV14K95DvU.png"
170
+ ],
171
+ "title": "File Name"
172
+ },
173
+ "file_size": {
174
+ "anyOf": [
175
+ {
176
+ "type": "integer"
177
+ },
178
+ {
179
+ "type": "null"
180
+ }
181
+ ],
182
+ "description": "The size of the file in bytes.",
183
+ "examples": [
184
+ 4404019
185
+ ],
186
+ "title": "File Size"
187
+ },
188
+ "height": {
189
+ "anyOf": [
190
+ {
191
+ "type": "integer"
192
+ },
193
+ {
194
+ "type": "null"
195
+ }
196
+ ],
197
+ "description": "The height of the image",
198
+ "title": "Height"
199
+ },
200
+ "url": {
201
+ "description": "The URL where the file can be downloaded from.",
202
+ "title": "Url",
203
+ "type": "string"
204
+ },
205
+ "width": {
206
+ "anyOf": [
207
+ {
208
+ "type": "integer"
209
+ },
210
+ {
211
+ "type": "null"
212
+ }
213
+ ],
214
+ "description": "The width of the image",
215
+ "title": "Width"
216
+ }
217
+ },
218
+ "required": [
219
+ "url"
220
+ ],
221
+ "title": "ImageFile",
222
+ "type": "object",
223
+ "x-fal-order-properties": [
224
+ "url",
225
+ "content_type",
226
+ "file_name",
227
+ "file_size",
228
+ "width",
229
+ "height"
230
+ ]
231
+ },
232
+ "QueueStatus": {
233
+ "properties": {
234
+ "cancel_url": {
235
+ "description": "The cancel url.",
236
+ "type": "string"
237
+ },
238
+ "logs": {
239
+ "additionalProperties": true,
240
+ "description": "The logs.",
241
+ "type": "object"
242
+ },
243
+ "metrics": {
244
+ "additionalProperties": true,
245
+ "description": "The metrics.",
246
+ "type": "object"
247
+ },
248
+ "queue_position": {
249
+ "description": "The queue position.",
250
+ "type": "integer"
251
+ },
252
+ "request_id": {
253
+ "description": "The request id.",
254
+ "type": "string"
255
+ },
256
+ "response_url": {
257
+ "description": "The response url.",
258
+ "type": "string"
259
+ },
260
+ "status": {
261
+ "enum": [
262
+ "IN_QUEUE",
263
+ "IN_PROGRESS",
264
+ "COMPLETED"
265
+ ],
266
+ "type": "string"
267
+ },
268
+ "status_url": {
269
+ "description": "The status url.",
270
+ "type": "string"
271
+ }
272
+ },
273
+ "required": [
274
+ "status",
275
+ "request_id"
276
+ ],
277
+ "type": "object"
278
+ }
279
+ },
280
+ "securitySchemes": {
281
+ "apiKeyAuth": {
282
+ "description": "Fal Key",
283
+ "in": "header",
284
+ "name": "Authorization",
285
+ "type": "apiKey"
286
+ }
287
+ }
288
+ },
289
+ "info": {
290
+ "description": "The OpenAPI schema for the blackforestlabs/flux-3/edit-image queue.",
291
+ "title": "Queue OpenAPI for blackforestlabs/flux-3/edit-image",
292
+ "version": "1.0.0",
293
+ "x-fal-metadata": {
294
+ "about": "Edit",
295
+ "category": "image-to-image",
296
+ "documentationUrl": "https://fal.ai/models/blackforestlabs/flux-3/edit-image/api",
297
+ "endpointId": "blackforestlabs/flux-3/edit-image",
298
+ "playgroundUrl": "https://fal.ai/models/blackforestlabs/flux-3/edit-image",
299
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0aacace0/cuYCs5EDeB5znT34LrInr.jpg"
300
+ }
301
+ },
302
+ "openapi": "3.1.0",
303
+ "paths": {
304
+ "/blackforestlabs/flux-3/edit-image": {
305
+ "post": {
306
+ "requestBody": {
307
+ "content": {
308
+ "application/json": {
309
+ "schema": {
310
+ "$ref": "#/components/schemas/Flux3EditImageInput"
311
+ }
312
+ }
313
+ },
314
+ "required": true
315
+ },
316
+ "responses": {
317
+ "200": {
318
+ "content": {
319
+ "application/json": {
320
+ "schema": {
321
+ "$ref": "#/components/schemas/QueueStatus"
322
+ }
323
+ }
324
+ },
325
+ "description": "The request status."
326
+ }
327
+ }
328
+ }
329
+ },
330
+ "/blackforestlabs/flux-3/edit-image/requests/{request_id}": {
331
+ "get": {
332
+ "parameters": [
333
+ {
334
+ "in": "path",
335
+ "name": "request_id",
336
+ "required": true,
337
+ "schema": {
338
+ "description": "Request ID",
339
+ "type": "string"
340
+ }
341
+ }
342
+ ],
343
+ "responses": {
344
+ "200": {
345
+ "content": {
346
+ "application/json": {
347
+ "schema": {
348
+ "$ref": "#/components/schemas/Flux3EditImageOutput"
349
+ }
350
+ }
351
+ },
352
+ "description": "Result of the request."
353
+ }
354
+ }
355
+ }
356
+ },
357
+ "/blackforestlabs/flux-3/edit-image/requests/{request_id}/cancel": {
358
+ "put": {
359
+ "parameters": [
360
+ {
361
+ "in": "path",
362
+ "name": "request_id",
363
+ "required": true,
364
+ "schema": {
365
+ "description": "Request ID",
366
+ "type": "string"
367
+ }
368
+ }
369
+ ],
370
+ "responses": {
371
+ "200": {
372
+ "content": {
373
+ "application/json": {
374
+ "schema": {
375
+ "properties": {
376
+ "success": {
377
+ "description": "Whether the request was cancelled successfully.",
378
+ "type": "boolean"
379
+ }
380
+ },
381
+ "type": "object"
382
+ }
383
+ }
384
+ },
385
+ "description": "The request was cancelled."
386
+ }
387
+ }
388
+ }
389
+ },
390
+ "/blackforestlabs/flux-3/edit-image/requests/{request_id}/status": {
391
+ "get": {
392
+ "parameters": [
393
+ {
394
+ "in": "path",
395
+ "name": "request_id",
396
+ "required": true,
397
+ "schema": {
398
+ "description": "Request ID",
399
+ "type": "string"
400
+ }
401
+ },
402
+ {
403
+ "in": "query",
404
+ "name": "logs",
405
+ "required": false,
406
+ "schema": {
407
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
408
+ "type": "number"
409
+ }
410
+ }
411
+ ],
412
+ "responses": {
413
+ "200": {
414
+ "content": {
415
+ "application/json": {
416
+ "schema": {
417
+ "$ref": "#/components/schemas/QueueStatus"
418
+ }
419
+ }
420
+ },
421
+ "description": "The request status."
422
+ }
423
+ }
424
+ }
425
+ }
426
+ },
427
+ "security": [
428
+ {
429
+ "apiKeyAuth": []
430
+ }
431
+ ],
432
+ "servers": [
433
+ {
434
+ "url": "https://queue.fal.run"
435
+ }
436
+ ]
437
+ }
pipeline/fal_schemas/bytedance__seedream__v5__lite__edit.json ADDED
@@ -0,0 +1,502 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "Image": {
5
+ "description": "Represents an image file.",
6
+ "properties": {
7
+ "content_type": {
8
+ "anyOf": [
9
+ {
10
+ "type": "string"
11
+ },
12
+ {
13
+ "type": "null"
14
+ }
15
+ ],
16
+ "description": "The mime type of the file.",
17
+ "examples": [
18
+ "image/png"
19
+ ],
20
+ "title": "Content Type"
21
+ },
22
+ "file_name": {
23
+ "anyOf": [
24
+ {
25
+ "type": "string"
26
+ },
27
+ {
28
+ "type": "null"
29
+ }
30
+ ],
31
+ "description": "The name of the file. It will be auto-generated if not provided.",
32
+ "examples": [
33
+ "z9RV14K95DvU.png"
34
+ ],
35
+ "title": "File Name"
36
+ },
37
+ "file_size": {
38
+ "anyOf": [
39
+ {
40
+ "type": "integer"
41
+ },
42
+ {
43
+ "type": "null"
44
+ }
45
+ ],
46
+ "description": "The size of the file in bytes.",
47
+ "examples": [
48
+ 4404019
49
+ ],
50
+ "title": "File Size"
51
+ },
52
+ "height": {
53
+ "anyOf": [
54
+ {
55
+ "type": "integer"
56
+ },
57
+ {
58
+ "type": "null"
59
+ }
60
+ ],
61
+ "description": "The height of the image in pixels.",
62
+ "examples": [
63
+ 1024
64
+ ],
65
+ "title": "Height"
66
+ },
67
+ "url": {
68
+ "description": "The URL where the file can be downloaded from.",
69
+ "title": "Url",
70
+ "type": "string"
71
+ },
72
+ "width": {
73
+ "anyOf": [
74
+ {
75
+ "type": "integer"
76
+ },
77
+ {
78
+ "type": "null"
79
+ }
80
+ ],
81
+ "description": "The width of the image in pixels.",
82
+ "examples": [
83
+ 1024
84
+ ],
85
+ "title": "Width"
86
+ }
87
+ },
88
+ "required": [
89
+ "url"
90
+ ],
91
+ "title": "Image",
92
+ "type": "object",
93
+ "x-fal-order-properties": [
94
+ "url",
95
+ "content_type",
96
+ "file_name",
97
+ "file_size",
98
+ "width",
99
+ "height"
100
+ ]
101
+ },
102
+ "QueueStatus": {
103
+ "properties": {
104
+ "cancel_url": {
105
+ "description": "The cancel url.",
106
+ "type": "string"
107
+ },
108
+ "logs": {
109
+ "additionalProperties": true,
110
+ "description": "The logs.",
111
+ "type": "object"
112
+ },
113
+ "metrics": {
114
+ "additionalProperties": true,
115
+ "description": "The metrics.",
116
+ "type": "object"
117
+ },
118
+ "queue_position": {
119
+ "description": "The queue position.",
120
+ "type": "integer"
121
+ },
122
+ "request_id": {
123
+ "description": "The request id.",
124
+ "type": "string"
125
+ },
126
+ "response_url": {
127
+ "description": "The response url.",
128
+ "type": "string"
129
+ },
130
+ "status": {
131
+ "enum": [
132
+ "IN_QUEUE",
133
+ "IN_PROGRESS",
134
+ "COMPLETED"
135
+ ],
136
+ "type": "string"
137
+ },
138
+ "status_url": {
139
+ "description": "The status url.",
140
+ "type": "string"
141
+ }
142
+ },
143
+ "required": [
144
+ "status",
145
+ "request_id"
146
+ ],
147
+ "type": "object"
148
+ },
149
+ "SeedreamLiteImageSize": {
150
+ "properties": {
151
+ "height": {
152
+ "default": 512,
153
+ "description": "The height of the generated image.",
154
+ "exclusiveMinimum": 0,
155
+ "maximum": 16384,
156
+ "title": "Height",
157
+ "type": "integer"
158
+ },
159
+ "width": {
160
+ "default": 512,
161
+ "description": "The width of the generated image.",
162
+ "exclusiveMinimum": 0,
163
+ "maximum": 16384,
164
+ "title": "Width",
165
+ "type": "integer"
166
+ }
167
+ },
168
+ "title": "SeedreamLiteImageSize",
169
+ "type": "object",
170
+ "x-fal-order-properties": [
171
+ "width",
172
+ "height"
173
+ ]
174
+ },
175
+ "SeedreamV5LiteEditInput": {
176
+ "properties": {
177
+ "enable_safety_checker": {
178
+ "default": true,
179
+ "description": "If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked.",
180
+ "examples": [
181
+ true
182
+ ],
183
+ "title": "Enable Safety Checker",
184
+ "type": "boolean"
185
+ },
186
+ "image_size": {
187
+ "anyOf": [
188
+ {
189
+ "$ref": "#/components/schemas/SeedreamLiteImageSize"
190
+ },
191
+ {
192
+ "enum": [
193
+ "square_hd",
194
+ "square",
195
+ "portrait_4_3",
196
+ "portrait_16_9",
197
+ "landscape_4_3",
198
+ "landscape_16_9",
199
+ "auto_2K",
200
+ "auto_3K",
201
+ "auto_4K"
202
+ ],
203
+ "type": "string"
204
+ }
205
+ ],
206
+ "default": "auto_2K",
207
+ "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.",
208
+ "title": "Image Size"
209
+ },
210
+ "image_urls": {
211
+ "description": "List of URLs of input images for editing. When more than 10 references are provided, only the last 10 are used.",
212
+ "examples": [
213
+ [
214
+ "https://v3b.fal.media/files/b/0a8f9936/KOsb_qPB_W0ZJ0Ee2OsnU_586e2892841d46f09049ee7199b303d3.png",
215
+ "https://v3b.fal.media/files/b/0a8f994e/JroWTogO6jOTFk9b6B3XM_591ca38cef2f44bbba2843cbf80fb1b2.png",
216
+ "https://v3b.fal.media/files/b/0a8f9960/Q6pzwXAiFaFPOpSScoE-D_0eca5db19e5242739f127efe49b38922.png"
217
+ ]
218
+ ],
219
+ "items": {
220
+ "type": "string"
221
+ },
222
+ "title": "Image URLs",
223
+ "type": "array"
224
+ },
225
+ "max_images": {
226
+ "default": 1,
227
+ "description": "Maximum images per generation in sequential mode. Ignored when sequential generation is disabled. Combined input references and outputs per generation cannot exceed 15.",
228
+ "maximum": 15,
229
+ "minimum": 1,
230
+ "title": "Max Images",
231
+ "type": "integer"
232
+ },
233
+ "num_images": {
234
+ "default": 1,
235
+ "description": "Number of separate model generations to be run with the prompt.",
236
+ "maximum": 6,
237
+ "minimum": 1,
238
+ "title": "Num Images",
239
+ "type": "integer"
240
+ },
241
+ "output_format": {
242
+ "default": "jpeg",
243
+ "description": "The file format of the generated images.",
244
+ "enum": [
245
+ "jpeg",
246
+ "png"
247
+ ],
248
+ "title": "Output Format",
249
+ "type": "string"
250
+ },
251
+ "prompt": {
252
+ "description": "The text prompt used to edit the image",
253
+ "examples": [
254
+ "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."
255
+ ],
256
+ "title": "Prompt",
257
+ "type": "string"
258
+ },
259
+ "sequential_image_generation": {
260
+ "anyOf": [
261
+ {
262
+ "enum": [
263
+ "auto",
264
+ "disabled"
265
+ ],
266
+ "type": "string"
267
+ },
268
+ {
269
+ "type": "null"
270
+ }
271
+ ],
272
+ "description": "Generate related images with `auto`, or one image per generation with `disabled`. When omitted, values of `max_images` above one enable `auto`.",
273
+ "title": "Sequential Image Generation"
274
+ },
275
+ "sync_mode": {
276
+ "default": false,
277
+ "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.",
278
+ "title": "Sync Mode",
279
+ "type": "boolean"
280
+ },
281
+ "watermark": {
282
+ "default": false,
283
+ "description": "Whether to add the provider's visible watermark.",
284
+ "title": "Watermark",
285
+ "type": "boolean"
286
+ }
287
+ },
288
+ "required": [
289
+ "prompt",
290
+ "image_urls"
291
+ ],
292
+ "title": "SeedDream50LiteEditInput",
293
+ "type": "object",
294
+ "x-fal-order-properties": [
295
+ "prompt",
296
+ "image_size",
297
+ "num_images",
298
+ "max_images",
299
+ "sync_mode",
300
+ "enable_safety_checker",
301
+ "output_format",
302
+ "watermark",
303
+ "sequential_image_generation",
304
+ "image_urls"
305
+ ]
306
+ },
307
+ "SeedreamV5LiteEditOutput": {
308
+ "properties": {
309
+ "images": {
310
+ "description": "Generated images",
311
+ "examples": [
312
+ [
313
+ {
314
+ "url": "https://v3b.fal.media/files/b/0a8fbf56/wu9vcxO3xO6lkHv5zdiIs_7aa8564f6e4f4cc795ecb8e923deb2fb.png"
315
+ }
316
+ ]
317
+ ],
318
+ "items": {
319
+ "$ref": "#/components/schemas/Image"
320
+ },
321
+ "title": "Images",
322
+ "type": "array"
323
+ },
324
+ "seed": {
325
+ "description": "Seed used for generation.",
326
+ "examples": [
327
+ 42
328
+ ],
329
+ "title": "Seed",
330
+ "type": "integer"
331
+ }
332
+ },
333
+ "required": [
334
+ "images",
335
+ "seed"
336
+ ],
337
+ "title": "SeedDream50LiteEditOutput",
338
+ "type": "object",
339
+ "x-fal-order-properties": [
340
+ "images",
341
+ "seed"
342
+ ]
343
+ }
344
+ },
345
+ "securitySchemes": {
346
+ "apiKeyAuth": {
347
+ "description": "Fal Key",
348
+ "in": "header",
349
+ "name": "Authorization",
350
+ "type": "apiKey"
351
+ }
352
+ }
353
+ },
354
+ "info": {
355
+ "description": "The OpenAPI schema for the bytedance/seedream/v5/lite/edit queue.",
356
+ "title": "Queue OpenAPI for bytedance/seedream/v5/lite/edit",
357
+ "version": "1.0.0",
358
+ "x-fal-metadata": {
359
+ "about": "Edit images using Bytedance's SeedDream 5.0 Lite model.",
360
+ "category": "image-to-image",
361
+ "documentationUrl": "https://fal.ai/models/bytedance/seedream/v5/lite/edit/api",
362
+ "endpointId": "bytedance/seedream/v5/lite/edit",
363
+ "playgroundUrl": "https://fal.ai/models/bytedance/seedream/v5/lite/edit",
364
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0a9c2fb5/PIUPm_8kBdpdBoSkOebbz_bcfdbe1021324995bf3c36b05ab59c2c.jpg"
365
+ }
366
+ },
367
+ "openapi": "3.1.0",
368
+ "paths": {
369
+ "/bytedance/seedream/v5/lite/edit": {
370
+ "post": {
371
+ "requestBody": {
372
+ "content": {
373
+ "application/json": {
374
+ "schema": {
375
+ "$ref": "#/components/schemas/SeedreamV5LiteEditInput"
376
+ }
377
+ }
378
+ },
379
+ "required": true
380
+ },
381
+ "responses": {
382
+ "200": {
383
+ "content": {
384
+ "application/json": {
385
+ "schema": {
386
+ "$ref": "#/components/schemas/QueueStatus"
387
+ }
388
+ }
389
+ },
390
+ "description": "The request status."
391
+ }
392
+ }
393
+ }
394
+ },
395
+ "/bytedance/seedream/v5/lite/edit/requests/{request_id}": {
396
+ "get": {
397
+ "parameters": [
398
+ {
399
+ "in": "path",
400
+ "name": "request_id",
401
+ "required": true,
402
+ "schema": {
403
+ "description": "Request ID",
404
+ "type": "string"
405
+ }
406
+ }
407
+ ],
408
+ "responses": {
409
+ "200": {
410
+ "content": {
411
+ "application/json": {
412
+ "schema": {
413
+ "$ref": "#/components/schemas/SeedreamV5LiteEditOutput"
414
+ }
415
+ }
416
+ },
417
+ "description": "Result of the request."
418
+ }
419
+ }
420
+ }
421
+ },
422
+ "/bytedance/seedream/v5/lite/edit/requests/{request_id}/cancel": {
423
+ "put": {
424
+ "parameters": [
425
+ {
426
+ "in": "path",
427
+ "name": "request_id",
428
+ "required": true,
429
+ "schema": {
430
+ "description": "Request ID",
431
+ "type": "string"
432
+ }
433
+ }
434
+ ],
435
+ "responses": {
436
+ "200": {
437
+ "content": {
438
+ "application/json": {
439
+ "schema": {
440
+ "properties": {
441
+ "success": {
442
+ "description": "Whether the request was cancelled successfully.",
443
+ "type": "boolean"
444
+ }
445
+ },
446
+ "type": "object"
447
+ }
448
+ }
449
+ },
450
+ "description": "The request was cancelled."
451
+ }
452
+ }
453
+ }
454
+ },
455
+ "/bytedance/seedream/v5/lite/edit/requests/{request_id}/status": {
456
+ "get": {
457
+ "parameters": [
458
+ {
459
+ "in": "path",
460
+ "name": "request_id",
461
+ "required": true,
462
+ "schema": {
463
+ "description": "Request ID",
464
+ "type": "string"
465
+ }
466
+ },
467
+ {
468
+ "in": "query",
469
+ "name": "logs",
470
+ "required": false,
471
+ "schema": {
472
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
473
+ "type": "number"
474
+ }
475
+ }
476
+ ],
477
+ "responses": {
478
+ "200": {
479
+ "content": {
480
+ "application/json": {
481
+ "schema": {
482
+ "$ref": "#/components/schemas/QueueStatus"
483
+ }
484
+ }
485
+ },
486
+ "description": "The request status."
487
+ }
488
+ }
489
+ }
490
+ }
491
+ },
492
+ "security": [
493
+ {
494
+ "apiKeyAuth": []
495
+ }
496
+ ],
497
+ "servers": [
498
+ {
499
+ "url": "https://queue.fal.run"
500
+ }
501
+ ]
502
+ }
pipeline/fal_schemas/bytedance__seedream__v5__pro__edit.json ADDED
@@ -0,0 +1,500 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "Image": {
5
+ "description": "Represents an image file.",
6
+ "properties": {
7
+ "content_type": {
8
+ "anyOf": [
9
+ {
10
+ "type": "string"
11
+ },
12
+ {
13
+ "type": "null"
14
+ }
15
+ ],
16
+ "description": "The mime type of the file.",
17
+ "examples": [
18
+ "image/png"
19
+ ],
20
+ "title": "Content Type"
21
+ },
22
+ "file_name": {
23
+ "anyOf": [
24
+ {
25
+ "type": "string"
26
+ },
27
+ {
28
+ "type": "null"
29
+ }
30
+ ],
31
+ "description": "The name of the file. It will be auto-generated if not provided.",
32
+ "examples": [
33
+ "z9RV14K95DvU.png"
34
+ ],
35
+ "title": "File Name"
36
+ },
37
+ "file_size": {
38
+ "anyOf": [
39
+ {
40
+ "type": "integer"
41
+ },
42
+ {
43
+ "type": "null"
44
+ }
45
+ ],
46
+ "description": "The size of the file in bytes.",
47
+ "examples": [
48
+ 4404019
49
+ ],
50
+ "title": "File Size"
51
+ },
52
+ "height": {
53
+ "anyOf": [
54
+ {
55
+ "type": "integer"
56
+ },
57
+ {
58
+ "type": "null"
59
+ }
60
+ ],
61
+ "description": "The height of the image in pixels.",
62
+ "examples": [
63
+ 1024
64
+ ],
65
+ "title": "Height"
66
+ },
67
+ "url": {
68
+ "description": "The URL where the file can be downloaded from.",
69
+ "title": "Url",
70
+ "type": "string"
71
+ },
72
+ "width": {
73
+ "anyOf": [
74
+ {
75
+ "type": "integer"
76
+ },
77
+ {
78
+ "type": "null"
79
+ }
80
+ ],
81
+ "description": "The width of the image in pixels.",
82
+ "examples": [
83
+ 1024
84
+ ],
85
+ "title": "Width"
86
+ }
87
+ },
88
+ "required": [
89
+ "url"
90
+ ],
91
+ "title": "Image",
92
+ "type": "object",
93
+ "x-fal-order-properties": [
94
+ "url",
95
+ "content_type",
96
+ "file_name",
97
+ "file_size",
98
+ "width",
99
+ "height"
100
+ ]
101
+ },
102
+ "ImageSize": {
103
+ "properties": {
104
+ "height": {
105
+ "default": 512,
106
+ "description": "The height of the generated image.",
107
+ "exclusiveMinimum": 0,
108
+ "maximum": 14142,
109
+ "title": "Height",
110
+ "type": "integer"
111
+ },
112
+ "width": {
113
+ "default": 512,
114
+ "description": "The width of the generated image.",
115
+ "exclusiveMinimum": 0,
116
+ "maximum": 14142,
117
+ "title": "Width",
118
+ "type": "integer"
119
+ }
120
+ },
121
+ "title": "ImageSize",
122
+ "type": "object",
123
+ "x-fal-order-properties": [
124
+ "width",
125
+ "height"
126
+ ]
127
+ },
128
+ "QueueStatus": {
129
+ "properties": {
130
+ "cancel_url": {
131
+ "description": "The cancel url.",
132
+ "type": "string"
133
+ },
134
+ "logs": {
135
+ "additionalProperties": true,
136
+ "description": "The logs.",
137
+ "type": "object"
138
+ },
139
+ "metrics": {
140
+ "additionalProperties": true,
141
+ "description": "The metrics.",
142
+ "type": "object"
143
+ },
144
+ "queue_position": {
145
+ "description": "The queue position.",
146
+ "type": "integer"
147
+ },
148
+ "request_id": {
149
+ "description": "The request id.",
150
+ "type": "string"
151
+ },
152
+ "response_url": {
153
+ "description": "The response url.",
154
+ "type": "string"
155
+ },
156
+ "status": {
157
+ "enum": [
158
+ "IN_QUEUE",
159
+ "IN_PROGRESS",
160
+ "COMPLETED"
161
+ ],
162
+ "type": "string"
163
+ },
164
+ "status_url": {
165
+ "description": "The status url.",
166
+ "type": "string"
167
+ }
168
+ },
169
+ "required": [
170
+ "status",
171
+ "request_id"
172
+ ],
173
+ "type": "object"
174
+ },
175
+ "SeedreamV5ProEditInput": {
176
+ "properties": {
177
+ "background": {
178
+ "default": "opaque",
179
+ "description": "Use `transparent` with exactly one alpha-channel reference and PNG output to preserve transparency.",
180
+ "enum": [
181
+ "opaque",
182
+ "transparent"
183
+ ],
184
+ "title": "Background",
185
+ "type": "string"
186
+ },
187
+ "enable_safety_checker": {
188
+ "default": true,
189
+ "description": "If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked.",
190
+ "examples": [
191
+ true
192
+ ],
193
+ "title": "Enable Safety Checker",
194
+ "type": "boolean"
195
+ },
196
+ "enhance_prompt_mode": {
197
+ "default": "standard",
198
+ "description": "Prompt optimization mode. `standard` prioritizes image quality; `fast` reduces generation time.",
199
+ "enum": [
200
+ "standard",
201
+ "fast"
202
+ ],
203
+ "title": "Enhance Prompt Mode",
204
+ "type": "string"
205
+ },
206
+ "image_size": {
207
+ "anyOf": [
208
+ {
209
+ "$ref": "#/components/schemas/ImageSize"
210
+ },
211
+ {
212
+ "enum": [
213
+ "square_hd",
214
+ "square",
215
+ "portrait_4_3",
216
+ "portrait_16_9",
217
+ "landscape_4_3",
218
+ "landscape_16_9",
219
+ "auto_1K",
220
+ "auto_1.5K",
221
+ "auto_2K"
222
+ ],
223
+ "type": "string"
224
+ }
225
+ ],
226
+ "default": "auto_2K",
227
+ "description": "The size of the generated image. Total pixels must be between 921600 and 4624220, with aspect ratio between 1/16 and 16.",
228
+ "examples": [
229
+ "auto_2K"
230
+ ],
231
+ "title": "Image Size",
232
+ "x-fal": {
233
+ "max_area": 4624220,
234
+ "max_aspect_ratio": 16,
235
+ "min_area": 921600,
236
+ "min_aspect_ratio": 0.0625
237
+ }
238
+ },
239
+ "image_urls": {
240
+ "description": "List of URLs of input reference images. Up to 10 images are supported; if more are sent, only the last 10 are used.",
241
+ "examples": [
242
+ [
243
+ "https://storage.googleapis.com/falserverless/example_inputs/seedreamv45/seedream_v45_edit_input_1.png",
244
+ "https://storage.googleapis.com/falserverless/example_inputs/seedreamv45/seedream_v45_edit_input_2.png",
245
+ "https://storage.googleapis.com/falserverless/example_inputs/seedreamv45/seedream_v45_edit_input_3.png"
246
+ ]
247
+ ],
248
+ "items": {
249
+ "type": "string"
250
+ },
251
+ "title": "Image URLs",
252
+ "type": "array"
253
+ },
254
+ "num_images": {
255
+ "default": 1,
256
+ "description": "Number of separate model generations to run with the prompt.",
257
+ "maximum": 6,
258
+ "minimum": 1,
259
+ "title": "Num Images",
260
+ "type": "integer"
261
+ },
262
+ "output_format": {
263
+ "default": "jpeg",
264
+ "description": "The file format of the generated image.",
265
+ "enum": [
266
+ "jpeg",
267
+ "png"
268
+ ],
269
+ "examples": [
270
+ "jpeg"
271
+ ],
272
+ "title": "Output Format",
273
+ "type": "string"
274
+ },
275
+ "prompt": {
276
+ "description": "The text prompt used to edit the image.",
277
+ "examples": [
278
+ "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."
279
+ ],
280
+ "title": "Prompt",
281
+ "type": "string"
282
+ },
283
+ "sync_mode": {
284
+ "default": false,
285
+ "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.",
286
+ "title": "Sync Mode",
287
+ "type": "boolean"
288
+ },
289
+ "watermark": {
290
+ "default": false,
291
+ "description": "Whether to add the provider's visible watermark.",
292
+ "title": "Watermark",
293
+ "type": "boolean"
294
+ }
295
+ },
296
+ "required": [
297
+ "prompt",
298
+ "image_urls"
299
+ ],
300
+ "title": "SeedDream50ProEditInput",
301
+ "type": "object",
302
+ "x-fal-order-properties": [
303
+ "prompt",
304
+ "image_size",
305
+ "num_images",
306
+ "output_format",
307
+ "watermark",
308
+ "sync_mode",
309
+ "enable_safety_checker",
310
+ "background",
311
+ "enhance_prompt_mode",
312
+ "image_urls"
313
+ ]
314
+ },
315
+ "SeedreamV5ProEditOutput": {
316
+ "properties": {
317
+ "images": {
318
+ "description": "Generated images.",
319
+ "examples": [
320
+ [
321
+ {
322
+ "url": "https://v3b.fal.media/files/b/0aa16df4/L8veDBOTxHhmpO5wQnioS_14c2d9c1736b4803a43796669c6d4fca.png"
323
+ }
324
+ ]
325
+ ],
326
+ "items": {
327
+ "$ref": "#/components/schemas/Image"
328
+ },
329
+ "title": "Images",
330
+ "type": "array"
331
+ }
332
+ },
333
+ "required": [
334
+ "images"
335
+ ],
336
+ "title": "SeedDream50ProEditOutput",
337
+ "type": "object",
338
+ "x-fal-order-properties": [
339
+ "images"
340
+ ]
341
+ }
342
+ },
343
+ "securitySchemes": {
344
+ "apiKeyAuth": {
345
+ "description": "Fal Key",
346
+ "in": "header",
347
+ "name": "Authorization",
348
+ "type": "apiKey"
349
+ }
350
+ }
351
+ },
352
+ "info": {
353
+ "description": "The OpenAPI schema for the bytedance/seedream/v5/pro/edit queue.",
354
+ "title": "Queue OpenAPI for bytedance/seedream/v5/pro/edit",
355
+ "version": "1.0.0",
356
+ "x-fal-metadata": {
357
+ "about": "Edit images using Bytedance's Seedream 5.0 Pro model.",
358
+ "category": "image-to-image",
359
+ "documentationUrl": "https://fal.ai/models/bytedance/seedream/v5/pro/edit/api",
360
+ "endpointId": "bytedance/seedream/v5/pro/edit",
361
+ "playgroundUrl": "https://fal.ai/models/bytedance/seedream/v5/pro/edit",
362
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0aa15606/l4xYHHjF6aMrdoonScgXK.jpg"
363
+ }
364
+ },
365
+ "openapi": "3.1.0",
366
+ "paths": {
367
+ "/bytedance/seedream/v5/pro/edit": {
368
+ "post": {
369
+ "requestBody": {
370
+ "content": {
371
+ "application/json": {
372
+ "schema": {
373
+ "$ref": "#/components/schemas/SeedreamV5ProEditInput"
374
+ }
375
+ }
376
+ },
377
+ "required": true
378
+ },
379
+ "responses": {
380
+ "200": {
381
+ "content": {
382
+ "application/json": {
383
+ "schema": {
384
+ "$ref": "#/components/schemas/QueueStatus"
385
+ }
386
+ }
387
+ },
388
+ "description": "The request status."
389
+ }
390
+ }
391
+ }
392
+ },
393
+ "/bytedance/seedream/v5/pro/edit/requests/{request_id}": {
394
+ "get": {
395
+ "parameters": [
396
+ {
397
+ "in": "path",
398
+ "name": "request_id",
399
+ "required": true,
400
+ "schema": {
401
+ "description": "Request ID",
402
+ "type": "string"
403
+ }
404
+ }
405
+ ],
406
+ "responses": {
407
+ "200": {
408
+ "content": {
409
+ "application/json": {
410
+ "schema": {
411
+ "$ref": "#/components/schemas/SeedreamV5ProEditOutput"
412
+ }
413
+ }
414
+ },
415
+ "description": "Result of the request."
416
+ }
417
+ }
418
+ }
419
+ },
420
+ "/bytedance/seedream/v5/pro/edit/requests/{request_id}/cancel": {
421
+ "put": {
422
+ "parameters": [
423
+ {
424
+ "in": "path",
425
+ "name": "request_id",
426
+ "required": true,
427
+ "schema": {
428
+ "description": "Request ID",
429
+ "type": "string"
430
+ }
431
+ }
432
+ ],
433
+ "responses": {
434
+ "200": {
435
+ "content": {
436
+ "application/json": {
437
+ "schema": {
438
+ "properties": {
439
+ "success": {
440
+ "description": "Whether the request was cancelled successfully.",
441
+ "type": "boolean"
442
+ }
443
+ },
444
+ "type": "object"
445
+ }
446
+ }
447
+ },
448
+ "description": "The request was cancelled."
449
+ }
450
+ }
451
+ }
452
+ },
453
+ "/bytedance/seedream/v5/pro/edit/requests/{request_id}/status": {
454
+ "get": {
455
+ "parameters": [
456
+ {
457
+ "in": "path",
458
+ "name": "request_id",
459
+ "required": true,
460
+ "schema": {
461
+ "description": "Request ID",
462
+ "type": "string"
463
+ }
464
+ },
465
+ {
466
+ "in": "query",
467
+ "name": "logs",
468
+ "required": false,
469
+ "schema": {
470
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
471
+ "type": "number"
472
+ }
473
+ }
474
+ ],
475
+ "responses": {
476
+ "200": {
477
+ "content": {
478
+ "application/json": {
479
+ "schema": {
480
+ "$ref": "#/components/schemas/QueueStatus"
481
+ }
482
+ }
483
+ },
484
+ "description": "The request status."
485
+ }
486
+ }
487
+ }
488
+ }
489
+ },
490
+ "security": [
491
+ {
492
+ "apiKeyAuth": []
493
+ }
494
+ ],
495
+ "servers": [
496
+ {
497
+ "url": "https://queue.fal.run"
498
+ }
499
+ ]
500
+ }
pipeline/fal_schemas/fal-ai__kling-image__o1.json ADDED
@@ -0,0 +1,539 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "ElementInput": {
5
+ "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.",
6
+ "properties": {
7
+ "frontal_image_url": {
8
+ "anyOf": [
9
+ {
10
+ "_fal_ui_field": "image",
11
+ "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",
12
+ "type": "string",
13
+ "ui": {
14
+ "field": "image"
15
+ },
16
+ "x-fal": {
17
+ "max_aspect_ratio": 2.5,
18
+ "max_file_size": 10485760,
19
+ "min_aspect_ratio": 0.4,
20
+ "min_height": 300,
21
+ "min_width": 300,
22
+ "timeout": 20
23
+ }
24
+ },
25
+ {
26
+ "type": "null"
27
+ }
28
+ ],
29
+ "description": "The frontal image of the element (main view). Optional.",
30
+ "title": "Frontal Image Url"
31
+ },
32
+ "reference_image_urls": {
33
+ "anyOf": [
34
+ {
35
+ "items": {
36
+ "_fal_ui_field": "image",
37
+ "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",
38
+ "type": "string",
39
+ "ui": {
40
+ "field": "image"
41
+ },
42
+ "x-fal": {
43
+ "max_aspect_ratio": 2.5,
44
+ "max_file_size": 10485760,
45
+ "min_aspect_ratio": 0.4,
46
+ "min_height": 300,
47
+ "min_width": 300,
48
+ "timeout": 20
49
+ }
50
+ },
51
+ "type": "array"
52
+ },
53
+ {
54
+ "type": "null"
55
+ }
56
+ ],
57
+ "description": "Additional reference images from different angles. 0-3 images supported. Optional.",
58
+ "title": "Reference Image Urls"
59
+ }
60
+ },
61
+ "title": "ElementInput",
62
+ "type": "object",
63
+ "x-fal-order-properties": [
64
+ "frontal_image_url",
65
+ "reference_image_urls"
66
+ ]
67
+ },
68
+ "Image": {
69
+ "description": "Represents an image file.",
70
+ "properties": {
71
+ "content_type": {
72
+ "anyOf": [
73
+ {
74
+ "type": "string"
75
+ },
76
+ {
77
+ "type": "null"
78
+ }
79
+ ],
80
+ "description": "The mime type of the file.",
81
+ "examples": [
82
+ "image/png"
83
+ ],
84
+ "title": "Content Type"
85
+ },
86
+ "file_name": {
87
+ "anyOf": [
88
+ {
89
+ "type": "string"
90
+ },
91
+ {
92
+ "type": "null"
93
+ }
94
+ ],
95
+ "description": "The name of the file. It will be auto-generated if not provided.",
96
+ "examples": [
97
+ "z9RV14K95DvU.png"
98
+ ],
99
+ "title": "File Name"
100
+ },
101
+ "file_size": {
102
+ "anyOf": [
103
+ {
104
+ "type": "integer"
105
+ },
106
+ {
107
+ "type": "null"
108
+ }
109
+ ],
110
+ "description": "The size of the file in bytes.",
111
+ "examples": [
112
+ 4404019
113
+ ],
114
+ "title": "File Size"
115
+ },
116
+ "height": {
117
+ "anyOf": [
118
+ {
119
+ "type": "integer"
120
+ },
121
+ {
122
+ "type": "null"
123
+ }
124
+ ],
125
+ "description": "The height of the image in pixels.",
126
+ "examples": [
127
+ 1024
128
+ ],
129
+ "title": "Height"
130
+ },
131
+ "url": {
132
+ "description": "The URL where the file can be downloaded from.",
133
+ "title": "Url",
134
+ "type": "string"
135
+ },
136
+ "width": {
137
+ "anyOf": [
138
+ {
139
+ "type": "integer"
140
+ },
141
+ {
142
+ "type": "null"
143
+ }
144
+ ],
145
+ "description": "The width of the image in pixels.",
146
+ "examples": [
147
+ 1024
148
+ ],
149
+ "title": "Width"
150
+ }
151
+ },
152
+ "required": [
153
+ "url"
154
+ ],
155
+ "title": "Image",
156
+ "type": "object",
157
+ "x-fal-order-properties": [
158
+ "url",
159
+ "content_type",
160
+ "file_name",
161
+ "file_size",
162
+ "width",
163
+ "height"
164
+ ]
165
+ },
166
+ "KlingImageO1Input": {
167
+ "description": "Request model for Kling O1 Omni Image (legacy).",
168
+ "properties": {
169
+ "aspect_ratio": {
170
+ "default": "auto",
171
+ "description": "Aspect ratio of generated images. 'auto' intelligently determines based on input content.",
172
+ "enum": [
173
+ "auto",
174
+ "16:9",
175
+ "9:16",
176
+ "1:1",
177
+ "4:3",
178
+ "3:4",
179
+ "3:2",
180
+ "2:3",
181
+ "21:9"
182
+ ],
183
+ "title": "Aspect Ratio",
184
+ "type": "string"
185
+ },
186
+ "elements": {
187
+ "anyOf": [
188
+ {
189
+ "items": {
190
+ "$ref": "#/components/schemas/ElementInput"
191
+ },
192
+ "type": "array"
193
+ },
194
+ {
195
+ "type": "null"
196
+ }
197
+ ],
198
+ "description": "Elements (characters/objects) to include in the image. Reference in prompt as @Element1, @Element2, etc. Maximum 10 total (elements + reference images).",
199
+ "examples": [
200
+ [
201
+ {
202
+ "frontal_image_url": "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/element-1-front.png",
203
+ "reference_image_urls": [
204
+ "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/element-1-reference.png"
205
+ ]
206
+ }
207
+ ]
208
+ ],
209
+ "title": "Elements"
210
+ },
211
+ "enable_safety_checker": {
212
+ "default": true,
213
+ "description": "Authorized callers may set false to request relaxed screening.",
214
+ "title": "Enable Safety Checker",
215
+ "type": "boolean"
216
+ },
217
+ "image_urls": {
218
+ "description": "List of reference images. Reference images in prompt using @Image1, @Image2, etc. (1-indexed). Max 10 images.",
219
+ "examples": [
220
+ [
221
+ "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/input.png",
222
+ "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/input-2.png"
223
+ ]
224
+ ],
225
+ "items": {
226
+ "_fal_ui_field": "image",
227
+ "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",
228
+ "type": "string",
229
+ "x-fal": {
230
+ "max_aspect_ratio": 2.5,
231
+ "max_file_size": 10485760,
232
+ "min_aspect_ratio": 0.4,
233
+ "min_height": 300,
234
+ "min_width": 300,
235
+ "timeout": 20
236
+ }
237
+ },
238
+ "title": "Image Urls",
239
+ "type": "array"
240
+ },
241
+ "num_images": {
242
+ "default": 1,
243
+ "description": "Number of images to generate (1-9).",
244
+ "maximum": 9,
245
+ "minimum": 1,
246
+ "title": "Num Images",
247
+ "type": "integer"
248
+ },
249
+ "output_format": {
250
+ "default": "png",
251
+ "description": "The format of the generated image.",
252
+ "enum": [
253
+ "jpeg",
254
+ "png",
255
+ "webp"
256
+ ],
257
+ "title": "Output Format",
258
+ "type": "string"
259
+ },
260
+ "prompt": {
261
+ "description": "Text prompt for image generation. Reference images using @Image1, @Image2, etc. (or @Image if only one image). Max 2500 characters.",
262
+ "examples": [
263
+ "Put @Image1 to the back seat of the car in @Image2, put @Element1 on to the @Image1"
264
+ ],
265
+ "maxLength": 2500,
266
+ "title": "Prompt",
267
+ "type": "string"
268
+ },
269
+ "resolution": {
270
+ "default": "1K",
271
+ "description": "Image generation resolution. 1K: standard, 2K: high-res.",
272
+ "enum": [
273
+ "1K",
274
+ "2K"
275
+ ],
276
+ "title": "Resolution",
277
+ "type": "string"
278
+ },
279
+ "sync_mode": {
280
+ "default": false,
281
+ "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.",
282
+ "title": "Sync Mode",
283
+ "type": "boolean"
284
+ }
285
+ },
286
+ "required": [
287
+ "prompt",
288
+ "image_urls"
289
+ ],
290
+ "title": "OmniImageRequest",
291
+ "type": "object",
292
+ "x-fal-order-properties": [
293
+ "prompt",
294
+ "image_urls",
295
+ "elements",
296
+ "resolution",
297
+ "num_images",
298
+ "aspect_ratio",
299
+ "output_format",
300
+ "sync_mode",
301
+ "enable_safety_checker"
302
+ ]
303
+ },
304
+ "KlingImageO1Output": {
305
+ "properties": {
306
+ "images": {
307
+ "description": "Generated images",
308
+ "examples": [
309
+ [
310
+ {
311
+ "content_type": "image/png",
312
+ "file_name": "d4eeaeaeae294a41b0321ba6c99f0f9d.png",
313
+ "file_size": 1419818,
314
+ "url": "https://storage.googleapis.com/falserverless/example_outputs/kling-image-o1/output.png"
315
+ }
316
+ ]
317
+ ],
318
+ "items": {
319
+ "$ref": "#/components/schemas/Image"
320
+ },
321
+ "title": "Images",
322
+ "type": "array"
323
+ }
324
+ },
325
+ "required": [
326
+ "images"
327
+ ],
328
+ "title": "OmniImageOutput",
329
+ "type": "object",
330
+ "x-fal-order-properties": [
331
+ "images"
332
+ ]
333
+ },
334
+ "QueueStatus": {
335
+ "properties": {
336
+ "cancel_url": {
337
+ "description": "The cancel url.",
338
+ "type": "string"
339
+ },
340
+ "logs": {
341
+ "additionalProperties": true,
342
+ "description": "The logs.",
343
+ "type": "object"
344
+ },
345
+ "metrics": {
346
+ "additionalProperties": true,
347
+ "description": "The metrics.",
348
+ "type": "object"
349
+ },
350
+ "queue_position": {
351
+ "description": "The queue position.",
352
+ "type": "integer"
353
+ },
354
+ "request_id": {
355
+ "description": "The request id.",
356
+ "type": "string"
357
+ },
358
+ "response_url": {
359
+ "description": "The response url.",
360
+ "type": "string"
361
+ },
362
+ "status": {
363
+ "enum": [
364
+ "IN_QUEUE",
365
+ "IN_PROGRESS",
366
+ "COMPLETED"
367
+ ],
368
+ "type": "string"
369
+ },
370
+ "status_url": {
371
+ "description": "The status url.",
372
+ "type": "string"
373
+ }
374
+ },
375
+ "required": [
376
+ "status",
377
+ "request_id"
378
+ ],
379
+ "type": "object"
380
+ }
381
+ },
382
+ "securitySchemes": {
383
+ "apiKeyAuth": {
384
+ "description": "Fal Key",
385
+ "in": "header",
386
+ "name": "Authorization",
387
+ "type": "apiKey"
388
+ }
389
+ }
390
+ },
391
+ "info": {
392
+ "description": "The OpenAPI schema for the fal-ai/kling-image/o1 queue.",
393
+ "title": "Queue OpenAPI for fal-ai/kling-image/o1",
394
+ "version": "1.0.0",
395
+ "x-fal-metadata": {
396
+ "about": "Generate images using Kling O1 model.",
397
+ "category": "image-to-image",
398
+ "documentationUrl": "https://fal.ai/models/fal-ai/kling-image/o1/api",
399
+ "endpointId": "fal-ai/kling-image/o1",
400
+ "playgroundUrl": "https://fal.ai/models/fal-ai/kling-image/o1",
401
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0a8495e0/GVuCh0RsGXpLIlUsJMrNX_f4fe5943ad804aaab441629241777417.jpg"
402
+ }
403
+ },
404
+ "openapi": "3.1.0",
405
+ "paths": {
406
+ "/fal-ai/kling-image/o1": {
407
+ "post": {
408
+ "requestBody": {
409
+ "content": {
410
+ "application/json": {
411
+ "schema": {
412
+ "$ref": "#/components/schemas/KlingImageO1Input"
413
+ }
414
+ }
415
+ },
416
+ "required": true
417
+ },
418
+ "responses": {
419
+ "200": {
420
+ "content": {
421
+ "application/json": {
422
+ "schema": {
423
+ "$ref": "#/components/schemas/QueueStatus"
424
+ }
425
+ }
426
+ },
427
+ "description": "The request status."
428
+ }
429
+ }
430
+ }
431
+ },
432
+ "/fal-ai/kling-image/o1/requests/{request_id}": {
433
+ "get": {
434
+ "parameters": [
435
+ {
436
+ "in": "path",
437
+ "name": "request_id",
438
+ "required": true,
439
+ "schema": {
440
+ "description": "Request ID",
441
+ "type": "string"
442
+ }
443
+ }
444
+ ],
445
+ "responses": {
446
+ "200": {
447
+ "content": {
448
+ "application/json": {
449
+ "schema": {
450
+ "$ref": "#/components/schemas/KlingImageO1Output"
451
+ }
452
+ }
453
+ },
454
+ "description": "Result of the request."
455
+ }
456
+ }
457
+ }
458
+ },
459
+ "/fal-ai/kling-image/o1/requests/{request_id}/cancel": {
460
+ "put": {
461
+ "parameters": [
462
+ {
463
+ "in": "path",
464
+ "name": "request_id",
465
+ "required": true,
466
+ "schema": {
467
+ "description": "Request ID",
468
+ "type": "string"
469
+ }
470
+ }
471
+ ],
472
+ "responses": {
473
+ "200": {
474
+ "content": {
475
+ "application/json": {
476
+ "schema": {
477
+ "properties": {
478
+ "success": {
479
+ "description": "Whether the request was cancelled successfully.",
480
+ "type": "boolean"
481
+ }
482
+ },
483
+ "type": "object"
484
+ }
485
+ }
486
+ },
487
+ "description": "The request was cancelled."
488
+ }
489
+ }
490
+ }
491
+ },
492
+ "/fal-ai/kling-image/o1/requests/{request_id}/status": {
493
+ "get": {
494
+ "parameters": [
495
+ {
496
+ "in": "path",
497
+ "name": "request_id",
498
+ "required": true,
499
+ "schema": {
500
+ "description": "Request ID",
501
+ "type": "string"
502
+ }
503
+ },
504
+ {
505
+ "in": "query",
506
+ "name": "logs",
507
+ "required": false,
508
+ "schema": {
509
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
510
+ "type": "number"
511
+ }
512
+ }
513
+ ],
514
+ "responses": {
515
+ "200": {
516
+ "content": {
517
+ "application/json": {
518
+ "schema": {
519
+ "$ref": "#/components/schemas/QueueStatus"
520
+ }
521
+ }
522
+ },
523
+ "description": "The request status."
524
+ }
525
+ }
526
+ }
527
+ }
528
+ },
529
+ "security": [
530
+ {
531
+ "apiKeyAuth": []
532
+ }
533
+ ],
534
+ "servers": [
535
+ {
536
+ "url": "https://queue.fal.run"
537
+ }
538
+ ]
539
+ }
pipeline/fal_schemas/fal-ai__kling-image__o3__image-to-image.json ADDED
@@ -0,0 +1,556 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "ElementInput": {
5
+ "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.",
6
+ "properties": {
7
+ "frontal_image_url": {
8
+ "anyOf": [
9
+ {
10
+ "_fal_ui_field": "image",
11
+ "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",
12
+ "type": "string",
13
+ "ui": {
14
+ "field": "image"
15
+ },
16
+ "x-fal": {
17
+ "max_aspect_ratio": 2.5,
18
+ "max_file_size": 10485760,
19
+ "min_aspect_ratio": 0.4,
20
+ "min_height": 300,
21
+ "min_width": 300,
22
+ "timeout": 20
23
+ }
24
+ },
25
+ {
26
+ "type": "null"
27
+ }
28
+ ],
29
+ "description": "The frontal image of the element (main view). Optional.",
30
+ "title": "Frontal Image Url"
31
+ },
32
+ "reference_image_urls": {
33
+ "anyOf": [
34
+ {
35
+ "items": {
36
+ "_fal_ui_field": "image",
37
+ "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",
38
+ "type": "string",
39
+ "ui": {
40
+ "field": "image"
41
+ },
42
+ "x-fal": {
43
+ "max_aspect_ratio": 2.5,
44
+ "max_file_size": 10485760,
45
+ "min_aspect_ratio": 0.4,
46
+ "min_height": 300,
47
+ "min_width": 300,
48
+ "timeout": 20
49
+ }
50
+ },
51
+ "type": "array"
52
+ },
53
+ {
54
+ "type": "null"
55
+ }
56
+ ],
57
+ "description": "Additional reference images from different angles. 0-3 images supported. Optional.",
58
+ "title": "Reference Image Urls"
59
+ }
60
+ },
61
+ "title": "ElementInput",
62
+ "type": "object",
63
+ "x-fal-order-properties": [
64
+ "frontal_image_url",
65
+ "reference_image_urls"
66
+ ]
67
+ },
68
+ "Image": {
69
+ "description": "Represents an image file.",
70
+ "properties": {
71
+ "content_type": {
72
+ "anyOf": [
73
+ {
74
+ "type": "string"
75
+ },
76
+ {
77
+ "type": "null"
78
+ }
79
+ ],
80
+ "description": "The mime type of the file.",
81
+ "examples": [
82
+ "image/png"
83
+ ],
84
+ "title": "Content Type"
85
+ },
86
+ "file_name": {
87
+ "anyOf": [
88
+ {
89
+ "type": "string"
90
+ },
91
+ {
92
+ "type": "null"
93
+ }
94
+ ],
95
+ "description": "The name of the file. It will be auto-generated if not provided.",
96
+ "examples": [
97
+ "z9RV14K95DvU.png"
98
+ ],
99
+ "title": "File Name"
100
+ },
101
+ "file_size": {
102
+ "anyOf": [
103
+ {
104
+ "type": "integer"
105
+ },
106
+ {
107
+ "type": "null"
108
+ }
109
+ ],
110
+ "description": "The size of the file in bytes.",
111
+ "examples": [
112
+ 4404019
113
+ ],
114
+ "title": "File Size"
115
+ },
116
+ "height": {
117
+ "anyOf": [
118
+ {
119
+ "type": "integer"
120
+ },
121
+ {
122
+ "type": "null"
123
+ }
124
+ ],
125
+ "description": "The height of the image in pixels.",
126
+ "examples": [
127
+ 1024
128
+ ],
129
+ "title": "Height"
130
+ },
131
+ "url": {
132
+ "description": "The URL where the file can be downloaded from.",
133
+ "title": "Url",
134
+ "type": "string"
135
+ },
136
+ "width": {
137
+ "anyOf": [
138
+ {
139
+ "type": "integer"
140
+ },
141
+ {
142
+ "type": "null"
143
+ }
144
+ ],
145
+ "description": "The width of the image in pixels.",
146
+ "examples": [
147
+ 1024
148
+ ],
149
+ "title": "Width"
150
+ }
151
+ },
152
+ "required": [
153
+ "url"
154
+ ],
155
+ "title": "Image",
156
+ "type": "object",
157
+ "x-fal-order-properties": [
158
+ "url",
159
+ "content_type",
160
+ "file_name",
161
+ "file_size",
162
+ "width",
163
+ "height"
164
+ ]
165
+ },
166
+ "KlingImageO3ImageToImageInput": {
167
+ "description": "Request model for Kling O3 Image-to-Image Generation.",
168
+ "properties": {
169
+ "aspect_ratio": {
170
+ "default": "auto",
171
+ "description": "Aspect ratio of generated images. 'auto' intelligently determines based on input content.",
172
+ "enum": [
173
+ "16:9",
174
+ "9:16",
175
+ "1:1",
176
+ "4:3",
177
+ "3:4",
178
+ "3:2",
179
+ "2:3",
180
+ "21:9",
181
+ "auto"
182
+ ],
183
+ "title": "Aspect Ratio",
184
+ "type": "string"
185
+ },
186
+ "elements": {
187
+ "anyOf": [
188
+ {
189
+ "items": {
190
+ "$ref": "#/components/schemas/ElementInput"
191
+ },
192
+ "type": "array"
193
+ },
194
+ {
195
+ "type": "null"
196
+ }
197
+ ],
198
+ "description": "Optional: Elements (characters/objects) for face control. Reference in prompt as @Element1, @Element2, etc.",
199
+ "title": "Elements"
200
+ },
201
+ "enable_safety_checker": {
202
+ "default": true,
203
+ "description": "Authorized callers may set false to request relaxed screening.",
204
+ "title": "Enable Safety Checker",
205
+ "type": "boolean"
206
+ },
207
+ "image_urls": {
208
+ "description": "List of reference images. Reference images in prompt using @Image1, @Image2, etc. (1-indexed). Max 10 images.",
209
+ "examples": [
210
+ [
211
+ "https://v3b.fal.media/files/b/0a8d06d1/FTrwBsV9WI5twqMPkqvRh_19db9852c5ed4a109d81c52d27c9e433.png"
212
+ ]
213
+ ],
214
+ "items": {
215
+ "_fal_ui_field": "image",
216
+ "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",
217
+ "type": "string",
218
+ "x-fal": {
219
+ "max_aspect_ratio": 2.5,
220
+ "max_file_size": 10485760,
221
+ "min_aspect_ratio": 0.4,
222
+ "min_height": 300,
223
+ "min_width": 300,
224
+ "timeout": 20
225
+ }
226
+ },
227
+ "title": "Image Urls",
228
+ "type": "array"
229
+ },
230
+ "num_images": {
231
+ "default": 1,
232
+ "description": "Number of images to generate (1-9). Only used when result_type is 'single'.",
233
+ "maximum": 9,
234
+ "minimum": 1,
235
+ "title": "Num Images",
236
+ "type": "integer"
237
+ },
238
+ "output_format": {
239
+ "default": "png",
240
+ "description": "The format of the generated image.",
241
+ "enum": [
242
+ "jpeg",
243
+ "png",
244
+ "webp"
245
+ ],
246
+ "title": "Output Format",
247
+ "type": "string"
248
+ },
249
+ "prompt": {
250
+ "description": "Text prompt for image generation. Reference images using @Image1, @Image2, etc. (or @Image if only one image). Max 2500 characters.",
251
+ "examples": [
252
+ "Transform into photorealistic 3D render, add proper lighting and shadows, realistic materials and textures, maintain exact proportions and design from sketch, product visualization quality"
253
+ ],
254
+ "maxLength": 2500,
255
+ "title": "Prompt",
256
+ "type": "string"
257
+ },
258
+ "resolution": {
259
+ "default": "1K",
260
+ "description": "Image generation resolution. 1K: standard, 2K: high-res, 4K: ultra high-res.",
261
+ "enum": [
262
+ "1K",
263
+ "2K",
264
+ "4K"
265
+ ],
266
+ "title": "Resolution",
267
+ "type": "string"
268
+ },
269
+ "result_type": {
270
+ "default": "single",
271
+ "description": "Result type. 'single' for one image, 'series' for a series of related images.",
272
+ "enum": [
273
+ "single",
274
+ "series"
275
+ ],
276
+ "title": "Result Type",
277
+ "type": "string"
278
+ },
279
+ "series_amount": {
280
+ "anyOf": [
281
+ {
282
+ "maximum": 9,
283
+ "minimum": 2,
284
+ "type": "integer"
285
+ },
286
+ {
287
+ "type": "null"
288
+ }
289
+ ],
290
+ "description": "Number of images in series (2-9). Only used when result_type is 'series'.",
291
+ "title": "Series Amount"
292
+ },
293
+ "sync_mode": {
294
+ "default": false,
295
+ "description": "If `True`, the media will be returned as a data URI.",
296
+ "title": "Sync Mode",
297
+ "type": "boolean"
298
+ }
299
+ },
300
+ "required": [
301
+ "prompt",
302
+ "image_urls"
303
+ ],
304
+ "title": "O3ImageToImageRequest",
305
+ "type": "object",
306
+ "x-fal-order-properties": [
307
+ "prompt",
308
+ "image_urls",
309
+ "elements",
310
+ "resolution",
311
+ "result_type",
312
+ "num_images",
313
+ "series_amount",
314
+ "aspect_ratio",
315
+ "output_format",
316
+ "sync_mode",
317
+ "enable_safety_checker"
318
+ ]
319
+ },
320
+ "KlingImageO3ImageToImageOutput": {
321
+ "description": "Output model for Kling O3 Image Generation.",
322
+ "properties": {
323
+ "images": {
324
+ "description": "Generated images",
325
+ "examples": [
326
+ [
327
+ {
328
+ "content_type": "image/png",
329
+ "file_name": "19db9852c5ed4a109d81c52d27c9e433.png",
330
+ "file_size": 793847,
331
+ "url": "https://v3b.fal.media/files/b/0a8d06d1/FTrwBsV9WI5twqMPkqvRh_19db9852c5ed4a109d81c52d27c9e433.png"
332
+ }
333
+ ]
334
+ ],
335
+ "items": {
336
+ "$ref": "#/components/schemas/Image"
337
+ },
338
+ "title": "Images",
339
+ "type": "array"
340
+ }
341
+ },
342
+ "required": [
343
+ "images"
344
+ ],
345
+ "title": "I2IO3ImageOutput",
346
+ "type": "object",
347
+ "x-fal-order-properties": [
348
+ "images"
349
+ ]
350
+ },
351
+ "QueueStatus": {
352
+ "properties": {
353
+ "cancel_url": {
354
+ "description": "The cancel url.",
355
+ "type": "string"
356
+ },
357
+ "logs": {
358
+ "additionalProperties": true,
359
+ "description": "The logs.",
360
+ "type": "object"
361
+ },
362
+ "metrics": {
363
+ "additionalProperties": true,
364
+ "description": "The metrics.",
365
+ "type": "object"
366
+ },
367
+ "queue_position": {
368
+ "description": "The queue position.",
369
+ "type": "integer"
370
+ },
371
+ "request_id": {
372
+ "description": "The request id.",
373
+ "type": "string"
374
+ },
375
+ "response_url": {
376
+ "description": "The response url.",
377
+ "type": "string"
378
+ },
379
+ "status": {
380
+ "enum": [
381
+ "IN_QUEUE",
382
+ "IN_PROGRESS",
383
+ "COMPLETED"
384
+ ],
385
+ "type": "string"
386
+ },
387
+ "status_url": {
388
+ "description": "The status url.",
389
+ "type": "string"
390
+ }
391
+ },
392
+ "required": [
393
+ "status",
394
+ "request_id"
395
+ ],
396
+ "type": "object"
397
+ }
398
+ },
399
+ "securitySchemes": {
400
+ "apiKeyAuth": {
401
+ "description": "Fal Key",
402
+ "in": "header",
403
+ "name": "Authorization",
404
+ "type": "apiKey"
405
+ }
406
+ }
407
+ },
408
+ "info": {
409
+ "description": "The OpenAPI schema for the fal-ai/kling-image/o3/image-to-image queue.",
410
+ "title": "Queue OpenAPI for fal-ai/kling-image/o3/image-to-image",
411
+ "version": "1.0.0",
412
+ "x-fal-metadata": {
413
+ "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)",
414
+ "category": "image-to-image",
415
+ "documentationUrl": "https://fal.ai/models/fal-ai/kling-image/o3/image-to-image/api",
416
+ "endpointId": "fal-ai/kling-image/o3/image-to-image",
417
+ "playgroundUrl": "https://fal.ai/models/fal-ai/kling-image/o3/image-to-image",
418
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0a8d24a0/FX4gbFjRsBJPDJ2WkPMFa_9f3aa39f5fd84be395b5ce3dee7e4dd1.jpg"
419
+ }
420
+ },
421
+ "openapi": "3.1.0",
422
+ "paths": {
423
+ "/fal-ai/kling-image/o3/image-to-image": {
424
+ "post": {
425
+ "requestBody": {
426
+ "content": {
427
+ "application/json": {
428
+ "schema": {
429
+ "$ref": "#/components/schemas/KlingImageO3ImageToImageInput"
430
+ }
431
+ }
432
+ },
433
+ "required": true
434
+ },
435
+ "responses": {
436
+ "200": {
437
+ "content": {
438
+ "application/json": {
439
+ "schema": {
440
+ "$ref": "#/components/schemas/QueueStatus"
441
+ }
442
+ }
443
+ },
444
+ "description": "The request status."
445
+ }
446
+ }
447
+ }
448
+ },
449
+ "/fal-ai/kling-image/o3/image-to-image/requests/{request_id}": {
450
+ "get": {
451
+ "parameters": [
452
+ {
453
+ "in": "path",
454
+ "name": "request_id",
455
+ "required": true,
456
+ "schema": {
457
+ "description": "Request ID",
458
+ "type": "string"
459
+ }
460
+ }
461
+ ],
462
+ "responses": {
463
+ "200": {
464
+ "content": {
465
+ "application/json": {
466
+ "schema": {
467
+ "$ref": "#/components/schemas/KlingImageO3ImageToImageOutput"
468
+ }
469
+ }
470
+ },
471
+ "description": "Result of the request."
472
+ }
473
+ }
474
+ }
475
+ },
476
+ "/fal-ai/kling-image/o3/image-to-image/requests/{request_id}/cancel": {
477
+ "put": {
478
+ "parameters": [
479
+ {
480
+ "in": "path",
481
+ "name": "request_id",
482
+ "required": true,
483
+ "schema": {
484
+ "description": "Request ID",
485
+ "type": "string"
486
+ }
487
+ }
488
+ ],
489
+ "responses": {
490
+ "200": {
491
+ "content": {
492
+ "application/json": {
493
+ "schema": {
494
+ "properties": {
495
+ "success": {
496
+ "description": "Whether the request was cancelled successfully.",
497
+ "type": "boolean"
498
+ }
499
+ },
500
+ "type": "object"
501
+ }
502
+ }
503
+ },
504
+ "description": "The request was cancelled."
505
+ }
506
+ }
507
+ }
508
+ },
509
+ "/fal-ai/kling-image/o3/image-to-image/requests/{request_id}/status": {
510
+ "get": {
511
+ "parameters": [
512
+ {
513
+ "in": "path",
514
+ "name": "request_id",
515
+ "required": true,
516
+ "schema": {
517
+ "description": "Request ID",
518
+ "type": "string"
519
+ }
520
+ },
521
+ {
522
+ "in": "query",
523
+ "name": "logs",
524
+ "required": false,
525
+ "schema": {
526
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
527
+ "type": "number"
528
+ }
529
+ }
530
+ ],
531
+ "responses": {
532
+ "200": {
533
+ "content": {
534
+ "application/json": {
535
+ "schema": {
536
+ "$ref": "#/components/schemas/QueueStatus"
537
+ }
538
+ }
539
+ },
540
+ "description": "The request status."
541
+ }
542
+ }
543
+ }
544
+ }
545
+ },
546
+ "security": [
547
+ {
548
+ "apiKeyAuth": []
549
+ }
550
+ ],
551
+ "servers": [
552
+ {
553
+ "url": "https://queue.fal.run"
554
+ }
555
+ ]
556
+ }
pipeline/fal_schemas/fal-ai__nano-banana-2__edit.json ADDED
@@ -0,0 +1 @@
 
 
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":[]}]}
pipeline/fal_schemas/fal-ai__nano-banana-pro__edit.json ADDED
@@ -0,0 +1,1085 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "GeminiAudioPart": {
5
+ "additionalProperties": false,
6
+ "properties": {
7
+ "audio_url": {
8
+ "description": "Original audio URL or data URI from a previous Flash Image request (up to 15 MB).",
9
+ "title": "Audio Url",
10
+ "type": "string"
11
+ },
12
+ "thought": {
13
+ "anyOf": [
14
+ {
15
+ "type": "boolean"
16
+ },
17
+ {
18
+ "type": "null"
19
+ }
20
+ ],
21
+ "description": "Provider thought marker, preserved when replaying a returned conversation.",
22
+ "title": "Thought"
23
+ },
24
+ "thought_signature": {
25
+ "anyOf": [
26
+ {
27
+ "minLength": 1,
28
+ "type": "string"
29
+ },
30
+ {
31
+ "type": "null"
32
+ }
33
+ ],
34
+ "description": "Opaque provider-issued thought signature. Replay it unchanged on its original part.",
35
+ "title": "Thought Signature"
36
+ },
37
+ "type": {
38
+ "const": "audio",
39
+ "description": "The audio part discriminator.",
40
+ "title": "Type",
41
+ "type": "string"
42
+ }
43
+ },
44
+ "required": [
45
+ "type",
46
+ "audio_url"
47
+ ],
48
+ "title": "GeminiAudioPart",
49
+ "type": "object",
50
+ "x-fal-order-properties": [
51
+ "thought",
52
+ "thought_signature",
53
+ "type",
54
+ "audio_url"
55
+ ]
56
+ },
57
+ "GeminiConversation": {
58
+ "properties": {
59
+ "messages": {
60
+ "description": "One complete provider conversation. Pass messages as history in the next request, retaining every signature and part.",
61
+ "items": {
62
+ "$ref": "#/components/schemas/GeminiVideoMessage"
63
+ },
64
+ "title": "Messages",
65
+ "type": "array"
66
+ }
67
+ },
68
+ "required": [
69
+ "messages"
70
+ ],
71
+ "title": "GeminiConversation",
72
+ "type": "object",
73
+ "x-fal-order-properties": [
74
+ "messages"
75
+ ]
76
+ },
77
+ "GeminiDocumentPart": {
78
+ "additionalProperties": false,
79
+ "properties": {
80
+ "file_url": {
81
+ "description": "PDF or UTF-8 plain-text document URL or data URI (up to 15 MB).",
82
+ "title": "File Url",
83
+ "type": "string"
84
+ },
85
+ "mime_type": {
86
+ "description": "The document's media type.",
87
+ "enum": [
88
+ "application/pdf",
89
+ "text/plain"
90
+ ],
91
+ "title": "Mime Type",
92
+ "type": "string"
93
+ },
94
+ "thought": {
95
+ "anyOf": [
96
+ {
97
+ "type": "boolean"
98
+ },
99
+ {
100
+ "type": "null"
101
+ }
102
+ ],
103
+ "description": "Provider thought marker, preserved when replaying a returned conversation.",
104
+ "title": "Thought"
105
+ },
106
+ "thought_signature": {
107
+ "anyOf": [
108
+ {
109
+ "minLength": 1,
110
+ "type": "string"
111
+ },
112
+ {
113
+ "type": "null"
114
+ }
115
+ ],
116
+ "description": "Opaque provider-issued thought signature. Replay it unchanged on its original part.",
117
+ "title": "Thought Signature"
118
+ },
119
+ "type": {
120
+ "const": "document",
121
+ "description": "The document part discriminator.",
122
+ "title": "Type",
123
+ "type": "string"
124
+ }
125
+ },
126
+ "required": [
127
+ "type",
128
+ "file_url",
129
+ "mime_type"
130
+ ],
131
+ "title": "GeminiDocumentPart",
132
+ "type": "object",
133
+ "x-fal-order-properties": [
134
+ "thought",
135
+ "thought_signature",
136
+ "type",
137
+ "file_url",
138
+ "mime_type"
139
+ ]
140
+ },
141
+ "GeminiImagePart": {
142
+ "additionalProperties": false,
143
+ "properties": {
144
+ "image_url": {
145
+ "description": "Original image URL or data URI. Replayed without resizing or re-encoding.",
146
+ "title": "Image Url",
147
+ "type": "string"
148
+ },
149
+ "thought": {
150
+ "anyOf": [
151
+ {
152
+ "type": "boolean"
153
+ },
154
+ {
155
+ "type": "null"
156
+ }
157
+ ],
158
+ "description": "Provider thought marker, preserved when replaying a returned conversation.",
159
+ "title": "Thought"
160
+ },
161
+ "thought_signature": {
162
+ "anyOf": [
163
+ {
164
+ "minLength": 1,
165
+ "type": "string"
166
+ },
167
+ {
168
+ "type": "null"
169
+ }
170
+ ],
171
+ "description": "Opaque provider-issued thought signature. Replay it unchanged on its original part.",
172
+ "title": "Thought Signature"
173
+ },
174
+ "type": {
175
+ "const": "image",
176
+ "description": "The image part discriminator.",
177
+ "title": "Type",
178
+ "type": "string"
179
+ }
180
+ },
181
+ "required": [
182
+ "type",
183
+ "image_url"
184
+ ],
185
+ "title": "GeminiImagePart",
186
+ "type": "object",
187
+ "x-fal-order-properties": [
188
+ "thought",
189
+ "thought_signature",
190
+ "type",
191
+ "image_url"
192
+ ]
193
+ },
194
+ "GeminiMessage": {
195
+ "additionalProperties": false,
196
+ "properties": {
197
+ "parts": {
198
+ "description": "Ordered text, image, document, and signature parts.",
199
+ "items": {
200
+ "discriminator": {
201
+ "mapping": {
202
+ "document": "#/components/schemas/GeminiDocumentPart",
203
+ "image": "#/components/schemas/GeminiImagePart",
204
+ "signature": "#/components/schemas/GeminiSignaturePart",
205
+ "text": "#/components/schemas/GeminiTextPart"
206
+ },
207
+ "propertyName": "type"
208
+ },
209
+ "oneOf": [
210
+ {
211
+ "$ref": "#/components/schemas/GeminiTextPart"
212
+ },
213
+ {
214
+ "$ref": "#/components/schemas/GeminiImagePart"
215
+ },
216
+ {
217
+ "$ref": "#/components/schemas/GeminiDocumentPart"
218
+ },
219
+ {
220
+ "$ref": "#/components/schemas/GeminiSignaturePart"
221
+ }
222
+ ]
223
+ },
224
+ "minItems": 1,
225
+ "title": "Parts",
226
+ "type": "array"
227
+ },
228
+ "role": {
229
+ "description": "Native Gemini conversation role.",
230
+ "enum": [
231
+ "user",
232
+ "model"
233
+ ],
234
+ "title": "Role",
235
+ "type": "string"
236
+ }
237
+ },
238
+ "required": [
239
+ "role",
240
+ "parts"
241
+ ],
242
+ "title": "GeminiMessage",
243
+ "type": "object",
244
+ "x-fal-order-properties": [
245
+ "role",
246
+ "parts"
247
+ ]
248
+ },
249
+ "GeminiSignaturePart": {
250
+ "additionalProperties": false,
251
+ "properties": {
252
+ "thought": {
253
+ "anyOf": [
254
+ {
255
+ "type": "boolean"
256
+ },
257
+ {
258
+ "type": "null"
259
+ }
260
+ ],
261
+ "description": "Provider thought marker, preserved when replaying a returned conversation.",
262
+ "title": "Thought"
263
+ },
264
+ "thought_signature": {
265
+ "description": "Provider-issued signature-only part, replayed unchanged.",
266
+ "minLength": 1,
267
+ "title": "Thought Signature",
268
+ "type": "string"
269
+ },
270
+ "type": {
271
+ "const": "signature",
272
+ "description": "The signature part discriminator.",
273
+ "title": "Type",
274
+ "type": "string"
275
+ }
276
+ },
277
+ "required": [
278
+ "thought_signature",
279
+ "type"
280
+ ],
281
+ "title": "GeminiSignaturePart",
282
+ "type": "object",
283
+ "x-fal-order-properties": [
284
+ "thought",
285
+ "thought_signature",
286
+ "type"
287
+ ]
288
+ },
289
+ "GeminiTextPart": {
290
+ "additionalProperties": false,
291
+ "properties": {
292
+ "text": {
293
+ "description": "Text at this position in the conversation.",
294
+ "title": "Text",
295
+ "type": "string"
296
+ },
297
+ "thought": {
298
+ "anyOf": [
299
+ {
300
+ "type": "boolean"
301
+ },
302
+ {
303
+ "type": "null"
304
+ }
305
+ ],
306
+ "description": "Provider thought marker, preserved when replaying a returned conversation.",
307
+ "title": "Thought"
308
+ },
309
+ "thought_signature": {
310
+ "anyOf": [
311
+ {
312
+ "minLength": 1,
313
+ "type": "string"
314
+ },
315
+ {
316
+ "type": "null"
317
+ }
318
+ ],
319
+ "description": "Opaque provider-issued thought signature. Replay it unchanged on its original part.",
320
+ "title": "Thought Signature"
321
+ },
322
+ "type": {
323
+ "const": "text",
324
+ "description": "The text part discriminator.",
325
+ "title": "Type",
326
+ "type": "string"
327
+ }
328
+ },
329
+ "required": [
330
+ "type",
331
+ "text"
332
+ ],
333
+ "title": "GeminiTextPart",
334
+ "type": "object",
335
+ "x-fal-order-properties": [
336
+ "thought",
337
+ "thought_signature",
338
+ "type",
339
+ "text"
340
+ ]
341
+ },
342
+ "GeminiVideoMessage": {
343
+ "additionalProperties": false,
344
+ "properties": {
345
+ "parts": {
346
+ "description": "Ordered text, image, document, video, audio, and signature parts.",
347
+ "items": {
348
+ "discriminator": {
349
+ "mapping": {
350
+ "audio": "#/components/schemas/GeminiAudioPart",
351
+ "document": "#/components/schemas/GeminiDocumentPart",
352
+ "image": "#/components/schemas/GeminiImagePart",
353
+ "signature": "#/components/schemas/GeminiSignaturePart",
354
+ "text": "#/components/schemas/GeminiTextPart",
355
+ "video": "#/components/schemas/GeminiVideoPart"
356
+ },
357
+ "propertyName": "type"
358
+ },
359
+ "oneOf": [
360
+ {
361
+ "$ref": "#/components/schemas/GeminiTextPart"
362
+ },
363
+ {
364
+ "$ref": "#/components/schemas/GeminiImagePart"
365
+ },
366
+ {
367
+ "$ref": "#/components/schemas/GeminiDocumentPart"
368
+ },
369
+ {
370
+ "$ref": "#/components/schemas/GeminiVideoPart"
371
+ },
372
+ {
373
+ "$ref": "#/components/schemas/GeminiSignaturePart"
374
+ },
375
+ {
376
+ "$ref": "#/components/schemas/GeminiAudioPart"
377
+ }
378
+ ]
379
+ },
380
+ "minItems": 1,
381
+ "title": "Parts",
382
+ "type": "array"
383
+ },
384
+ "role": {
385
+ "description": "Native Gemini conversation role.",
386
+ "enum": [
387
+ "user",
388
+ "model"
389
+ ],
390
+ "title": "Role",
391
+ "type": "string"
392
+ }
393
+ },
394
+ "required": [
395
+ "role",
396
+ "parts"
397
+ ],
398
+ "title": "GeminiVideoMessage",
399
+ "type": "object",
400
+ "x-fal-order-properties": [
401
+ "role",
402
+ "parts"
403
+ ]
404
+ },
405
+ "GeminiVideoPart": {
406
+ "additionalProperties": false,
407
+ "properties": {
408
+ "thought": {
409
+ "anyOf": [
410
+ {
411
+ "type": "boolean"
412
+ },
413
+ {
414
+ "type": "null"
415
+ }
416
+ ],
417
+ "description": "Provider thought marker, preserved when replaying a returned conversation.",
418
+ "title": "Thought"
419
+ },
420
+ "thought_signature": {
421
+ "anyOf": [
422
+ {
423
+ "minLength": 1,
424
+ "type": "string"
425
+ },
426
+ {
427
+ "type": "null"
428
+ }
429
+ ],
430
+ "description": "Opaque provider-issued thought signature. Replay it unchanged on its original part.",
431
+ "title": "Thought Signature"
432
+ },
433
+ "type": {
434
+ "const": "video",
435
+ "description": "The video part discriminator.",
436
+ "title": "Type",
437
+ "type": "string"
438
+ },
439
+ "video_url": {
440
+ "description": "Video URL or data URI (up to 15 MB and 120 seconds), or a YouTube URL. Supported by Flash Image only.",
441
+ "title": "Video Url",
442
+ "type": "string"
443
+ }
444
+ },
445
+ "required": [
446
+ "type",
447
+ "video_url"
448
+ ],
449
+ "title": "GeminiVideoPart",
450
+ "type": "object",
451
+ "x-fal-order-properties": [
452
+ "thought",
453
+ "thought_signature",
454
+ "type",
455
+ "video_url"
456
+ ]
457
+ },
458
+ "ImageFile": {
459
+ "properties": {
460
+ "content_type": {
461
+ "anyOf": [
462
+ {
463
+ "type": "string"
464
+ },
465
+ {
466
+ "type": "null"
467
+ }
468
+ ],
469
+ "description": "The mime type of the file.",
470
+ "examples": [
471
+ "image/png"
472
+ ],
473
+ "title": "Content Type"
474
+ },
475
+ "file_name": {
476
+ "anyOf": [
477
+ {
478
+ "type": "string"
479
+ },
480
+ {
481
+ "type": "null"
482
+ }
483
+ ],
484
+ "description": "The name of the file. It will be auto-generated if not provided.",
485
+ "examples": [
486
+ "z9RV14K95DvU.png"
487
+ ],
488
+ "title": "File Name"
489
+ },
490
+ "file_size": {
491
+ "anyOf": [
492
+ {
493
+ "type": "integer"
494
+ },
495
+ {
496
+ "type": "null"
497
+ }
498
+ ],
499
+ "description": "The size of the file in bytes.",
500
+ "examples": [
501
+ 4404019
502
+ ],
503
+ "title": "File Size"
504
+ },
505
+ "height": {
506
+ "anyOf": [
507
+ {
508
+ "type": "integer"
509
+ },
510
+ {
511
+ "type": "null"
512
+ }
513
+ ],
514
+ "description": "The height of the image",
515
+ "title": "Height"
516
+ },
517
+ "url": {
518
+ "description": "The URL where the file can be downloaded from.",
519
+ "title": "Url",
520
+ "type": "string"
521
+ },
522
+ "width": {
523
+ "anyOf": [
524
+ {
525
+ "type": "integer"
526
+ },
527
+ {
528
+ "type": "null"
529
+ }
530
+ ],
531
+ "description": "The width of the image",
532
+ "title": "Width"
533
+ }
534
+ },
535
+ "required": [
536
+ "url"
537
+ ],
538
+ "title": "ImageFile",
539
+ "type": "object",
540
+ "x-fal-order-properties": [
541
+ "url",
542
+ "content_type",
543
+ "file_name",
544
+ "file_size",
545
+ "width",
546
+ "height"
547
+ ]
548
+ },
549
+ "NanoBananaProEditInput": {
550
+ "properties": {
551
+ "aspect_ratio": {
552
+ "anyOf": [
553
+ {
554
+ "enum": [
555
+ "auto",
556
+ "21:9",
557
+ "16:9",
558
+ "3:2",
559
+ "4:3",
560
+ "5:4",
561
+ "1:1",
562
+ "4:5",
563
+ "3:4",
564
+ "2:3",
565
+ "9:16",
566
+ "4:1",
567
+ "1:4",
568
+ "8:1",
569
+ "1:8"
570
+ ],
571
+ "type": "string"
572
+ },
573
+ {
574
+ "type": "null"
575
+ }
576
+ ],
577
+ "default": "auto",
578
+ "description": "The aspect ratio of the generated image, including 1:4, 4:1, 1:8 and 8:1.",
579
+ "title": "Aspect Ratio"
580
+ },
581
+ "context": {
582
+ "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.",
583
+ "items": {
584
+ "discriminator": {
585
+ "mapping": {
586
+ "document": "#/components/schemas/GeminiDocumentPart",
587
+ "image": "#/components/schemas/GeminiImagePart",
588
+ "signature": "#/components/schemas/GeminiSignaturePart",
589
+ "text": "#/components/schemas/GeminiTextPart"
590
+ },
591
+ "propertyName": "type"
592
+ },
593
+ "oneOf": [
594
+ {
595
+ "$ref": "#/components/schemas/GeminiTextPart"
596
+ },
597
+ {
598
+ "$ref": "#/components/schemas/GeminiImagePart"
599
+ },
600
+ {
601
+ "$ref": "#/components/schemas/GeminiDocumentPart"
602
+ },
603
+ {
604
+ "$ref": "#/components/schemas/GeminiSignaturePart"
605
+ }
606
+ ]
607
+ },
608
+ "title": "Context",
609
+ "type": "array"
610
+ },
611
+ "enable_web_search": {
612
+ "default": false,
613
+ "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.",
614
+ "title": "Enable Web Search",
615
+ "type": "boolean"
616
+ },
617
+ "history": {
618
+ "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.",
619
+ "items": {
620
+ "$ref": "#/components/schemas/GeminiMessage"
621
+ },
622
+ "title": "History",
623
+ "type": "array"
624
+ },
625
+ "image_urls": {
626
+ "description": "The URLs of the images to use for image-to-image generation or image editing.",
627
+ "examples": [
628
+ [
629
+ "https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input.png",
630
+ "https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input-2.png"
631
+ ]
632
+ ],
633
+ "items": {
634
+ "type": "string"
635
+ },
636
+ "title": "Image URLs",
637
+ "type": "array"
638
+ },
639
+ "include_thoughts": {
640
+ "anyOf": [
641
+ {
642
+ "type": "boolean"
643
+ },
644
+ {
645
+ "type": "null"
646
+ }
647
+ ],
648
+ "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.",
649
+ "title": "Include Thoughts"
650
+ },
651
+ "limit_generations": {
652
+ "default": true,
653
+ "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.",
654
+ "title": "Limit Generations",
655
+ "type": "boolean"
656
+ },
657
+ "max_output_tokens": {
658
+ "anyOf": [
659
+ {
660
+ "maximum": 32768,
661
+ "minimum": 1,
662
+ "type": "integer"
663
+ },
664
+ {
665
+ "type": "null"
666
+ }
667
+ ],
668
+ "description": "Maximum output tokens for the generation. Omit to retain the provider default. Explicit values use a direct Google or Vertex API.",
669
+ "title": "Max Output Tokens"
670
+ },
671
+ "num_images": {
672
+ "default": 1,
673
+ "description": "The number of images to generate.",
674
+ "maximum": 4,
675
+ "minimum": 1,
676
+ "title": "Number of Images",
677
+ "type": "integer"
678
+ },
679
+ "output_format": {
680
+ "default": "png",
681
+ "description": "The format of the generated image.",
682
+ "enum": [
683
+ "jpeg",
684
+ "png",
685
+ "webp"
686
+ ],
687
+ "title": "Output Format",
688
+ "type": "string"
689
+ },
690
+ "prompt": {
691
+ "description": "The prompt for image editing.",
692
+ "examples": [
693
+ "make a photo of the man driving the car down the california coastline"
694
+ ],
695
+ "maxLength": 50000,
696
+ "minLength": 3,
697
+ "title": "Prompt",
698
+ "type": "string"
699
+ },
700
+ "resolution": {
701
+ "default": "1K",
702
+ "description": "The resolution of the image to generate.",
703
+ "enum": [
704
+ "1K",
705
+ "2K",
706
+ "4K"
707
+ ],
708
+ "title": "Resolution",
709
+ "type": "string"
710
+ },
711
+ "return_history": {
712
+ "default": false,
713
+ "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.",
714
+ "title": "Return History",
715
+ "type": "boolean"
716
+ },
717
+ "safety_tolerance": {
718
+ "default": "4",
719
+ "description": "The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.",
720
+ "enum": [
721
+ "1",
722
+ "2",
723
+ "3",
724
+ "4",
725
+ "5",
726
+ "6"
727
+ ],
728
+ "title": "Safety Tolerance",
729
+ "type": "string"
730
+ },
731
+ "seed": {
732
+ "anyOf": [
733
+ {
734
+ "type": "integer"
735
+ },
736
+ {
737
+ "type": "null"
738
+ }
739
+ ],
740
+ "description": "The seed for the random number generator.",
741
+ "title": "Seed"
742
+ },
743
+ "sync_mode": {
744
+ "default": false,
745
+ "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.",
746
+ "title": "Sync Mode",
747
+ "type": "boolean"
748
+ },
749
+ "system_prompt": {
750
+ "default": "",
751
+ "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).",
752
+ "maxLength": 50000,
753
+ "title": "System Prompt",
754
+ "type": "string"
755
+ },
756
+ "temperature": {
757
+ "anyOf": [
758
+ {
759
+ "maximum": 2,
760
+ "minimum": 0,
761
+ "type": "number"
762
+ },
763
+ {
764
+ "type": "null"
765
+ }
766
+ ],
767
+ "description": "Sampling temperature. Omit to use the provider default of 1. Explicit values use a direct Google or Vertex API.",
768
+ "title": "Temperature"
769
+ },
770
+ "thinking_level": {
771
+ "anyOf": [
772
+ {
773
+ "const": "high",
774
+ "type": "string"
775
+ },
776
+ {
777
+ "type": "null"
778
+ }
779
+ ],
780
+ "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.",
781
+ "title": "Thinking Level"
782
+ },
783
+ "top_p": {
784
+ "anyOf": [
785
+ {
786
+ "maximum": 1,
787
+ "minimum": 0,
788
+ "type": "number"
789
+ },
790
+ {
791
+ "type": "null"
792
+ }
793
+ ],
794
+ "description": "Nucleus sampling probability. Omit to use the provider default of 0.95. Explicit values use a direct Google or Vertex API.",
795
+ "title": "Top P"
796
+ }
797
+ },
798
+ "required": [
799
+ "prompt"
800
+ ],
801
+ "title": "NanoBananaImageToImageInput",
802
+ "type": "object",
803
+ "x-fal-order-properties": [
804
+ "prompt",
805
+ "image_urls",
806
+ "history",
807
+ "context",
808
+ "return_history",
809
+ "thinking_level",
810
+ "include_thoughts",
811
+ "temperature",
812
+ "top_p",
813
+ "max_output_tokens",
814
+ "num_images",
815
+ "seed",
816
+ "aspect_ratio",
817
+ "output_format",
818
+ "safety_tolerance",
819
+ "sync_mode",
820
+ "system_prompt",
821
+ "resolution",
822
+ "limit_generations",
823
+ "enable_web_search"
824
+ ]
825
+ },
826
+ "NanoBananaProEditOutput": {
827
+ "properties": {
828
+ "conversations": {
829
+ "description": "Reusable per-generation conversations, populated only when return_history is true. Retain every part and thought signature when continuing a conversation.",
830
+ "items": {
831
+ "$ref": "#/components/schemas/GeminiConversation"
832
+ },
833
+ "title": "Conversations",
834
+ "type": "array"
835
+ },
836
+ "description": {
837
+ "description": "The description of the generated images.",
838
+ "title": "Description",
839
+ "type": "string"
840
+ },
841
+ "grounding_metadata": {
842
+ "description": "Provider grounding metadata for the generated images, including search queries, source pages and image-source attribution when available.",
843
+ "items": {
844
+ "type": "object"
845
+ },
846
+ "title": "Grounding Metadata",
847
+ "type": "array"
848
+ },
849
+ "images": {
850
+ "description": "The edited images.",
851
+ "examples": [
852
+ [
853
+ {
854
+ "content_type": "image/png",
855
+ "file_name": "nano-banana-pro-edit-output.png",
856
+ "url": "https://storage.googleapis.com/falserverless/example_outputs/nano-banana-pro-edit-output.png"
857
+ }
858
+ ]
859
+ ],
860
+ "items": {
861
+ "$ref": "#/components/schemas/ImageFile"
862
+ },
863
+ "title": "Images",
864
+ "type": "array"
865
+ }
866
+ },
867
+ "required": [
868
+ "images",
869
+ "description"
870
+ ],
871
+ "title": "NanoBananaImageToImageOutput",
872
+ "type": "object",
873
+ "x-fal-order-properties": [
874
+ "images",
875
+ "description",
876
+ "conversations",
877
+ "grounding_metadata"
878
+ ]
879
+ },
880
+ "QueueStatus": {
881
+ "properties": {
882
+ "cancel_url": {
883
+ "description": "The cancel url.",
884
+ "type": "string"
885
+ },
886
+ "logs": {
887
+ "additionalProperties": true,
888
+ "description": "The logs.",
889
+ "type": "object"
890
+ },
891
+ "metrics": {
892
+ "additionalProperties": true,
893
+ "description": "The metrics.",
894
+ "type": "object"
895
+ },
896
+ "queue_position": {
897
+ "description": "The queue position.",
898
+ "type": "integer"
899
+ },
900
+ "request_id": {
901
+ "description": "The request id.",
902
+ "type": "string"
903
+ },
904
+ "response_url": {
905
+ "description": "The response url.",
906
+ "type": "string"
907
+ },
908
+ "status": {
909
+ "enum": [
910
+ "IN_QUEUE",
911
+ "IN_PROGRESS",
912
+ "COMPLETED"
913
+ ],
914
+ "type": "string"
915
+ },
916
+ "status_url": {
917
+ "description": "The status url.",
918
+ "type": "string"
919
+ }
920
+ },
921
+ "required": [
922
+ "status",
923
+ "request_id"
924
+ ],
925
+ "type": "object"
926
+ }
927
+ },
928
+ "securitySchemes": {
929
+ "apiKeyAuth": {
930
+ "description": "Fal Key",
931
+ "in": "header",
932
+ "name": "Authorization",
933
+ "type": "apiKey"
934
+ }
935
+ }
936
+ },
937
+ "info": {
938
+ "description": "The OpenAPI schema for the fal-ai/nano-banana-pro/edit queue.",
939
+ "title": "Queue OpenAPI for fal-ai/nano-banana-pro/edit",
940
+ "version": "1.0.0",
941
+ "x-fal-metadata": {
942
+ "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``).",
943
+ "category": "image-to-image",
944
+ "documentationUrl": "https://fal.ai/models/fal-ai/nano-banana-pro/edit/api",
945
+ "endpointId": "fal-ai/nano-banana-pro/edit",
946
+ "playgroundUrl": "https://fal.ai/models/fal-ai/nano-banana-pro/edit",
947
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0a9c2f0f/p3rXI18zMYTBz1M0qP2h4_b9a2087ce0b64cd788cb5ec067edc26e.jpg"
948
+ }
949
+ },
950
+ "openapi": "3.1.0",
951
+ "paths": {
952
+ "/fal-ai/nano-banana-pro/edit": {
953
+ "post": {
954
+ "requestBody": {
955
+ "content": {
956
+ "application/json": {
957
+ "schema": {
958
+ "$ref": "#/components/schemas/NanoBananaProEditInput"
959
+ }
960
+ }
961
+ },
962
+ "required": true
963
+ },
964
+ "responses": {
965
+ "200": {
966
+ "content": {
967
+ "application/json": {
968
+ "schema": {
969
+ "$ref": "#/components/schemas/QueueStatus"
970
+ }
971
+ }
972
+ },
973
+ "description": "The request status."
974
+ }
975
+ }
976
+ }
977
+ },
978
+ "/fal-ai/nano-banana-pro/edit/requests/{request_id}": {
979
+ "get": {
980
+ "parameters": [
981
+ {
982
+ "in": "path",
983
+ "name": "request_id",
984
+ "required": true,
985
+ "schema": {
986
+ "description": "Request ID",
987
+ "type": "string"
988
+ }
989
+ }
990
+ ],
991
+ "responses": {
992
+ "200": {
993
+ "content": {
994
+ "application/json": {
995
+ "schema": {
996
+ "$ref": "#/components/schemas/NanoBananaProEditOutput"
997
+ }
998
+ }
999
+ },
1000
+ "description": "Result of the request."
1001
+ }
1002
+ }
1003
+ }
1004
+ },
1005
+ "/fal-ai/nano-banana-pro/edit/requests/{request_id}/cancel": {
1006
+ "put": {
1007
+ "parameters": [
1008
+ {
1009
+ "in": "path",
1010
+ "name": "request_id",
1011
+ "required": true,
1012
+ "schema": {
1013
+ "description": "Request ID",
1014
+ "type": "string"
1015
+ }
1016
+ }
1017
+ ],
1018
+ "responses": {
1019
+ "200": {
1020
+ "content": {
1021
+ "application/json": {
1022
+ "schema": {
1023
+ "properties": {
1024
+ "success": {
1025
+ "description": "Whether the request was cancelled successfully.",
1026
+ "type": "boolean"
1027
+ }
1028
+ },
1029
+ "type": "object"
1030
+ }
1031
+ }
1032
+ },
1033
+ "description": "The request was cancelled."
1034
+ }
1035
+ }
1036
+ }
1037
+ },
1038
+ "/fal-ai/nano-banana-pro/edit/requests/{request_id}/status": {
1039
+ "get": {
1040
+ "parameters": [
1041
+ {
1042
+ "in": "path",
1043
+ "name": "request_id",
1044
+ "required": true,
1045
+ "schema": {
1046
+ "description": "Request ID",
1047
+ "type": "string"
1048
+ }
1049
+ },
1050
+ {
1051
+ "in": "query",
1052
+ "name": "logs",
1053
+ "required": false,
1054
+ "schema": {
1055
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
1056
+ "type": "number"
1057
+ }
1058
+ }
1059
+ ],
1060
+ "responses": {
1061
+ "200": {
1062
+ "content": {
1063
+ "application/json": {
1064
+ "schema": {
1065
+ "$ref": "#/components/schemas/QueueStatus"
1066
+ }
1067
+ }
1068
+ },
1069
+ "description": "The request status."
1070
+ }
1071
+ }
1072
+ }
1073
+ }
1074
+ },
1075
+ "security": [
1076
+ {
1077
+ "apiKeyAuth": []
1078
+ }
1079
+ ],
1080
+ "servers": [
1081
+ {
1082
+ "url": "https://queue.fal.run"
1083
+ }
1084
+ ]
1085
+ }
pipeline/fal_schemas/fal-ai__qwen-image-edit-2511.json ADDED
@@ -0,0 +1 @@
 
 
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":[]}]}
pipeline/fal_schemas/fal-ai__wan__v2.7__pro__edit.json ADDED
@@ -0,0 +1,449 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "File": {
5
+ "properties": {
6
+ "content_type": {
7
+ "anyOf": [
8
+ {
9
+ "type": "string"
10
+ },
11
+ {
12
+ "type": "null"
13
+ }
14
+ ],
15
+ "description": "The mime type of the file.",
16
+ "examples": [
17
+ "image/png"
18
+ ],
19
+ "title": "Content Type"
20
+ },
21
+ "file_name": {
22
+ "anyOf": [
23
+ {
24
+ "type": "string"
25
+ },
26
+ {
27
+ "type": "null"
28
+ }
29
+ ],
30
+ "description": "The name of the file. It will be auto-generated if not provided.",
31
+ "examples": [
32
+ "z9RV14K95DvU.png"
33
+ ],
34
+ "title": "File Name"
35
+ },
36
+ "file_size": {
37
+ "anyOf": [
38
+ {
39
+ "type": "integer"
40
+ },
41
+ {
42
+ "type": "null"
43
+ }
44
+ ],
45
+ "description": "The size of the file in bytes.",
46
+ "examples": [
47
+ 4404019
48
+ ],
49
+ "title": "File Size"
50
+ },
51
+ "url": {
52
+ "description": "The URL where the file can be downloaded from.",
53
+ "title": "Url",
54
+ "type": "string"
55
+ }
56
+ },
57
+ "required": [
58
+ "url"
59
+ ],
60
+ "title": "File",
61
+ "type": "object",
62
+ "x-fal-order-properties": [
63
+ "url",
64
+ "content_type",
65
+ "file_name",
66
+ "file_size"
67
+ ]
68
+ },
69
+ "ImageSize": {
70
+ "properties": {
71
+ "height": {
72
+ "default": 512,
73
+ "description": "The height of the generated image.",
74
+ "exclusiveMinimum": 0,
75
+ "maximum": 14142,
76
+ "title": "Height",
77
+ "type": "integer"
78
+ },
79
+ "width": {
80
+ "default": 512,
81
+ "description": "The width of the generated image.",
82
+ "exclusiveMinimum": 0,
83
+ "maximum": 14142,
84
+ "title": "Width",
85
+ "type": "integer"
86
+ }
87
+ },
88
+ "title": "ImageSize",
89
+ "type": "object",
90
+ "x-fal-order-properties": [
91
+ "width",
92
+ "height"
93
+ ]
94
+ },
95
+ "QueueStatus": {
96
+ "properties": {
97
+ "cancel_url": {
98
+ "description": "The cancel url.",
99
+ "type": "string"
100
+ },
101
+ "logs": {
102
+ "additionalProperties": true,
103
+ "description": "The logs.",
104
+ "type": "object"
105
+ },
106
+ "metrics": {
107
+ "additionalProperties": true,
108
+ "description": "The metrics.",
109
+ "type": "object"
110
+ },
111
+ "queue_position": {
112
+ "description": "The queue position.",
113
+ "type": "integer"
114
+ },
115
+ "request_id": {
116
+ "description": "The request id.",
117
+ "type": "string"
118
+ },
119
+ "response_url": {
120
+ "description": "The response url.",
121
+ "type": "string"
122
+ },
123
+ "status": {
124
+ "enum": [
125
+ "IN_QUEUE",
126
+ "IN_PROGRESS",
127
+ "COMPLETED"
128
+ ],
129
+ "type": "string"
130
+ },
131
+ "status_url": {
132
+ "description": "The status url.",
133
+ "type": "string"
134
+ }
135
+ },
136
+ "required": [
137
+ "status",
138
+ "request_id"
139
+ ],
140
+ "type": "object"
141
+ },
142
+ "WanV27ProEditInput": {
143
+ "properties": {
144
+ "enable_prompt_expansion": {
145
+ "default": true,
146
+ "description": "Enable DashScope prompt expansion. Supported only for image edit mode.",
147
+ "title": "Enable Prompt Expansion",
148
+ "type": "boolean"
149
+ },
150
+ "enable_safety_checker": {
151
+ "default": true,
152
+ "description": "Enable content moderation for input and output. Disabling it requires account authorization; unauthorized requests are always checked.",
153
+ "title": "Enable Safety Checker",
154
+ "type": "boolean"
155
+ },
156
+ "image_size": {
157
+ "anyOf": [
158
+ {
159
+ "$ref": "#/components/schemas/ImageSize"
160
+ },
161
+ {
162
+ "enum": [
163
+ "square_hd",
164
+ "square",
165
+ "portrait_4_3",
166
+ "portrait_16_9",
167
+ "landscape_4_3",
168
+ "landscape_16_9"
169
+ ],
170
+ "type": "string"
171
+ }
172
+ ],
173
+ "default": "square_hd",
174
+ "description": "Output image size. Uses fal image size presets or explicit dimensions and is converted to DashScope size format.",
175
+ "title": "Image Size"
176
+ },
177
+ "image_urls": {
178
+ "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.",
179
+ "examples": [
180
+ [
181
+ "https://storage.googleapis.com/falserverless/model_tests/wan/dragon-warrior.jpg"
182
+ ]
183
+ ],
184
+ "items": {
185
+ "type": "string"
186
+ },
187
+ "title": "Image Urls",
188
+ "type": "array"
189
+ },
190
+ "negative_prompt": {
191
+ "anyOf": [
192
+ {
193
+ "maxLength": 500,
194
+ "type": "string"
195
+ },
196
+ {
197
+ "type": "null"
198
+ }
199
+ ],
200
+ "default": "",
201
+ "description": "Content to avoid in the generated image. Max 500 characters.",
202
+ "title": "Negative Prompt"
203
+ },
204
+ "num_images": {
205
+ "default": 1,
206
+ "description": "Number of images to generate (1-4).",
207
+ "maximum": 4,
208
+ "minimum": 1,
209
+ "title": "Num Images",
210
+ "type": "integer"
211
+ },
212
+ "output_format": {
213
+ "default": "jpeg",
214
+ "description": "The format of the generated images.",
215
+ "enum": [
216
+ "jpeg",
217
+ "png",
218
+ "webp"
219
+ ],
220
+ "title": "Output Format",
221
+ "type": "string"
222
+ },
223
+ "prompt": {
224
+ "description": "Text prompt describing the desired image edit. Supports Chinese and English.",
225
+ "examples": [
226
+ "Turn image 1 into a watercolor painting."
227
+ ],
228
+ "maxLength": 2000,
229
+ "minLength": 1,
230
+ "title": "Prompt",
231
+ "type": "string"
232
+ },
233
+ "seed": {
234
+ "anyOf": [
235
+ {
236
+ "type": "integer"
237
+ },
238
+ {
239
+ "type": "null"
240
+ }
241
+ ],
242
+ "description": "Random seed for reproducibility (0-2147483647).",
243
+ "title": "Seed"
244
+ }
245
+ },
246
+ "required": [
247
+ "prompt",
248
+ "image_urls"
249
+ ],
250
+ "title": "Wan27ImageEditInput",
251
+ "type": "object",
252
+ "x-fal-order-properties": [
253
+ "prompt",
254
+ "image_urls",
255
+ "negative_prompt",
256
+ "image_size",
257
+ "num_images",
258
+ "enable_prompt_expansion",
259
+ "seed",
260
+ "enable_safety_checker",
261
+ "output_format"
262
+ ]
263
+ },
264
+ "WanV27ProEditOutput": {
265
+ "properties": {
266
+ "images": {
267
+ "description": "Generated images.",
268
+ "items": {
269
+ "$ref": "#/components/schemas/File"
270
+ },
271
+ "title": "Images",
272
+ "type": "array"
273
+ },
274
+ "seed": {
275
+ "description": "The seed used for generation.",
276
+ "title": "Seed",
277
+ "type": "integer"
278
+ }
279
+ },
280
+ "required": [
281
+ "images",
282
+ "seed"
283
+ ],
284
+ "title": "Wan27ImageEditOutput",
285
+ "type": "object",
286
+ "x-fal-order-properties": [
287
+ "images",
288
+ "seed"
289
+ ]
290
+ }
291
+ },
292
+ "securitySchemes": {
293
+ "apiKeyAuth": {
294
+ "description": "Fal Key",
295
+ "in": "header",
296
+ "name": "Authorization",
297
+ "type": "apiKey"
298
+ }
299
+ }
300
+ },
301
+ "info": {
302
+ "description": "The OpenAPI schema for the fal-ai/wan/v2.7/pro/edit queue.",
303
+ "title": "Queue OpenAPI for fal-ai/wan/v2.7/pro/edit",
304
+ "version": "1.0.0",
305
+ "x-fal-metadata": {
306
+ "about": "Pro Image Edit",
307
+ "category": "image-to-image",
308
+ "documentationUrl": "https://fal.ai/models/fal-ai/wan/v2.7/pro/edit/api",
309
+ "endpointId": "fal-ai/wan/v2.7/pro/edit",
310
+ "playgroundUrl": "https://fal.ai/models/fal-ai/wan/v2.7/pro/edit",
311
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0a94816f/BhHA2kmKyAQ8vJxw_HPQ4_2b4b35f0fbb0449195d84178ba988112.jpg"
312
+ }
313
+ },
314
+ "openapi": "3.1.0",
315
+ "paths": {
316
+ "/fal-ai/wan/v2.7/pro/edit": {
317
+ "post": {
318
+ "requestBody": {
319
+ "content": {
320
+ "application/json": {
321
+ "schema": {
322
+ "$ref": "#/components/schemas/WanV27ProEditInput"
323
+ }
324
+ }
325
+ },
326
+ "required": true
327
+ },
328
+ "responses": {
329
+ "200": {
330
+ "content": {
331
+ "application/json": {
332
+ "schema": {
333
+ "$ref": "#/components/schemas/QueueStatus"
334
+ }
335
+ }
336
+ },
337
+ "description": "The request status."
338
+ }
339
+ }
340
+ }
341
+ },
342
+ "/fal-ai/wan/v2.7/pro/edit/requests/{request_id}": {
343
+ "get": {
344
+ "parameters": [
345
+ {
346
+ "in": "path",
347
+ "name": "request_id",
348
+ "required": true,
349
+ "schema": {
350
+ "description": "Request ID",
351
+ "type": "string"
352
+ }
353
+ }
354
+ ],
355
+ "responses": {
356
+ "200": {
357
+ "content": {
358
+ "application/json": {
359
+ "schema": {
360
+ "$ref": "#/components/schemas/WanV27ProEditOutput"
361
+ }
362
+ }
363
+ },
364
+ "description": "Result of the request."
365
+ }
366
+ }
367
+ }
368
+ },
369
+ "/fal-ai/wan/v2.7/pro/edit/requests/{request_id}/cancel": {
370
+ "put": {
371
+ "parameters": [
372
+ {
373
+ "in": "path",
374
+ "name": "request_id",
375
+ "required": true,
376
+ "schema": {
377
+ "description": "Request ID",
378
+ "type": "string"
379
+ }
380
+ }
381
+ ],
382
+ "responses": {
383
+ "200": {
384
+ "content": {
385
+ "application/json": {
386
+ "schema": {
387
+ "properties": {
388
+ "success": {
389
+ "description": "Whether the request was cancelled successfully.",
390
+ "type": "boolean"
391
+ }
392
+ },
393
+ "type": "object"
394
+ }
395
+ }
396
+ },
397
+ "description": "The request was cancelled."
398
+ }
399
+ }
400
+ }
401
+ },
402
+ "/fal-ai/wan/v2.7/pro/edit/requests/{request_id}/status": {
403
+ "get": {
404
+ "parameters": [
405
+ {
406
+ "in": "path",
407
+ "name": "request_id",
408
+ "required": true,
409
+ "schema": {
410
+ "description": "Request ID",
411
+ "type": "string"
412
+ }
413
+ },
414
+ {
415
+ "in": "query",
416
+ "name": "logs",
417
+ "required": false,
418
+ "schema": {
419
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
420
+ "type": "number"
421
+ }
422
+ }
423
+ ],
424
+ "responses": {
425
+ "200": {
426
+ "content": {
427
+ "application/json": {
428
+ "schema": {
429
+ "$ref": "#/components/schemas/QueueStatus"
430
+ }
431
+ }
432
+ },
433
+ "description": "The request status."
434
+ }
435
+ }
436
+ }
437
+ }
438
+ },
439
+ "security": [
440
+ {
441
+ "apiKeyAuth": []
442
+ }
443
+ ],
444
+ "servers": [
445
+ {
446
+ "url": "https://queue.fal.run"
447
+ }
448
+ ]
449
+ }
pipeline/fal_schemas/google__nano-banana-2.1__edit.json ADDED
@@ -0,0 +1,539 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "ImageFile": {
5
+ "properties": {
6
+ "content_type": {
7
+ "anyOf": [
8
+ {
9
+ "type": "string"
10
+ },
11
+ {
12
+ "type": "null"
13
+ }
14
+ ],
15
+ "description": "The mime type of the file.",
16
+ "examples": [
17
+ "image/png"
18
+ ],
19
+ "title": "Content Type"
20
+ },
21
+ "file_name": {
22
+ "anyOf": [
23
+ {
24
+ "type": "string"
25
+ },
26
+ {
27
+ "type": "null"
28
+ }
29
+ ],
30
+ "description": "The name of the file. It will be auto-generated if not provided.",
31
+ "examples": [
32
+ "z9RV14K95DvU.png"
33
+ ],
34
+ "title": "File Name"
35
+ },
36
+ "file_size": {
37
+ "anyOf": [
38
+ {
39
+ "type": "integer"
40
+ },
41
+ {
42
+ "type": "null"
43
+ }
44
+ ],
45
+ "description": "The size of the file in bytes.",
46
+ "examples": [
47
+ 4404019
48
+ ],
49
+ "title": "File Size"
50
+ },
51
+ "height": {
52
+ "anyOf": [
53
+ {
54
+ "type": "integer"
55
+ },
56
+ {
57
+ "type": "null"
58
+ }
59
+ ],
60
+ "description": "The height of the image",
61
+ "title": "Height"
62
+ },
63
+ "url": {
64
+ "description": "The URL where the file can be downloaded from.",
65
+ "title": "Url",
66
+ "type": "string"
67
+ },
68
+ "width": {
69
+ "anyOf": [
70
+ {
71
+ "type": "integer"
72
+ },
73
+ {
74
+ "type": "null"
75
+ }
76
+ ],
77
+ "description": "The width of the image",
78
+ "title": "Width"
79
+ }
80
+ },
81
+ "required": [
82
+ "url"
83
+ ],
84
+ "title": "ImageFile",
85
+ "type": "object",
86
+ "x-fal-order-properties": [
87
+ "url",
88
+ "content_type",
89
+ "file_name",
90
+ "file_size",
91
+ "width",
92
+ "height"
93
+ ]
94
+ },
95
+ "NanoBanana21EditInput": {
96
+ "properties": {
97
+ "aspect_ratio": {
98
+ "anyOf": [
99
+ {
100
+ "enum": [
101
+ "auto",
102
+ "21:9",
103
+ "16:9",
104
+ "3:2",
105
+ "4:3",
106
+ "5:4",
107
+ "1:1",
108
+ "4:5",
109
+ "3:4",
110
+ "2:3",
111
+ "9:16",
112
+ "4:1",
113
+ "1:4",
114
+ "8:1",
115
+ "1:8"
116
+ ],
117
+ "type": "string"
118
+ },
119
+ {
120
+ "type": "null"
121
+ }
122
+ ],
123
+ "default": "auto",
124
+ "description": "The aspect ratio of the generated image. Supports extreme ratios: 4:1, 1:4, 8:1, 1:8.",
125
+ "title": "Aspect Ratio"
126
+ },
127
+ "enable_web_search": {
128
+ "default": false,
129
+ "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.",
130
+ "title": "Enable Web Search",
131
+ "type": "boolean"
132
+ },
133
+ "image_urls": {
134
+ "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.",
135
+ "examples": [
136
+ [
137
+ "https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input.png",
138
+ "https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input-2.png"
139
+ ]
140
+ ],
141
+ "items": {
142
+ "type": "string"
143
+ },
144
+ "title": "Image URLs",
145
+ "type": "array"
146
+ },
147
+ "limit_generations": {
148
+ "default": true,
149
+ "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.",
150
+ "title": "Limit Generations",
151
+ "type": "boolean"
152
+ },
153
+ "num_images": {
154
+ "default": 1,
155
+ "description": "The number of images to generate.",
156
+ "maximum": 4,
157
+ "minimum": 1,
158
+ "title": "Number of Images",
159
+ "type": "integer"
160
+ },
161
+ "output_format": {
162
+ "default": "png",
163
+ "description": "The format of the generated image.",
164
+ "enum": [
165
+ "jpeg",
166
+ "png",
167
+ "webp"
168
+ ],
169
+ "title": "Output Format",
170
+ "type": "string"
171
+ },
172
+ "pdf_url": {
173
+ "anyOf": [
174
+ {
175
+ "type": "string"
176
+ },
177
+ {
178
+ "type": "null"
179
+ }
180
+ ],
181
+ "description": "Optional PDF document to use as input context. Accepts an http(s)/data URL (downloaded and sent inline, max 15MB).",
182
+ "title": "PDF URL"
183
+ },
184
+ "prompt": {
185
+ "description": "The prompt for image editing.",
186
+ "examples": [
187
+ "make a photo of the man driving the car down the california coastline"
188
+ ],
189
+ "maxLength": 50000,
190
+ "minLength": 3,
191
+ "title": "Prompt",
192
+ "type": "string"
193
+ },
194
+ "resolution": {
195
+ "default": "1K",
196
+ "description": "The resolution of the image to generate.",
197
+ "enum": [
198
+ "1K",
199
+ "2K",
200
+ "4K"
201
+ ],
202
+ "title": "Resolution",
203
+ "type": "string"
204
+ },
205
+ "safety_tolerance": {
206
+ "default": "4",
207
+ "description": "The safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict.",
208
+ "enum": [
209
+ "1",
210
+ "2",
211
+ "3",
212
+ "4",
213
+ "5",
214
+ "6"
215
+ ],
216
+ "title": "Safety Tolerance",
217
+ "type": "string"
218
+ },
219
+ "seed": {
220
+ "anyOf": [
221
+ {
222
+ "type": "integer"
223
+ },
224
+ {
225
+ "type": "null"
226
+ }
227
+ ],
228
+ "description": "The seed for the random number generator.",
229
+ "title": "Seed"
230
+ },
231
+ "sync_mode": {
232
+ "default": false,
233
+ "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.",
234
+ "title": "Sync Mode",
235
+ "type": "boolean"
236
+ },
237
+ "system_prompt": {
238
+ "default": "",
239
+ "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).",
240
+ "maxLength": 50000,
241
+ "title": "System Prompt",
242
+ "type": "string"
243
+ },
244
+ "thinking_level": {
245
+ "anyOf": [
246
+ {
247
+ "enum": [
248
+ "minimal",
249
+ "medium",
250
+ "high"
251
+ ],
252
+ "type": "string"
253
+ },
254
+ {
255
+ "type": "null"
256
+ }
257
+ ],
258
+ "default": "medium",
259
+ "description": "How much the model reasons before generating. Higher levels can improve complex compositions and use more thinking tokens.",
260
+ "title": "Thinking Level"
261
+ },
262
+ "video_url": {
263
+ "anyOf": [
264
+ {
265
+ "type": "string"
266
+ },
267
+ {
268
+ "type": "null"
269
+ }
270
+ ],
271
+ "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).",
272
+ "title": "Video URL"
273
+ }
274
+ },
275
+ "required": [
276
+ "prompt"
277
+ ],
278
+ "title": "NanoBanana21ImageToImageInput",
279
+ "type": "object",
280
+ "x-fal-order-properties": [
281
+ "prompt",
282
+ "num_images",
283
+ "seed",
284
+ "aspect_ratio",
285
+ "output_format",
286
+ "safety_tolerance",
287
+ "sync_mode",
288
+ "image_urls",
289
+ "system_prompt",
290
+ "resolution",
291
+ "video_url",
292
+ "pdf_url",
293
+ "limit_generations",
294
+ "enable_web_search",
295
+ "thinking_level"
296
+ ]
297
+ },
298
+ "NanoBanana21EditOutput": {
299
+ "properties": {
300
+ "description": {
301
+ "description": "The description of the generated images.",
302
+ "title": "Description",
303
+ "type": "string"
304
+ },
305
+ "images": {
306
+ "description": "The edited images.",
307
+ "examples": [
308
+ [
309
+ {
310
+ "content_type": "image/png",
311
+ "file_name": "nano-banana-multi-edit-output.png",
312
+ "url": "https://storage.googleapis.com/falserverless/example_outputs/nano-banana-multi-edit-output.png"
313
+ }
314
+ ]
315
+ ],
316
+ "items": {
317
+ "$ref": "#/components/schemas/ImageFile"
318
+ },
319
+ "title": "Images",
320
+ "type": "array"
321
+ }
322
+ },
323
+ "required": [
324
+ "images",
325
+ "description"
326
+ ],
327
+ "title": "NanoBanana21ImageToImageOutput",
328
+ "type": "object",
329
+ "x-fal-order-properties": [
330
+ "images",
331
+ "description"
332
+ ]
333
+ },
334
+ "QueueStatus": {
335
+ "properties": {
336
+ "cancel_url": {
337
+ "description": "The cancel url.",
338
+ "type": "string"
339
+ },
340
+ "logs": {
341
+ "additionalProperties": true,
342
+ "description": "The logs.",
343
+ "type": "object"
344
+ },
345
+ "metrics": {
346
+ "additionalProperties": true,
347
+ "description": "The metrics.",
348
+ "type": "object"
349
+ },
350
+ "queue_position": {
351
+ "description": "The queue position.",
352
+ "type": "integer"
353
+ },
354
+ "request_id": {
355
+ "description": "The request id.",
356
+ "type": "string"
357
+ },
358
+ "response_url": {
359
+ "description": "The response url.",
360
+ "type": "string"
361
+ },
362
+ "status": {
363
+ "enum": [
364
+ "IN_QUEUE",
365
+ "IN_PROGRESS",
366
+ "COMPLETED"
367
+ ],
368
+ "type": "string"
369
+ },
370
+ "status_url": {
371
+ "description": "The status url.",
372
+ "type": "string"
373
+ }
374
+ },
375
+ "required": [
376
+ "status",
377
+ "request_id"
378
+ ],
379
+ "type": "object"
380
+ }
381
+ },
382
+ "securitySchemes": {
383
+ "apiKeyAuth": {
384
+ "description": "Fal Key",
385
+ "in": "header",
386
+ "name": "Authorization",
387
+ "type": "apiKey"
388
+ }
389
+ }
390
+ },
391
+ "info": {
392
+ "description": "The OpenAPI schema for the google/nano-banana-2.1/edit queue.",
393
+ "title": "Queue OpenAPI for google/nano-banana-2.1/edit",
394
+ "version": "1.0.0",
395
+ "x-fal-metadata": {
396
+ "about": "Nano Banana 2.1 is an image editing model that edits images from text descriptions.",
397
+ "category": "image-to-image",
398
+ "documentationUrl": "https://fal.ai/models/google/nano-banana-2.1/edit/api",
399
+ "endpointId": "google/nano-banana-2.1/edit",
400
+ "playgroundUrl": "https://fal.ai/models/google/nano-banana-2.1/edit",
401
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0aaad14e/urvX9oiQqWKRcaZngAlID.jpg"
402
+ }
403
+ },
404
+ "openapi": "3.1.0",
405
+ "paths": {
406
+ "/google/nano-banana-2.1/edit": {
407
+ "post": {
408
+ "requestBody": {
409
+ "content": {
410
+ "application/json": {
411
+ "schema": {
412
+ "$ref": "#/components/schemas/NanoBanana21EditInput"
413
+ }
414
+ }
415
+ },
416
+ "required": true
417
+ },
418
+ "responses": {
419
+ "200": {
420
+ "content": {
421
+ "application/json": {
422
+ "schema": {
423
+ "$ref": "#/components/schemas/QueueStatus"
424
+ }
425
+ }
426
+ },
427
+ "description": "The request status."
428
+ }
429
+ }
430
+ }
431
+ },
432
+ "/google/nano-banana-2.1/edit/requests/{request_id}": {
433
+ "get": {
434
+ "parameters": [
435
+ {
436
+ "in": "path",
437
+ "name": "request_id",
438
+ "required": true,
439
+ "schema": {
440
+ "description": "Request ID",
441
+ "type": "string"
442
+ }
443
+ }
444
+ ],
445
+ "responses": {
446
+ "200": {
447
+ "content": {
448
+ "application/json": {
449
+ "schema": {
450
+ "$ref": "#/components/schemas/NanoBanana21EditOutput"
451
+ }
452
+ }
453
+ },
454
+ "description": "Result of the request."
455
+ }
456
+ }
457
+ }
458
+ },
459
+ "/google/nano-banana-2.1/edit/requests/{request_id}/cancel": {
460
+ "put": {
461
+ "parameters": [
462
+ {
463
+ "in": "path",
464
+ "name": "request_id",
465
+ "required": true,
466
+ "schema": {
467
+ "description": "Request ID",
468
+ "type": "string"
469
+ }
470
+ }
471
+ ],
472
+ "responses": {
473
+ "200": {
474
+ "content": {
475
+ "application/json": {
476
+ "schema": {
477
+ "properties": {
478
+ "success": {
479
+ "description": "Whether the request was cancelled successfully.",
480
+ "type": "boolean"
481
+ }
482
+ },
483
+ "type": "object"
484
+ }
485
+ }
486
+ },
487
+ "description": "The request was cancelled."
488
+ }
489
+ }
490
+ }
491
+ },
492
+ "/google/nano-banana-2.1/edit/requests/{request_id}/status": {
493
+ "get": {
494
+ "parameters": [
495
+ {
496
+ "in": "path",
497
+ "name": "request_id",
498
+ "required": true,
499
+ "schema": {
500
+ "description": "Request ID",
501
+ "type": "string"
502
+ }
503
+ },
504
+ {
505
+ "in": "query",
506
+ "name": "logs",
507
+ "required": false,
508
+ "schema": {
509
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
510
+ "type": "number"
511
+ }
512
+ }
513
+ ],
514
+ "responses": {
515
+ "200": {
516
+ "content": {
517
+ "application/json": {
518
+ "schema": {
519
+ "$ref": "#/components/schemas/QueueStatus"
520
+ }
521
+ }
522
+ },
523
+ "description": "The request status."
524
+ }
525
+ }
526
+ }
527
+ }
528
+ },
529
+ "security": [
530
+ {
531
+ "apiKeyAuth": []
532
+ }
533
+ ],
534
+ "servers": [
535
+ {
536
+ "url": "https://queue.fal.run"
537
+ }
538
+ ]
539
+ }
pipeline/fal_schemas/ideogram__v4.5__edit.json ADDED
@@ -0,0 +1,537 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "ContextWindowBox": {
5
+ "properties": {
6
+ "x_max": {
7
+ "description": "Right edge in source pixels (exclusive).",
8
+ "minimum": 0,
9
+ "title": "X Max",
10
+ "type": "integer"
11
+ },
12
+ "x_min": {
13
+ "description": "Left edge in source pixels (inclusive).",
14
+ "minimum": 0,
15
+ "title": "X Min",
16
+ "type": "integer"
17
+ },
18
+ "y_max": {
19
+ "description": "Bottom edge in source pixels (exclusive).",
20
+ "minimum": 0,
21
+ "title": "Y Max",
22
+ "type": "integer"
23
+ },
24
+ "y_min": {
25
+ "description": "Top edge in source pixels (inclusive).",
26
+ "minimum": 0,
27
+ "title": "Y Min",
28
+ "type": "integer"
29
+ }
30
+ },
31
+ "required": [
32
+ "x_min",
33
+ "y_min",
34
+ "x_max",
35
+ "y_max"
36
+ ],
37
+ "title": "ContextWindowBox",
38
+ "type": "object",
39
+ "x-fal-order-properties": [
40
+ "x_min",
41
+ "y_min",
42
+ "x_max",
43
+ "y_max"
44
+ ]
45
+ },
46
+ "File": {
47
+ "properties": {
48
+ "content_type": {
49
+ "anyOf": [
50
+ {
51
+ "type": "string"
52
+ },
53
+ {
54
+ "type": "null"
55
+ }
56
+ ],
57
+ "description": "The mime type of the file.",
58
+ "examples": [
59
+ "image/png"
60
+ ],
61
+ "title": "Content Type"
62
+ },
63
+ "file_name": {
64
+ "anyOf": [
65
+ {
66
+ "type": "string"
67
+ },
68
+ {
69
+ "type": "null"
70
+ }
71
+ ],
72
+ "description": "The name of the file. It will be auto-generated if not provided.",
73
+ "examples": [
74
+ "z9RV14K95DvU.png"
75
+ ],
76
+ "title": "File Name"
77
+ },
78
+ "file_size": {
79
+ "anyOf": [
80
+ {
81
+ "type": "integer"
82
+ },
83
+ {
84
+ "type": "null"
85
+ }
86
+ ],
87
+ "description": "The size of the file in bytes.",
88
+ "examples": [
89
+ 4404019
90
+ ],
91
+ "title": "File Size"
92
+ },
93
+ "url": {
94
+ "description": "The URL where the file can be downloaded from.",
95
+ "title": "Url",
96
+ "type": "string"
97
+ }
98
+ },
99
+ "required": [
100
+ "url"
101
+ ],
102
+ "title": "File",
103
+ "type": "object",
104
+ "x-fal-order-properties": [
105
+ "url",
106
+ "content_type",
107
+ "file_name",
108
+ "file_size"
109
+ ]
110
+ },
111
+ "ImageSize": {
112
+ "properties": {
113
+ "height": {
114
+ "default": 512,
115
+ "description": "The height of the generated image.",
116
+ "exclusiveMinimum": 0,
117
+ "maximum": 14142,
118
+ "title": "Height",
119
+ "type": "integer"
120
+ },
121
+ "width": {
122
+ "default": 512,
123
+ "description": "The width of the generated image.",
124
+ "exclusiveMinimum": 0,
125
+ "maximum": 14142,
126
+ "title": "Width",
127
+ "type": "integer"
128
+ }
129
+ },
130
+ "title": "ImageSize",
131
+ "type": "object",
132
+ "x-fal-order-properties": [
133
+ "width",
134
+ "height"
135
+ ]
136
+ },
137
+ "QueueStatus": {
138
+ "properties": {
139
+ "cancel_url": {
140
+ "description": "The cancel url.",
141
+ "type": "string"
142
+ },
143
+ "logs": {
144
+ "additionalProperties": true,
145
+ "description": "The logs.",
146
+ "type": "object"
147
+ },
148
+ "metrics": {
149
+ "additionalProperties": true,
150
+ "description": "The metrics.",
151
+ "type": "object"
152
+ },
153
+ "queue_position": {
154
+ "description": "The queue position.",
155
+ "type": "integer"
156
+ },
157
+ "request_id": {
158
+ "description": "The request id.",
159
+ "type": "string"
160
+ },
161
+ "response_url": {
162
+ "description": "The response url.",
163
+ "type": "string"
164
+ },
165
+ "status": {
166
+ "enum": [
167
+ "IN_QUEUE",
168
+ "IN_PROGRESS",
169
+ "COMPLETED"
170
+ ],
171
+ "type": "string"
172
+ },
173
+ "status_url": {
174
+ "description": "The status url.",
175
+ "type": "string"
176
+ }
177
+ },
178
+ "required": [
179
+ "status",
180
+ "request_id"
181
+ ],
182
+ "type": "object"
183
+ },
184
+ "V45EditInput": {
185
+ "additionalProperties": false,
186
+ "properties": {
187
+ "context_window": {
188
+ "default": "none",
189
+ "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.",
190
+ "enum": [
191
+ "none",
192
+ "auto"
193
+ ],
194
+ "title": "Context Window",
195
+ "type": "string"
196
+ },
197
+ "context_window_box": {
198
+ "anyOf": [
199
+ {
200
+ "$ref": "#/components/schemas/ContextWindowBox"
201
+ },
202
+ {
203
+ "type": "null"
204
+ }
205
+ ],
206
+ "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."
207
+ },
208
+ "edit_precision": {
209
+ "default": "regular",
210
+ "description": "regular uses Generate; high uses Precise Edit with unchanged-pixel restoration. Both always prepare structured edit instructions.",
211
+ "enum": [
212
+ "regular",
213
+ "high"
214
+ ],
215
+ "title": "Edit Precision",
216
+ "type": "string"
217
+ },
218
+ "enable_safety_checker": {
219
+ "default": true,
220
+ "description": "Authorized callers may set false to request relaxed screening.",
221
+ "title": "Enable Safety Checker",
222
+ "type": "boolean"
223
+ },
224
+ "image_size": {
225
+ "anyOf": [
226
+ {
227
+ "$ref": "#/components/schemas/ImageSize"
228
+ },
229
+ {
230
+ "enum": [
231
+ "auto",
232
+ "square",
233
+ "square_hd",
234
+ "portrait_4_3",
235
+ "landscape_4_3",
236
+ "portrait_16_9",
237
+ "landscape_16_9"
238
+ ],
239
+ "type": "string"
240
+ }
241
+ ],
242
+ "default": "auto",
243
+ "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.",
244
+ "title": "Image Size"
245
+ },
246
+ "image_url": {
247
+ "description": "Primary source image to edit.",
248
+ "title": "Image URL",
249
+ "type": "string"
250
+ },
251
+ "mask_url": {
252
+ "anyOf": [
253
+ {
254
+ "type": "string"
255
+ },
256
+ {
257
+ "type": "null"
258
+ }
259
+ ],
260
+ "description": "Mask matching the source dimensions. Black edits, white preserves. Must contain both regions after rounding.",
261
+ "title": "Mask URL"
262
+ },
263
+ "num_images": {
264
+ "default": 1,
265
+ "description": "Number of images to generate.",
266
+ "maximum": 8,
267
+ "minimum": 1,
268
+ "title": "Number of Images",
269
+ "type": "integer"
270
+ },
271
+ "prompt": {
272
+ "description": "The generation or editing prompt.",
273
+ "examples": [
274
+ "A colorful storefront with a sign reading hello"
275
+ ],
276
+ "maxLength": 10000,
277
+ "minLength": 1,
278
+ "title": "Prompt",
279
+ "type": "string"
280
+ },
281
+ "quality": {
282
+ "default": "medium",
283
+ "description": "Quality tier for either edit precision. Defaults to medium.",
284
+ "enum": [
285
+ "very_low",
286
+ "low",
287
+ "medium",
288
+ "high"
289
+ ],
290
+ "title": "Quality",
291
+ "type": "string"
292
+ },
293
+ "reference_image_urls": {
294
+ "description": "Up to four references plus the primary source, or three references plus the primary source and mask.",
295
+ "items": {
296
+ "type": "string"
297
+ },
298
+ "maxItems": 4,
299
+ "title": "Reference Image URLs",
300
+ "type": "array"
301
+ },
302
+ "seed": {
303
+ "anyOf": [
304
+ {
305
+ "type": "integer"
306
+ },
307
+ {
308
+ "type": "null"
309
+ }
310
+ ],
311
+ "description": "Random seed. Omit to choose automatically.",
312
+ "title": "Seed"
313
+ },
314
+ "sync_mode": {
315
+ "default": false,
316
+ "description": "Return image data directly in the response.",
317
+ "title": "Sync Mode",
318
+ "type": "boolean"
319
+ }
320
+ },
321
+ "required": [
322
+ "prompt",
323
+ "image_url"
324
+ ],
325
+ "title": "EditInputV45",
326
+ "type": "object",
327
+ "x-fal-order-properties": [
328
+ "prompt",
329
+ "image_url",
330
+ "reference_image_urls",
331
+ "mask_url",
332
+ "edit_precision",
333
+ "context_window",
334
+ "context_window_box",
335
+ "quality",
336
+ "image_size",
337
+ "num_images",
338
+ "seed",
339
+ "sync_mode",
340
+ "enable_safety_checker"
341
+ ]
342
+ },
343
+ "V45EditOutput": {
344
+ "properties": {
345
+ "images": {
346
+ "examples": [
347
+ [
348
+ {
349
+ "url": "https://v3.fal.media/files/penguin/lHdRabS80guysb8Zw1kul_image.png"
350
+ }
351
+ ]
352
+ ],
353
+ "items": {
354
+ "$ref": "#/components/schemas/File"
355
+ },
356
+ "title": "Images",
357
+ "type": "array"
358
+ },
359
+ "seed": {
360
+ "description": "Seed used for the random number generator",
361
+ "examples": [
362
+ 123456
363
+ ],
364
+ "title": "Seed",
365
+ "type": "integer"
366
+ }
367
+ },
368
+ "required": [
369
+ "images",
370
+ "seed"
371
+ ],
372
+ "title": "OutputV3",
373
+ "type": "object",
374
+ "x-fal-order-properties": [
375
+ "images",
376
+ "seed"
377
+ ]
378
+ }
379
+ },
380
+ "securitySchemes": {
381
+ "apiKeyAuth": {
382
+ "description": "Fal Key",
383
+ "in": "header",
384
+ "name": "Authorization",
385
+ "type": "apiKey"
386
+ }
387
+ }
388
+ },
389
+ "info": {
390
+ "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).",
391
+ "title": "Queue OpenAPI for ideogram/v4.5/edit",
392
+ "version": "1.0.0",
393
+ "x-fal-metadata": {
394
+ "about": "Ideogram V45 Edit",
395
+ "category": "image-to-image",
396
+ "documentationUrl": "https://fal.ai/models/ideogram/v4.5/edit/api",
397
+ "endpointId": "ideogram/v4.5/edit",
398
+ "playgroundUrl": "https://fal.ai/models/ideogram/v4.5/edit",
399
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0aac785d/9OnZ_rkZGyh50x2626HB9.jpg"
400
+ }
401
+ },
402
+ "openapi": "3.1.0",
403
+ "paths": {
404
+ "/ideogram/v4.5/edit": {
405
+ "post": {
406
+ "requestBody": {
407
+ "content": {
408
+ "application/json": {
409
+ "schema": {
410
+ "$ref": "#/components/schemas/V45EditInput"
411
+ }
412
+ }
413
+ },
414
+ "required": true
415
+ },
416
+ "responses": {
417
+ "200": {
418
+ "content": {
419
+ "application/json": {
420
+ "schema": {
421
+ "$ref": "#/components/schemas/QueueStatus"
422
+ }
423
+ }
424
+ },
425
+ "description": "The request status."
426
+ }
427
+ }
428
+ }
429
+ },
430
+ "/ideogram/v4.5/edit/requests/{request_id}": {
431
+ "get": {
432
+ "parameters": [
433
+ {
434
+ "in": "path",
435
+ "name": "request_id",
436
+ "required": true,
437
+ "schema": {
438
+ "description": "Request ID",
439
+ "type": "string"
440
+ }
441
+ }
442
+ ],
443
+ "responses": {
444
+ "200": {
445
+ "content": {
446
+ "application/json": {
447
+ "schema": {
448
+ "$ref": "#/components/schemas/V45EditOutput"
449
+ }
450
+ }
451
+ },
452
+ "description": "Result of the request."
453
+ }
454
+ }
455
+ }
456
+ },
457
+ "/ideogram/v4.5/edit/requests/{request_id}/cancel": {
458
+ "put": {
459
+ "parameters": [
460
+ {
461
+ "in": "path",
462
+ "name": "request_id",
463
+ "required": true,
464
+ "schema": {
465
+ "description": "Request ID",
466
+ "type": "string"
467
+ }
468
+ }
469
+ ],
470
+ "responses": {
471
+ "200": {
472
+ "content": {
473
+ "application/json": {
474
+ "schema": {
475
+ "properties": {
476
+ "success": {
477
+ "description": "Whether the request was cancelled successfully.",
478
+ "type": "boolean"
479
+ }
480
+ },
481
+ "type": "object"
482
+ }
483
+ }
484
+ },
485
+ "description": "The request was cancelled."
486
+ }
487
+ }
488
+ }
489
+ },
490
+ "/ideogram/v4.5/edit/requests/{request_id}/status": {
491
+ "get": {
492
+ "parameters": [
493
+ {
494
+ "in": "path",
495
+ "name": "request_id",
496
+ "required": true,
497
+ "schema": {
498
+ "description": "Request ID",
499
+ "type": "string"
500
+ }
501
+ },
502
+ {
503
+ "in": "query",
504
+ "name": "logs",
505
+ "required": false,
506
+ "schema": {
507
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
508
+ "type": "number"
509
+ }
510
+ }
511
+ ],
512
+ "responses": {
513
+ "200": {
514
+ "content": {
515
+ "application/json": {
516
+ "schema": {
517
+ "$ref": "#/components/schemas/QueueStatus"
518
+ }
519
+ }
520
+ },
521
+ "description": "The request status."
522
+ }
523
+ }
524
+ }
525
+ }
526
+ },
527
+ "security": [
528
+ {
529
+ "apiKeyAuth": []
530
+ }
531
+ ],
532
+ "servers": [
533
+ {
534
+ "url": "https://queue.fal.run"
535
+ }
536
+ ]
537
+ }
pipeline/fal_schemas/luma__agent__uni-1__v1__max__edit.json ADDED
@@ -0,0 +1,378 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "AgentUni1V1MaxEditInput": {
5
+ "properties": {
6
+ "enable_safety_checker": {
7
+ "default": true,
8
+ "description": "Authorized callers may set false to request relaxed screening.",
9
+ "title": "Enable Safety Checker",
10
+ "type": "boolean"
11
+ },
12
+ "image_url": {
13
+ "description": "URL of the source image to edit.",
14
+ "examples": [
15
+ "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png"
16
+ ],
17
+ "title": "Image Url",
18
+ "type": "string"
19
+ },
20
+ "output_format": {
21
+ "anyOf": [
22
+ {
23
+ "enum": [
24
+ "png",
25
+ "jpeg"
26
+ ],
27
+ "type": "string"
28
+ },
29
+ {
30
+ "type": "null"
31
+ }
32
+ ],
33
+ "description": "Encoding format of the edited image.",
34
+ "title": "Output Format"
35
+ },
36
+ "prompt": {
37
+ "description": "Text prompt describing the edit to apply.",
38
+ "examples": [
39
+ "Replace the background with a sunset over the ocean."
40
+ ],
41
+ "maxLength": 6000,
42
+ "minLength": 1,
43
+ "title": "Prompt",
44
+ "type": "string"
45
+ },
46
+ "reference_image_urls": {
47
+ "anyOf": [
48
+ {
49
+ "items": {
50
+ "type": "string"
51
+ },
52
+ "maxItems": 8,
53
+ "type": "array"
54
+ },
55
+ {
56
+ "type": "null"
57
+ }
58
+ ],
59
+ "description": "Optional list of reference image URLs used to guide the edit.",
60
+ "title": "Reference Image Urls"
61
+ },
62
+ "style": {
63
+ "default": "auto",
64
+ "description": "Visual style of the edited image.",
65
+ "enum": [
66
+ "auto",
67
+ "manga"
68
+ ],
69
+ "title": "Style",
70
+ "type": "string"
71
+ }
72
+ },
73
+ "required": [
74
+ "prompt",
75
+ "image_url"
76
+ ],
77
+ "title": "ImageEditRequest",
78
+ "type": "object",
79
+ "x-fal-order-properties": [
80
+ "prompt",
81
+ "image_url",
82
+ "style",
83
+ "output_format",
84
+ "reference_image_urls",
85
+ "enable_safety_checker"
86
+ ]
87
+ },
88
+ "AgentUni1V1MaxEditOutput": {
89
+ "properties": {
90
+ "images": {
91
+ "description": "The generated image(s).",
92
+ "items": {
93
+ "$ref": "#/components/schemas/File"
94
+ },
95
+ "title": "Images",
96
+ "type": "array"
97
+ }
98
+ },
99
+ "required": [
100
+ "images"
101
+ ],
102
+ "title": "ImageOutput",
103
+ "type": "object",
104
+ "x-fal-order-properties": [
105
+ "images"
106
+ ]
107
+ },
108
+ "File": {
109
+ "properties": {
110
+ "content_type": {
111
+ "anyOf": [
112
+ {
113
+ "type": "string"
114
+ },
115
+ {
116
+ "type": "null"
117
+ }
118
+ ],
119
+ "description": "The mime type of the file.",
120
+ "examples": [
121
+ "image/png"
122
+ ],
123
+ "title": "Content Type"
124
+ },
125
+ "file_name": {
126
+ "anyOf": [
127
+ {
128
+ "type": "string"
129
+ },
130
+ {
131
+ "type": "null"
132
+ }
133
+ ],
134
+ "description": "The name of the file. It will be auto-generated if not provided.",
135
+ "examples": [
136
+ "z9RV14K95DvU.png"
137
+ ],
138
+ "title": "File Name"
139
+ },
140
+ "file_size": {
141
+ "anyOf": [
142
+ {
143
+ "type": "integer"
144
+ },
145
+ {
146
+ "type": "null"
147
+ }
148
+ ],
149
+ "description": "The size of the file in bytes.",
150
+ "examples": [
151
+ 4404019
152
+ ],
153
+ "title": "File Size"
154
+ },
155
+ "url": {
156
+ "description": "The URL where the file can be downloaded from.",
157
+ "title": "Url",
158
+ "type": "string"
159
+ }
160
+ },
161
+ "required": [
162
+ "url"
163
+ ],
164
+ "title": "File",
165
+ "type": "object",
166
+ "x-fal-order-properties": [
167
+ "url",
168
+ "content_type",
169
+ "file_name",
170
+ "file_size"
171
+ ]
172
+ },
173
+ "QueueStatus": {
174
+ "properties": {
175
+ "cancel_url": {
176
+ "description": "The cancel url.",
177
+ "type": "string"
178
+ },
179
+ "logs": {
180
+ "additionalProperties": true,
181
+ "description": "The logs.",
182
+ "type": "object"
183
+ },
184
+ "metrics": {
185
+ "additionalProperties": true,
186
+ "description": "The metrics.",
187
+ "type": "object"
188
+ },
189
+ "queue_position": {
190
+ "description": "The queue position.",
191
+ "type": "integer"
192
+ },
193
+ "request_id": {
194
+ "description": "The request id.",
195
+ "type": "string"
196
+ },
197
+ "response_url": {
198
+ "description": "The response url.",
199
+ "type": "string"
200
+ },
201
+ "status": {
202
+ "enum": [
203
+ "IN_QUEUE",
204
+ "IN_PROGRESS",
205
+ "COMPLETED"
206
+ ],
207
+ "type": "string"
208
+ },
209
+ "status_url": {
210
+ "description": "The status url.",
211
+ "type": "string"
212
+ }
213
+ },
214
+ "required": [
215
+ "status",
216
+ "request_id"
217
+ ],
218
+ "type": "object"
219
+ }
220
+ },
221
+ "securitySchemes": {
222
+ "apiKeyAuth": {
223
+ "description": "Fal Key",
224
+ "in": "header",
225
+ "name": "Authorization",
226
+ "type": "apiKey"
227
+ }
228
+ }
229
+ },
230
+ "info": {
231
+ "description": "The OpenAPI schema for the luma/agent/uni-1/v1/max/edit queue.",
232
+ "title": "Queue OpenAPI for luma/agent/uni-1/v1/max/edit",
233
+ "version": "1.0.0",
234
+ "x-fal-metadata": {
235
+ "about": "Edit Image Max",
236
+ "category": "image-to-image",
237
+ "documentationUrl": "https://fal.ai/models/luma/agent/uni-1/v1/max/edit/api",
238
+ "endpointId": "luma/agent/uni-1/v1/max/edit",
239
+ "playgroundUrl": "https://fal.ai/models/luma/agent/uni-1/v1/max/edit",
240
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0a9d98fd/-vUZCkQbk_HxqDUKgcvo6_6b69ed5b53c74a6ba900168b8ad17e71.jpg"
241
+ }
242
+ },
243
+ "openapi": "3.1.0",
244
+ "paths": {
245
+ "/luma/agent/uni-1/v1/max/edit": {
246
+ "post": {
247
+ "requestBody": {
248
+ "content": {
249
+ "application/json": {
250
+ "schema": {
251
+ "$ref": "#/components/schemas/AgentUni1V1MaxEditInput"
252
+ }
253
+ }
254
+ },
255
+ "required": true
256
+ },
257
+ "responses": {
258
+ "200": {
259
+ "content": {
260
+ "application/json": {
261
+ "schema": {
262
+ "$ref": "#/components/schemas/QueueStatus"
263
+ }
264
+ }
265
+ },
266
+ "description": "The request status."
267
+ }
268
+ }
269
+ }
270
+ },
271
+ "/luma/agent/uni-1/v1/max/edit/requests/{request_id}": {
272
+ "get": {
273
+ "parameters": [
274
+ {
275
+ "in": "path",
276
+ "name": "request_id",
277
+ "required": true,
278
+ "schema": {
279
+ "description": "Request ID",
280
+ "type": "string"
281
+ }
282
+ }
283
+ ],
284
+ "responses": {
285
+ "200": {
286
+ "content": {
287
+ "application/json": {
288
+ "schema": {
289
+ "$ref": "#/components/schemas/AgentUni1V1MaxEditOutput"
290
+ }
291
+ }
292
+ },
293
+ "description": "Result of the request."
294
+ }
295
+ }
296
+ }
297
+ },
298
+ "/luma/agent/uni-1/v1/max/edit/requests/{request_id}/cancel": {
299
+ "put": {
300
+ "parameters": [
301
+ {
302
+ "in": "path",
303
+ "name": "request_id",
304
+ "required": true,
305
+ "schema": {
306
+ "description": "Request ID",
307
+ "type": "string"
308
+ }
309
+ }
310
+ ],
311
+ "responses": {
312
+ "200": {
313
+ "content": {
314
+ "application/json": {
315
+ "schema": {
316
+ "properties": {
317
+ "success": {
318
+ "description": "Whether the request was cancelled successfully.",
319
+ "type": "boolean"
320
+ }
321
+ },
322
+ "type": "object"
323
+ }
324
+ }
325
+ },
326
+ "description": "The request was cancelled."
327
+ }
328
+ }
329
+ }
330
+ },
331
+ "/luma/agent/uni-1/v1/max/edit/requests/{request_id}/status": {
332
+ "get": {
333
+ "parameters": [
334
+ {
335
+ "in": "path",
336
+ "name": "request_id",
337
+ "required": true,
338
+ "schema": {
339
+ "description": "Request ID",
340
+ "type": "string"
341
+ }
342
+ },
343
+ {
344
+ "in": "query",
345
+ "name": "logs",
346
+ "required": false,
347
+ "schema": {
348
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
349
+ "type": "number"
350
+ }
351
+ }
352
+ ],
353
+ "responses": {
354
+ "200": {
355
+ "content": {
356
+ "application/json": {
357
+ "schema": {
358
+ "$ref": "#/components/schemas/QueueStatus"
359
+ }
360
+ }
361
+ },
362
+ "description": "The request status."
363
+ }
364
+ }
365
+ }
366
+ }
367
+ },
368
+ "security": [
369
+ {
370
+ "apiKeyAuth": []
371
+ }
372
+ ],
373
+ "servers": [
374
+ {
375
+ "url": "https://queue.fal.run"
376
+ }
377
+ ]
378
+ }
pipeline/fal_schemas/meta__muse-image__edit.json ADDED
@@ -0,0 +1,410 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "Image": {
5
+ "description": "Represents an image file.",
6
+ "properties": {
7
+ "content_type": {
8
+ "anyOf": [
9
+ {
10
+ "type": "string"
11
+ },
12
+ {
13
+ "type": "null"
14
+ }
15
+ ],
16
+ "description": "The mime type of the file.",
17
+ "examples": [
18
+ "image/png"
19
+ ],
20
+ "title": "Content Type"
21
+ },
22
+ "file_name": {
23
+ "anyOf": [
24
+ {
25
+ "type": "string"
26
+ },
27
+ {
28
+ "type": "null"
29
+ }
30
+ ],
31
+ "description": "The name of the file. It will be auto-generated if not provided.",
32
+ "examples": [
33
+ "z9RV14K95DvU.png"
34
+ ],
35
+ "title": "File Name"
36
+ },
37
+ "file_size": {
38
+ "anyOf": [
39
+ {
40
+ "type": "integer"
41
+ },
42
+ {
43
+ "type": "null"
44
+ }
45
+ ],
46
+ "description": "The size of the file in bytes.",
47
+ "examples": [
48
+ 4404019
49
+ ],
50
+ "title": "File Size"
51
+ },
52
+ "height": {
53
+ "anyOf": [
54
+ {
55
+ "type": "integer"
56
+ },
57
+ {
58
+ "type": "null"
59
+ }
60
+ ],
61
+ "description": "The height of the image in pixels.",
62
+ "examples": [
63
+ 1024
64
+ ],
65
+ "title": "Height"
66
+ },
67
+ "url": {
68
+ "description": "The URL where the file can be downloaded from.",
69
+ "title": "Url",
70
+ "type": "string"
71
+ },
72
+ "width": {
73
+ "anyOf": [
74
+ {
75
+ "type": "integer"
76
+ },
77
+ {
78
+ "type": "null"
79
+ }
80
+ ],
81
+ "description": "The width of the image in pixels.",
82
+ "examples": [
83
+ 1024
84
+ ],
85
+ "title": "Width"
86
+ }
87
+ },
88
+ "required": [
89
+ "url"
90
+ ],
91
+ "title": "Image",
92
+ "type": "object",
93
+ "x-fal-order-properties": [
94
+ "url",
95
+ "content_type",
96
+ "file_name",
97
+ "file_size",
98
+ "width",
99
+ "height"
100
+ ]
101
+ },
102
+ "MuseImageEditInput": {
103
+ "properties": {
104
+ "aspect_ratio": {
105
+ "anyOf": [
106
+ {
107
+ "pattern": "^[1-9][0-9]{0,4}:[1-9][0-9]{0,4}$",
108
+ "type": "string"
109
+ },
110
+ {
111
+ "type": "null"
112
+ }
113
+ ],
114
+ "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.",
115
+ "examples": [
116
+ "16:9"
117
+ ],
118
+ "title": "Aspect Ratio"
119
+ },
120
+ "image_urls": {
121
+ "description": "Reference images used for the edit. Provide between 1 and 10 HTTP(S) or data URLs.",
122
+ "examples": [
123
+ [
124
+ "https://storage.googleapis.com/falserverless/example_inputs/kontext_example_input.webp"
125
+ ]
126
+ ],
127
+ "items": {
128
+ "type": "string"
129
+ },
130
+ "maxItems": 10,
131
+ "minItems": 1,
132
+ "title": "Image URLs",
133
+ "type": "array"
134
+ },
135
+ "num_images": {
136
+ "default": 1,
137
+ "description": "The number of edited images to generate.",
138
+ "maximum": 10,
139
+ "minimum": 1,
140
+ "title": "Num Images",
141
+ "type": "integer"
142
+ },
143
+ "output_format": {
144
+ "default": "webp",
145
+ "description": "The format of the generated image.",
146
+ "enum": [
147
+ "jpeg",
148
+ "png",
149
+ "webp"
150
+ ],
151
+ "title": "Output Format",
152
+ "type": "string"
153
+ },
154
+ "prompt": {
155
+ "description": "The text prompt used to generate or edit the image.",
156
+ "examples": [
157
+ "A cinematic editorial portrait in soft window light with crisp typography"
158
+ ],
159
+ "minLength": 1,
160
+ "title": "Prompt",
161
+ "type": "string"
162
+ },
163
+ "sync_mode": {
164
+ "default": false,
165
+ "description": "If `True`, the image is returned as a data URI and is not persisted in the request history.",
166
+ "title": "Sync Mode",
167
+ "type": "boolean"
168
+ }
169
+ },
170
+ "required": [
171
+ "prompt",
172
+ "image_urls"
173
+ ],
174
+ "title": "MuseImageEditInput",
175
+ "type": "object",
176
+ "x-fal-order-properties": [
177
+ "prompt",
178
+ "image_urls",
179
+ "aspect_ratio",
180
+ "num_images",
181
+ "output_format",
182
+ "sync_mode"
183
+ ]
184
+ },
185
+ "MuseImageEditOutput": {
186
+ "properties": {
187
+ "images": {
188
+ "description": "The generated or edited images.",
189
+ "items": {
190
+ "$ref": "#/components/schemas/Image"
191
+ },
192
+ "title": "Images",
193
+ "type": "array"
194
+ }
195
+ },
196
+ "required": [
197
+ "images"
198
+ ],
199
+ "title": "MuseImageOutput",
200
+ "type": "object",
201
+ "x-fal-order-properties": [
202
+ "images"
203
+ ]
204
+ },
205
+ "QueueStatus": {
206
+ "properties": {
207
+ "cancel_url": {
208
+ "description": "The cancel url.",
209
+ "type": "string"
210
+ },
211
+ "logs": {
212
+ "additionalProperties": true,
213
+ "description": "The logs.",
214
+ "type": "object"
215
+ },
216
+ "metrics": {
217
+ "additionalProperties": true,
218
+ "description": "The metrics.",
219
+ "type": "object"
220
+ },
221
+ "queue_position": {
222
+ "description": "The queue position.",
223
+ "type": "integer"
224
+ },
225
+ "request_id": {
226
+ "description": "The request id.",
227
+ "type": "string"
228
+ },
229
+ "response_url": {
230
+ "description": "The response url.",
231
+ "type": "string"
232
+ },
233
+ "status": {
234
+ "enum": [
235
+ "IN_QUEUE",
236
+ "IN_PROGRESS",
237
+ "COMPLETED"
238
+ ],
239
+ "type": "string"
240
+ },
241
+ "status_url": {
242
+ "description": "The status url.",
243
+ "type": "string"
244
+ }
245
+ },
246
+ "required": [
247
+ "status",
248
+ "request_id"
249
+ ],
250
+ "type": "object"
251
+ }
252
+ },
253
+ "securitySchemes": {
254
+ "apiKeyAuth": {
255
+ "description": "Fal Key",
256
+ "in": "header",
257
+ "name": "Authorization",
258
+ "type": "apiKey"
259
+ }
260
+ }
261
+ },
262
+ "info": {
263
+ "description": "The OpenAPI schema for the meta/muse-image/edit queue.",
264
+ "title": "Queue OpenAPI for meta/muse-image/edit",
265
+ "version": "1.0.0",
266
+ "x-fal-metadata": {
267
+ "about": "Edit",
268
+ "category": "image-to-image",
269
+ "documentationUrl": "https://fal.ai/models/meta/muse-image/edit/api",
270
+ "endpointId": "meta/muse-image/edit",
271
+ "playgroundUrl": "https://fal.ai/models/meta/muse-image/edit",
272
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0aa743e9/p2RjYTFPCviexLZ_6oYmv.jpg"
273
+ }
274
+ },
275
+ "openapi": "3.1.0",
276
+ "paths": {
277
+ "/meta/muse-image/edit": {
278
+ "post": {
279
+ "requestBody": {
280
+ "content": {
281
+ "application/json": {
282
+ "schema": {
283
+ "$ref": "#/components/schemas/MuseImageEditInput"
284
+ }
285
+ }
286
+ },
287
+ "required": true
288
+ },
289
+ "responses": {
290
+ "200": {
291
+ "content": {
292
+ "application/json": {
293
+ "schema": {
294
+ "$ref": "#/components/schemas/QueueStatus"
295
+ }
296
+ }
297
+ },
298
+ "description": "The request status."
299
+ }
300
+ }
301
+ }
302
+ },
303
+ "/meta/muse-image/edit/requests/{request_id}": {
304
+ "get": {
305
+ "parameters": [
306
+ {
307
+ "in": "path",
308
+ "name": "request_id",
309
+ "required": true,
310
+ "schema": {
311
+ "description": "Request ID",
312
+ "type": "string"
313
+ }
314
+ }
315
+ ],
316
+ "responses": {
317
+ "200": {
318
+ "content": {
319
+ "application/json": {
320
+ "schema": {
321
+ "$ref": "#/components/schemas/MuseImageEditOutput"
322
+ }
323
+ }
324
+ },
325
+ "description": "Result of the request."
326
+ }
327
+ }
328
+ }
329
+ },
330
+ "/meta/muse-image/edit/requests/{request_id}/cancel": {
331
+ "put": {
332
+ "parameters": [
333
+ {
334
+ "in": "path",
335
+ "name": "request_id",
336
+ "required": true,
337
+ "schema": {
338
+ "description": "Request ID",
339
+ "type": "string"
340
+ }
341
+ }
342
+ ],
343
+ "responses": {
344
+ "200": {
345
+ "content": {
346
+ "application/json": {
347
+ "schema": {
348
+ "properties": {
349
+ "success": {
350
+ "description": "Whether the request was cancelled successfully.",
351
+ "type": "boolean"
352
+ }
353
+ },
354
+ "type": "object"
355
+ }
356
+ }
357
+ },
358
+ "description": "The request was cancelled."
359
+ }
360
+ }
361
+ }
362
+ },
363
+ "/meta/muse-image/edit/requests/{request_id}/status": {
364
+ "get": {
365
+ "parameters": [
366
+ {
367
+ "in": "path",
368
+ "name": "request_id",
369
+ "required": true,
370
+ "schema": {
371
+ "description": "Request ID",
372
+ "type": "string"
373
+ }
374
+ },
375
+ {
376
+ "in": "query",
377
+ "name": "logs",
378
+ "required": false,
379
+ "schema": {
380
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
381
+ "type": "number"
382
+ }
383
+ }
384
+ ],
385
+ "responses": {
386
+ "200": {
387
+ "content": {
388
+ "application/json": {
389
+ "schema": {
390
+ "$ref": "#/components/schemas/QueueStatus"
391
+ }
392
+ }
393
+ },
394
+ "description": "The request status."
395
+ }
396
+ }
397
+ }
398
+ }
399
+ },
400
+ "security": [
401
+ {
402
+ "apiKeyAuth": []
403
+ }
404
+ ],
405
+ "servers": [
406
+ {
407
+ "url": "https://queue.fal.run"
408
+ }
409
+ ]
410
+ }
pipeline/fal_schemas/microsoft__mai-image-2.5-pro__edit.json ADDED
@@ -0,0 +1,404 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "ImageFile": {
5
+ "properties": {
6
+ "content_type": {
7
+ "anyOf": [
8
+ {
9
+ "type": "string"
10
+ },
11
+ {
12
+ "type": "null"
13
+ }
14
+ ],
15
+ "description": "The mime type of the file.",
16
+ "examples": [
17
+ "image/png"
18
+ ],
19
+ "title": "Content Type"
20
+ },
21
+ "file_name": {
22
+ "anyOf": [
23
+ {
24
+ "type": "string"
25
+ },
26
+ {
27
+ "type": "null"
28
+ }
29
+ ],
30
+ "description": "The name of the file. It will be auto-generated if not provided.",
31
+ "examples": [
32
+ "z9RV14K95DvU.png"
33
+ ],
34
+ "title": "File Name"
35
+ },
36
+ "file_size": {
37
+ "anyOf": [
38
+ {
39
+ "type": "integer"
40
+ },
41
+ {
42
+ "type": "null"
43
+ }
44
+ ],
45
+ "description": "The size of the file in bytes.",
46
+ "examples": [
47
+ 4404019
48
+ ],
49
+ "title": "File Size"
50
+ },
51
+ "height": {
52
+ "anyOf": [
53
+ {
54
+ "type": "integer"
55
+ },
56
+ {
57
+ "type": "null"
58
+ }
59
+ ],
60
+ "description": "The height of the image",
61
+ "title": "Height"
62
+ },
63
+ "url": {
64
+ "description": "The URL where the file can be downloaded from.",
65
+ "title": "Url",
66
+ "type": "string"
67
+ },
68
+ "width": {
69
+ "anyOf": [
70
+ {
71
+ "type": "integer"
72
+ },
73
+ {
74
+ "type": "null"
75
+ }
76
+ ],
77
+ "description": "The width of the image",
78
+ "title": "Width"
79
+ }
80
+ },
81
+ "required": [
82
+ "url"
83
+ ],
84
+ "title": "ImageFile",
85
+ "type": "object",
86
+ "x-fal-order-properties": [
87
+ "url",
88
+ "content_type",
89
+ "file_name",
90
+ "file_size",
91
+ "width",
92
+ "height"
93
+ ]
94
+ },
95
+ "MaiImage25ProEditInput": {
96
+ "properties": {
97
+ "aspect_ratio": {
98
+ "default": "auto",
99
+ "description": "The aspect ratio of the generated image. Use \"auto\" to match the input or let the model decide.",
100
+ "enum": [
101
+ "auto",
102
+ "1:1",
103
+ "4:3",
104
+ "3:4",
105
+ "16:9",
106
+ "9:16",
107
+ "3:2",
108
+ "2:3"
109
+ ],
110
+ "title": "Aspect Ratio",
111
+ "type": "string"
112
+ },
113
+ "image_url": {
114
+ "default": "",
115
+ "description": "The URL of the image to edit. Provide one http(s) or data: URL.",
116
+ "examples": [
117
+ "https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input.png"
118
+ ],
119
+ "title": "Image URL",
120
+ "type": "string"
121
+ },
122
+ "num_images": {
123
+ "default": 1,
124
+ "description": "The number of images to generate.",
125
+ "maximum": 4,
126
+ "minimum": 1,
127
+ "title": "Number of Images",
128
+ "type": "integer"
129
+ },
130
+ "output_format": {
131
+ "default": "png",
132
+ "description": "The format of the generated image.",
133
+ "enum": [
134
+ "jpeg",
135
+ "png",
136
+ "webp"
137
+ ],
138
+ "title": "Output Format",
139
+ "type": "string"
140
+ },
141
+ "prompt": {
142
+ "description": "The instruction describing how to edit the input image(s).",
143
+ "examples": [
144
+ "Turn this into a clean, futuristic product shot with soft studio lighting."
145
+ ],
146
+ "maxLength": 5000,
147
+ "minLength": 3,
148
+ "title": "Prompt",
149
+ "type": "string"
150
+ },
151
+ "sync_mode": {
152
+ "default": false,
153
+ "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.",
154
+ "title": "Sync Mode",
155
+ "type": "boolean"
156
+ }
157
+ },
158
+ "required": [
159
+ "prompt"
160
+ ],
161
+ "title": "MaiImage25ProImageToImageInput",
162
+ "type": "object",
163
+ "x-fal-order-properties": [
164
+ "prompt",
165
+ "num_images",
166
+ "aspect_ratio",
167
+ "output_format",
168
+ "sync_mode",
169
+ "image_url"
170
+ ]
171
+ },
172
+ "MaiImage25ProEditOutput": {
173
+ "properties": {
174
+ "description": {
175
+ "description": "The description of the generated images.",
176
+ "title": "Description",
177
+ "type": "string"
178
+ },
179
+ "images": {
180
+ "description": "The edited images.",
181
+ "items": {
182
+ "$ref": "#/components/schemas/ImageFile"
183
+ },
184
+ "title": "Images",
185
+ "type": "array"
186
+ }
187
+ },
188
+ "required": [
189
+ "images",
190
+ "description"
191
+ ],
192
+ "title": "MaiImage25ProImageToImageOutput",
193
+ "type": "object",
194
+ "x-fal-order-properties": [
195
+ "images",
196
+ "description"
197
+ ]
198
+ },
199
+ "QueueStatus": {
200
+ "properties": {
201
+ "cancel_url": {
202
+ "description": "The cancel url.",
203
+ "type": "string"
204
+ },
205
+ "logs": {
206
+ "additionalProperties": true,
207
+ "description": "The logs.",
208
+ "type": "object"
209
+ },
210
+ "metrics": {
211
+ "additionalProperties": true,
212
+ "description": "The metrics.",
213
+ "type": "object"
214
+ },
215
+ "queue_position": {
216
+ "description": "The queue position.",
217
+ "type": "integer"
218
+ },
219
+ "request_id": {
220
+ "description": "The request id.",
221
+ "type": "string"
222
+ },
223
+ "response_url": {
224
+ "description": "The response url.",
225
+ "type": "string"
226
+ },
227
+ "status": {
228
+ "enum": [
229
+ "IN_QUEUE",
230
+ "IN_PROGRESS",
231
+ "COMPLETED"
232
+ ],
233
+ "type": "string"
234
+ },
235
+ "status_url": {
236
+ "description": "The status url.",
237
+ "type": "string"
238
+ }
239
+ },
240
+ "required": [
241
+ "status",
242
+ "request_id"
243
+ ],
244
+ "type": "object"
245
+ }
246
+ },
247
+ "securitySchemes": {
248
+ "apiKeyAuth": {
249
+ "description": "Fal Key",
250
+ "in": "header",
251
+ "name": "Authorization",
252
+ "type": "apiKey"
253
+ }
254
+ }
255
+ },
256
+ "info": {
257
+ "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.",
258
+ "title": "Queue OpenAPI for microsoft/mai-image-2.5-pro/edit",
259
+ "version": "1.0.0",
260
+ "x-fal-metadata": {
261
+ "about": "Edit one or more images with MAI-Image-2.5 Pro.",
262
+ "category": "image-to-image",
263
+ "documentationUrl": "https://fal.ai/models/microsoft/mai-image-2.5-pro/edit/api",
264
+ "endpointId": "microsoft/mai-image-2.5-pro/edit",
265
+ "playgroundUrl": "https://fal.ai/models/microsoft/mai-image-2.5-pro/edit",
266
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0aa41899/nk1T8qzlhZ1edxsb1N9YO.jpg"
267
+ }
268
+ },
269
+ "openapi": "3.1.0",
270
+ "paths": {
271
+ "/microsoft/mai-image-2.5-pro/edit": {
272
+ "post": {
273
+ "requestBody": {
274
+ "content": {
275
+ "application/json": {
276
+ "schema": {
277
+ "$ref": "#/components/schemas/MaiImage25ProEditInput"
278
+ }
279
+ }
280
+ },
281
+ "required": true
282
+ },
283
+ "responses": {
284
+ "200": {
285
+ "content": {
286
+ "application/json": {
287
+ "schema": {
288
+ "$ref": "#/components/schemas/QueueStatus"
289
+ }
290
+ }
291
+ },
292
+ "description": "The request status."
293
+ }
294
+ }
295
+ }
296
+ },
297
+ "/microsoft/mai-image-2.5-pro/edit/requests/{request_id}": {
298
+ "get": {
299
+ "parameters": [
300
+ {
301
+ "in": "path",
302
+ "name": "request_id",
303
+ "required": true,
304
+ "schema": {
305
+ "description": "Request ID",
306
+ "type": "string"
307
+ }
308
+ }
309
+ ],
310
+ "responses": {
311
+ "200": {
312
+ "content": {
313
+ "application/json": {
314
+ "schema": {
315
+ "$ref": "#/components/schemas/MaiImage25ProEditOutput"
316
+ }
317
+ }
318
+ },
319
+ "description": "Result of the request."
320
+ }
321
+ }
322
+ }
323
+ },
324
+ "/microsoft/mai-image-2.5-pro/edit/requests/{request_id}/cancel": {
325
+ "put": {
326
+ "parameters": [
327
+ {
328
+ "in": "path",
329
+ "name": "request_id",
330
+ "required": true,
331
+ "schema": {
332
+ "description": "Request ID",
333
+ "type": "string"
334
+ }
335
+ }
336
+ ],
337
+ "responses": {
338
+ "200": {
339
+ "content": {
340
+ "application/json": {
341
+ "schema": {
342
+ "properties": {
343
+ "success": {
344
+ "description": "Whether the request was cancelled successfully.",
345
+ "type": "boolean"
346
+ }
347
+ },
348
+ "type": "object"
349
+ }
350
+ }
351
+ },
352
+ "description": "The request was cancelled."
353
+ }
354
+ }
355
+ }
356
+ },
357
+ "/microsoft/mai-image-2.5-pro/edit/requests/{request_id}/status": {
358
+ "get": {
359
+ "parameters": [
360
+ {
361
+ "in": "path",
362
+ "name": "request_id",
363
+ "required": true,
364
+ "schema": {
365
+ "description": "Request ID",
366
+ "type": "string"
367
+ }
368
+ },
369
+ {
370
+ "in": "query",
371
+ "name": "logs",
372
+ "required": false,
373
+ "schema": {
374
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
375
+ "type": "number"
376
+ }
377
+ }
378
+ ],
379
+ "responses": {
380
+ "200": {
381
+ "content": {
382
+ "application/json": {
383
+ "schema": {
384
+ "$ref": "#/components/schemas/QueueStatus"
385
+ }
386
+ }
387
+ },
388
+ "description": "The request status."
389
+ }
390
+ }
391
+ }
392
+ }
393
+ },
394
+ "security": [
395
+ {
396
+ "apiKeyAuth": []
397
+ }
398
+ ],
399
+ "servers": [
400
+ {
401
+ "url": "https://queue.fal.run"
402
+ }
403
+ ]
404
+ }
pipeline/fal_schemas/openai__gpt-image-2.5__flare__edit.json ADDED
@@ -0,0 +1,512 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "GptImage25FlareEditInput": {
5
+ "description": "GPT Image 2.5 edit inputs with model-specific quality and compression.",
6
+ "properties": {
7
+ "background": {
8
+ "default": "auto",
9
+ "description": "Background for the generated image",
10
+ "enum": [
11
+ "auto",
12
+ "transparent",
13
+ "opaque"
14
+ ],
15
+ "title": "Background",
16
+ "type": "string"
17
+ },
18
+ "enable_safety_checker": {
19
+ "default": true,
20
+ "description": "Authorized callers may set false to request relaxed screening.",
21
+ "title": "Enable Safety Checker",
22
+ "type": "boolean"
23
+ },
24
+ "image_size": {
25
+ "anyOf": [
26
+ {
27
+ "$ref": "#/components/schemas/ImageSize"
28
+ },
29
+ {
30
+ "enum": [
31
+ "square_hd",
32
+ "square",
33
+ "portrait_4_3",
34
+ "portrait_16_9",
35
+ "landscape_4_3",
36
+ "landscape_16_9",
37
+ "auto"
38
+ ],
39
+ "type": "string"
40
+ }
41
+ ],
42
+ "default": "auto",
43
+ "description": "The size of the generated image. Use 'auto' to infer from input images.",
44
+ "title": "Image Size"
45
+ },
46
+ "image_urls": {
47
+ "description": "The URLs of the images to use as a reference for the generation. A maximum of 16 images are allowed.",
48
+ "examples": [
49
+ [
50
+ "https://v3b.fal.media/files/b/0a8691af/9Se_1_VX1wzTjjTOpWbs9_bb39c2eb-1a41-4749-b1d0-cf134abc8bbf.png"
51
+ ]
52
+ ],
53
+ "items": {
54
+ "type": "string"
55
+ },
56
+ "maxItems": 16,
57
+ "title": "Image URLs",
58
+ "type": "array"
59
+ },
60
+ "mask_url": {
61
+ "anyOf": [
62
+ {
63
+ "type": "string"
64
+ },
65
+ {
66
+ "type": "null"
67
+ }
68
+ ],
69
+ "description": "Mask image URL. White marks regions to edit and black marks regions to keep.",
70
+ "title": "Mask URL"
71
+ },
72
+ "num_images": {
73
+ "default": 1,
74
+ "description": "Number of images to generate",
75
+ "examples": [
76
+ 1
77
+ ],
78
+ "maximum": 10,
79
+ "minimum": 1,
80
+ "title": "Number of Images",
81
+ "type": "integer"
82
+ },
83
+ "output_compression": {
84
+ "anyOf": [
85
+ {
86
+ "maximum": 100,
87
+ "minimum": 0,
88
+ "type": "integer"
89
+ },
90
+ {
91
+ "type": "null"
92
+ }
93
+ ],
94
+ "description": "Compression level from 0 to 100. Only supported when output_format is 'jpeg' or 'webp'.",
95
+ "title": "Output Compression"
96
+ },
97
+ "output_format": {
98
+ "default": "png",
99
+ "description": "Output format for the images",
100
+ "enum": [
101
+ "jpeg",
102
+ "png",
103
+ "webp"
104
+ ],
105
+ "title": "Output Format",
106
+ "type": "string"
107
+ },
108
+ "prompt": {
109
+ "description": "The prompt for image generation",
110
+ "examples": [
111
+ "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."
112
+ ],
113
+ "maxLength": 32000,
114
+ "minLength": 1,
115
+ "title": "Prompt",
116
+ "type": "string"
117
+ },
118
+ "quality": {
119
+ "default": "high",
120
+ "description": "Quality for the generated image. Higher settings increase detail, latency, and token usage. Use 'auto' to let the model choose.",
121
+ "enum": [
122
+ "auto",
123
+ "low",
124
+ "medium",
125
+ "high",
126
+ "xhigh",
127
+ "max"
128
+ ],
129
+ "title": "Quality",
130
+ "type": "string"
131
+ },
132
+ "sync_mode": {
133
+ "default": false,
134
+ "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.",
135
+ "title": "Sync Mode",
136
+ "type": "boolean"
137
+ }
138
+ },
139
+ "required": [
140
+ "prompt",
141
+ "image_urls"
142
+ ],
143
+ "title": "GPTImage25EditImageRequest",
144
+ "type": "object",
145
+ "x-fal-order-properties": [
146
+ "prompt",
147
+ "image_urls",
148
+ "mask_url",
149
+ "image_size",
150
+ "background",
151
+ "quality",
152
+ "num_images",
153
+ "output_format",
154
+ "output_compression",
155
+ "sync_mode",
156
+ "enable_safety_checker"
157
+ ]
158
+ },
159
+ "GptImage25FlareEditOutput": {
160
+ "properties": {
161
+ "images": {
162
+ "description": "The generated images.",
163
+ "examples": [
164
+ [
165
+ {
166
+ "content_type": "image/png",
167
+ "file_name": "yUt7tifLSbg1WzWWgfj2o.png",
168
+ "height": 1024,
169
+ "url": "https://v3b.fal.media/files/b/0a8691b0/yUt7tifLSbg1WzWWgfj2o.png",
170
+ "width": 1024
171
+ }
172
+ ]
173
+ ],
174
+ "items": {
175
+ "$ref": "#/components/schemas/ImageFile"
176
+ },
177
+ "title": "Images",
178
+ "type": "array"
179
+ }
180
+ },
181
+ "required": [
182
+ "images"
183
+ ],
184
+ "title": "EditImageResponse",
185
+ "type": "object",
186
+ "x-fal-order-properties": [
187
+ "images"
188
+ ]
189
+ },
190
+ "ImageFile": {
191
+ "properties": {
192
+ "content_type": {
193
+ "anyOf": [
194
+ {
195
+ "type": "string"
196
+ },
197
+ {
198
+ "type": "null"
199
+ }
200
+ ],
201
+ "description": "The mime type of the file.",
202
+ "examples": [
203
+ "image/png"
204
+ ],
205
+ "title": "Content Type"
206
+ },
207
+ "file_name": {
208
+ "anyOf": [
209
+ {
210
+ "type": "string"
211
+ },
212
+ {
213
+ "type": "null"
214
+ }
215
+ ],
216
+ "description": "The name of the file. It will be auto-generated if not provided.",
217
+ "examples": [
218
+ "z9RV14K95DvU.png"
219
+ ],
220
+ "title": "File Name"
221
+ },
222
+ "file_size": {
223
+ "anyOf": [
224
+ {
225
+ "type": "integer"
226
+ },
227
+ {
228
+ "type": "null"
229
+ }
230
+ ],
231
+ "description": "The size of the file in bytes.",
232
+ "examples": [
233
+ 4404019
234
+ ],
235
+ "title": "File Size"
236
+ },
237
+ "height": {
238
+ "anyOf": [
239
+ {
240
+ "type": "integer"
241
+ },
242
+ {
243
+ "type": "null"
244
+ }
245
+ ],
246
+ "description": "The height of the image",
247
+ "title": "Height"
248
+ },
249
+ "url": {
250
+ "description": "The URL where the file can be downloaded from.",
251
+ "title": "Url",
252
+ "type": "string"
253
+ },
254
+ "width": {
255
+ "anyOf": [
256
+ {
257
+ "type": "integer"
258
+ },
259
+ {
260
+ "type": "null"
261
+ }
262
+ ],
263
+ "description": "The width of the image",
264
+ "title": "Width"
265
+ }
266
+ },
267
+ "required": [
268
+ "url"
269
+ ],
270
+ "title": "ImageFile",
271
+ "type": "object",
272
+ "x-fal-order-properties": [
273
+ "url",
274
+ "content_type",
275
+ "file_name",
276
+ "file_size",
277
+ "width",
278
+ "height"
279
+ ]
280
+ },
281
+ "ImageSize": {
282
+ "properties": {
283
+ "height": {
284
+ "default": 512,
285
+ "description": "The height of the generated image.",
286
+ "exclusiveMinimum": 0,
287
+ "maximum": 14142,
288
+ "title": "Height",
289
+ "type": "integer"
290
+ },
291
+ "width": {
292
+ "default": 512,
293
+ "description": "The width of the generated image.",
294
+ "exclusiveMinimum": 0,
295
+ "maximum": 14142,
296
+ "title": "Width",
297
+ "type": "integer"
298
+ }
299
+ },
300
+ "title": "ImageSize",
301
+ "type": "object",
302
+ "x-fal-order-properties": [
303
+ "width",
304
+ "height"
305
+ ]
306
+ },
307
+ "QueueStatus": {
308
+ "properties": {
309
+ "cancel_url": {
310
+ "description": "The cancel url.",
311
+ "type": "string"
312
+ },
313
+ "logs": {
314
+ "additionalProperties": true,
315
+ "description": "The logs.",
316
+ "type": "object"
317
+ },
318
+ "metrics": {
319
+ "additionalProperties": true,
320
+ "description": "The metrics.",
321
+ "type": "object"
322
+ },
323
+ "queue_position": {
324
+ "description": "The queue position.",
325
+ "type": "integer"
326
+ },
327
+ "request_id": {
328
+ "description": "The request id.",
329
+ "type": "string"
330
+ },
331
+ "response_url": {
332
+ "description": "The response url.",
333
+ "type": "string"
334
+ },
335
+ "status": {
336
+ "enum": [
337
+ "IN_QUEUE",
338
+ "IN_PROGRESS",
339
+ "COMPLETED"
340
+ ],
341
+ "type": "string"
342
+ },
343
+ "status_url": {
344
+ "description": "The status url.",
345
+ "type": "string"
346
+ }
347
+ },
348
+ "required": [
349
+ "status",
350
+ "request_id"
351
+ ],
352
+ "type": "object"
353
+ }
354
+ },
355
+ "securitySchemes": {
356
+ "apiKeyAuth": {
357
+ "description": "Fal Key",
358
+ "in": "header",
359
+ "name": "Authorization",
360
+ "type": "apiKey"
361
+ }
362
+ }
363
+ },
364
+ "info": {
365
+ "description": "The OpenAPI schema for the openai/gpt-image-2.5/flare/edit queue.",
366
+ "title": "Queue OpenAPI for openai/gpt-image-2.5/flare/edit",
367
+ "version": "1.0.0",
368
+ "x-fal-metadata": {
369
+ "about": "Edit images with the selected GPT Image 2.5 model.",
370
+ "category": "image-to-image",
371
+ "documentationUrl": "https://fal.ai/models/openai/gpt-image-2.5/flare/edit/api",
372
+ "endpointId": "openai/gpt-image-2.5/flare/edit",
373
+ "playgroundUrl": "https://fal.ai/models/openai/gpt-image-2.5/flare/edit",
374
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0aa9a3a4/LkWSlm_4F_SXsNlc4limv.jpg"
375
+ }
376
+ },
377
+ "openapi": "3.1.0",
378
+ "paths": {
379
+ "/openai/gpt-image-2.5/flare/edit": {
380
+ "post": {
381
+ "requestBody": {
382
+ "content": {
383
+ "application/json": {
384
+ "schema": {
385
+ "$ref": "#/components/schemas/GptImage25FlareEditInput"
386
+ }
387
+ }
388
+ },
389
+ "required": true
390
+ },
391
+ "responses": {
392
+ "200": {
393
+ "content": {
394
+ "application/json": {
395
+ "schema": {
396
+ "$ref": "#/components/schemas/QueueStatus"
397
+ }
398
+ }
399
+ },
400
+ "description": "The request status."
401
+ }
402
+ }
403
+ }
404
+ },
405
+ "/openai/gpt-image-2.5/flare/edit/requests/{request_id}": {
406
+ "get": {
407
+ "parameters": [
408
+ {
409
+ "in": "path",
410
+ "name": "request_id",
411
+ "required": true,
412
+ "schema": {
413
+ "description": "Request ID",
414
+ "type": "string"
415
+ }
416
+ }
417
+ ],
418
+ "responses": {
419
+ "200": {
420
+ "content": {
421
+ "application/json": {
422
+ "schema": {
423
+ "$ref": "#/components/schemas/GptImage25FlareEditOutput"
424
+ }
425
+ }
426
+ },
427
+ "description": "Result of the request."
428
+ }
429
+ }
430
+ }
431
+ },
432
+ "/openai/gpt-image-2.5/flare/edit/requests/{request_id}/cancel": {
433
+ "put": {
434
+ "parameters": [
435
+ {
436
+ "in": "path",
437
+ "name": "request_id",
438
+ "required": true,
439
+ "schema": {
440
+ "description": "Request ID",
441
+ "type": "string"
442
+ }
443
+ }
444
+ ],
445
+ "responses": {
446
+ "200": {
447
+ "content": {
448
+ "application/json": {
449
+ "schema": {
450
+ "properties": {
451
+ "success": {
452
+ "description": "Whether the request was cancelled successfully.",
453
+ "type": "boolean"
454
+ }
455
+ },
456
+ "type": "object"
457
+ }
458
+ }
459
+ },
460
+ "description": "The request was cancelled."
461
+ }
462
+ }
463
+ }
464
+ },
465
+ "/openai/gpt-image-2.5/flare/edit/requests/{request_id}/status": {
466
+ "get": {
467
+ "parameters": [
468
+ {
469
+ "in": "path",
470
+ "name": "request_id",
471
+ "required": true,
472
+ "schema": {
473
+ "description": "Request ID",
474
+ "type": "string"
475
+ }
476
+ },
477
+ {
478
+ "in": "query",
479
+ "name": "logs",
480
+ "required": false,
481
+ "schema": {
482
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
483
+ "type": "number"
484
+ }
485
+ }
486
+ ],
487
+ "responses": {
488
+ "200": {
489
+ "content": {
490
+ "application/json": {
491
+ "schema": {
492
+ "$ref": "#/components/schemas/QueueStatus"
493
+ }
494
+ }
495
+ },
496
+ "description": "The request status."
497
+ }
498
+ }
499
+ }
500
+ }
501
+ },
502
+ "security": [
503
+ {
504
+ "apiKeyAuth": []
505
+ }
506
+ ],
507
+ "servers": [
508
+ {
509
+ "url": "https://queue.fal.run"
510
+ }
511
+ ]
512
+ }
pipeline/fal_schemas/openai__gpt-image-2.5__sunburst__edit.json ADDED
@@ -0,0 +1,512 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "GptImage25SunburstEditInput": {
5
+ "description": "GPT Image 2.5 edit inputs with model-specific quality and compression.",
6
+ "properties": {
7
+ "background": {
8
+ "default": "auto",
9
+ "description": "Background for the generated image",
10
+ "enum": [
11
+ "auto",
12
+ "transparent",
13
+ "opaque"
14
+ ],
15
+ "title": "Background",
16
+ "type": "string"
17
+ },
18
+ "enable_safety_checker": {
19
+ "default": true,
20
+ "description": "Authorized callers may set false to request relaxed screening.",
21
+ "title": "Enable Safety Checker",
22
+ "type": "boolean"
23
+ },
24
+ "image_size": {
25
+ "anyOf": [
26
+ {
27
+ "$ref": "#/components/schemas/ImageSize"
28
+ },
29
+ {
30
+ "enum": [
31
+ "square_hd",
32
+ "square",
33
+ "portrait_4_3",
34
+ "portrait_16_9",
35
+ "landscape_4_3",
36
+ "landscape_16_9",
37
+ "auto"
38
+ ],
39
+ "type": "string"
40
+ }
41
+ ],
42
+ "default": "auto",
43
+ "description": "The size of the generated image. Use 'auto' to infer from input images.",
44
+ "title": "Image Size"
45
+ },
46
+ "image_urls": {
47
+ "description": "The URLs of the images to use as a reference for the generation. A maximum of 16 images are allowed.",
48
+ "examples": [
49
+ [
50
+ "https://v3b.fal.media/files/b/0a8691af/9Se_1_VX1wzTjjTOpWbs9_bb39c2eb-1a41-4749-b1d0-cf134abc8bbf.png"
51
+ ]
52
+ ],
53
+ "items": {
54
+ "type": "string"
55
+ },
56
+ "maxItems": 16,
57
+ "title": "Image URLs",
58
+ "type": "array"
59
+ },
60
+ "mask_url": {
61
+ "anyOf": [
62
+ {
63
+ "type": "string"
64
+ },
65
+ {
66
+ "type": "null"
67
+ }
68
+ ],
69
+ "description": "Mask image URL. White marks regions to edit and black marks regions to keep.",
70
+ "title": "Mask URL"
71
+ },
72
+ "num_images": {
73
+ "default": 1,
74
+ "description": "Number of images to generate",
75
+ "examples": [
76
+ 1
77
+ ],
78
+ "maximum": 10,
79
+ "minimum": 1,
80
+ "title": "Number of Images",
81
+ "type": "integer"
82
+ },
83
+ "output_compression": {
84
+ "anyOf": [
85
+ {
86
+ "maximum": 100,
87
+ "minimum": 0,
88
+ "type": "integer"
89
+ },
90
+ {
91
+ "type": "null"
92
+ }
93
+ ],
94
+ "description": "Compression level from 0 to 100. Only supported when output_format is 'jpeg' or 'webp'.",
95
+ "title": "Output Compression"
96
+ },
97
+ "output_format": {
98
+ "default": "png",
99
+ "description": "Output format for the images",
100
+ "enum": [
101
+ "jpeg",
102
+ "png",
103
+ "webp"
104
+ ],
105
+ "title": "Output Format",
106
+ "type": "string"
107
+ },
108
+ "prompt": {
109
+ "description": "The prompt for image generation",
110
+ "examples": [
111
+ "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."
112
+ ],
113
+ "maxLength": 32000,
114
+ "minLength": 1,
115
+ "title": "Prompt",
116
+ "type": "string"
117
+ },
118
+ "quality": {
119
+ "default": "high",
120
+ "description": "Quality for the generated image. Higher settings increase detail, latency, and token usage. Use 'auto' to let the model choose.",
121
+ "enum": [
122
+ "auto",
123
+ "low",
124
+ "medium",
125
+ "high",
126
+ "xhigh",
127
+ "max"
128
+ ],
129
+ "title": "Quality",
130
+ "type": "string"
131
+ },
132
+ "sync_mode": {
133
+ "default": false,
134
+ "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.",
135
+ "title": "Sync Mode",
136
+ "type": "boolean"
137
+ }
138
+ },
139
+ "required": [
140
+ "prompt",
141
+ "image_urls"
142
+ ],
143
+ "title": "GPTImage25EditImageRequest",
144
+ "type": "object",
145
+ "x-fal-order-properties": [
146
+ "prompt",
147
+ "image_urls",
148
+ "mask_url",
149
+ "image_size",
150
+ "background",
151
+ "quality",
152
+ "num_images",
153
+ "output_format",
154
+ "output_compression",
155
+ "sync_mode",
156
+ "enable_safety_checker"
157
+ ]
158
+ },
159
+ "GptImage25SunburstEditOutput": {
160
+ "properties": {
161
+ "images": {
162
+ "description": "The generated images.",
163
+ "examples": [
164
+ [
165
+ {
166
+ "content_type": "image/png",
167
+ "file_name": "yUt7tifLSbg1WzWWgfj2o.png",
168
+ "height": 1024,
169
+ "url": "https://v3b.fal.media/files/b/0a8691b0/yUt7tifLSbg1WzWWgfj2o.png",
170
+ "width": 1024
171
+ }
172
+ ]
173
+ ],
174
+ "items": {
175
+ "$ref": "#/components/schemas/ImageFile"
176
+ },
177
+ "title": "Images",
178
+ "type": "array"
179
+ }
180
+ },
181
+ "required": [
182
+ "images"
183
+ ],
184
+ "title": "EditImageResponse",
185
+ "type": "object",
186
+ "x-fal-order-properties": [
187
+ "images"
188
+ ]
189
+ },
190
+ "ImageFile": {
191
+ "properties": {
192
+ "content_type": {
193
+ "anyOf": [
194
+ {
195
+ "type": "string"
196
+ },
197
+ {
198
+ "type": "null"
199
+ }
200
+ ],
201
+ "description": "The mime type of the file.",
202
+ "examples": [
203
+ "image/png"
204
+ ],
205
+ "title": "Content Type"
206
+ },
207
+ "file_name": {
208
+ "anyOf": [
209
+ {
210
+ "type": "string"
211
+ },
212
+ {
213
+ "type": "null"
214
+ }
215
+ ],
216
+ "description": "The name of the file. It will be auto-generated if not provided.",
217
+ "examples": [
218
+ "z9RV14K95DvU.png"
219
+ ],
220
+ "title": "File Name"
221
+ },
222
+ "file_size": {
223
+ "anyOf": [
224
+ {
225
+ "type": "integer"
226
+ },
227
+ {
228
+ "type": "null"
229
+ }
230
+ ],
231
+ "description": "The size of the file in bytes.",
232
+ "examples": [
233
+ 4404019
234
+ ],
235
+ "title": "File Size"
236
+ },
237
+ "height": {
238
+ "anyOf": [
239
+ {
240
+ "type": "integer"
241
+ },
242
+ {
243
+ "type": "null"
244
+ }
245
+ ],
246
+ "description": "The height of the image",
247
+ "title": "Height"
248
+ },
249
+ "url": {
250
+ "description": "The URL where the file can be downloaded from.",
251
+ "title": "Url",
252
+ "type": "string"
253
+ },
254
+ "width": {
255
+ "anyOf": [
256
+ {
257
+ "type": "integer"
258
+ },
259
+ {
260
+ "type": "null"
261
+ }
262
+ ],
263
+ "description": "The width of the image",
264
+ "title": "Width"
265
+ }
266
+ },
267
+ "required": [
268
+ "url"
269
+ ],
270
+ "title": "ImageFile",
271
+ "type": "object",
272
+ "x-fal-order-properties": [
273
+ "url",
274
+ "content_type",
275
+ "file_name",
276
+ "file_size",
277
+ "width",
278
+ "height"
279
+ ]
280
+ },
281
+ "ImageSize": {
282
+ "properties": {
283
+ "height": {
284
+ "default": 512,
285
+ "description": "The height of the generated image.",
286
+ "exclusiveMinimum": 0,
287
+ "maximum": 14142,
288
+ "title": "Height",
289
+ "type": "integer"
290
+ },
291
+ "width": {
292
+ "default": 512,
293
+ "description": "The width of the generated image.",
294
+ "exclusiveMinimum": 0,
295
+ "maximum": 14142,
296
+ "title": "Width",
297
+ "type": "integer"
298
+ }
299
+ },
300
+ "title": "ImageSize",
301
+ "type": "object",
302
+ "x-fal-order-properties": [
303
+ "width",
304
+ "height"
305
+ ]
306
+ },
307
+ "QueueStatus": {
308
+ "properties": {
309
+ "cancel_url": {
310
+ "description": "The cancel url.",
311
+ "type": "string"
312
+ },
313
+ "logs": {
314
+ "additionalProperties": true,
315
+ "description": "The logs.",
316
+ "type": "object"
317
+ },
318
+ "metrics": {
319
+ "additionalProperties": true,
320
+ "description": "The metrics.",
321
+ "type": "object"
322
+ },
323
+ "queue_position": {
324
+ "description": "The queue position.",
325
+ "type": "integer"
326
+ },
327
+ "request_id": {
328
+ "description": "The request id.",
329
+ "type": "string"
330
+ },
331
+ "response_url": {
332
+ "description": "The response url.",
333
+ "type": "string"
334
+ },
335
+ "status": {
336
+ "enum": [
337
+ "IN_QUEUE",
338
+ "IN_PROGRESS",
339
+ "COMPLETED"
340
+ ],
341
+ "type": "string"
342
+ },
343
+ "status_url": {
344
+ "description": "The status url.",
345
+ "type": "string"
346
+ }
347
+ },
348
+ "required": [
349
+ "status",
350
+ "request_id"
351
+ ],
352
+ "type": "object"
353
+ }
354
+ },
355
+ "securitySchemes": {
356
+ "apiKeyAuth": {
357
+ "description": "Fal Key",
358
+ "in": "header",
359
+ "name": "Authorization",
360
+ "type": "apiKey"
361
+ }
362
+ }
363
+ },
364
+ "info": {
365
+ "description": "The OpenAPI schema for the openai/gpt-image-2.5/sunburst/edit queue.",
366
+ "title": "Queue OpenAPI for openai/gpt-image-2.5/sunburst/edit",
367
+ "version": "1.0.0",
368
+ "x-fal-metadata": {
369
+ "about": "Edit images with the selected GPT Image 2.5 model.",
370
+ "category": "image-to-image",
371
+ "documentationUrl": "https://fal.ai/models/openai/gpt-image-2.5/sunburst/edit/api",
372
+ "endpointId": "openai/gpt-image-2.5/sunburst/edit",
373
+ "playgroundUrl": "https://fal.ai/models/openai/gpt-image-2.5/sunburst/edit",
374
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0aa9a3b8/cSrDjg-ke-PcqgHiY_gxn.jpg"
375
+ }
376
+ },
377
+ "openapi": "3.1.0",
378
+ "paths": {
379
+ "/openai/gpt-image-2.5/sunburst/edit": {
380
+ "post": {
381
+ "requestBody": {
382
+ "content": {
383
+ "application/json": {
384
+ "schema": {
385
+ "$ref": "#/components/schemas/GptImage25SunburstEditInput"
386
+ }
387
+ }
388
+ },
389
+ "required": true
390
+ },
391
+ "responses": {
392
+ "200": {
393
+ "content": {
394
+ "application/json": {
395
+ "schema": {
396
+ "$ref": "#/components/schemas/QueueStatus"
397
+ }
398
+ }
399
+ },
400
+ "description": "The request status."
401
+ }
402
+ }
403
+ }
404
+ },
405
+ "/openai/gpt-image-2.5/sunburst/edit/requests/{request_id}": {
406
+ "get": {
407
+ "parameters": [
408
+ {
409
+ "in": "path",
410
+ "name": "request_id",
411
+ "required": true,
412
+ "schema": {
413
+ "description": "Request ID",
414
+ "type": "string"
415
+ }
416
+ }
417
+ ],
418
+ "responses": {
419
+ "200": {
420
+ "content": {
421
+ "application/json": {
422
+ "schema": {
423
+ "$ref": "#/components/schemas/GptImage25SunburstEditOutput"
424
+ }
425
+ }
426
+ },
427
+ "description": "Result of the request."
428
+ }
429
+ }
430
+ }
431
+ },
432
+ "/openai/gpt-image-2.5/sunburst/edit/requests/{request_id}/cancel": {
433
+ "put": {
434
+ "parameters": [
435
+ {
436
+ "in": "path",
437
+ "name": "request_id",
438
+ "required": true,
439
+ "schema": {
440
+ "description": "Request ID",
441
+ "type": "string"
442
+ }
443
+ }
444
+ ],
445
+ "responses": {
446
+ "200": {
447
+ "content": {
448
+ "application/json": {
449
+ "schema": {
450
+ "properties": {
451
+ "success": {
452
+ "description": "Whether the request was cancelled successfully.",
453
+ "type": "boolean"
454
+ }
455
+ },
456
+ "type": "object"
457
+ }
458
+ }
459
+ },
460
+ "description": "The request was cancelled."
461
+ }
462
+ }
463
+ }
464
+ },
465
+ "/openai/gpt-image-2.5/sunburst/edit/requests/{request_id}/status": {
466
+ "get": {
467
+ "parameters": [
468
+ {
469
+ "in": "path",
470
+ "name": "request_id",
471
+ "required": true,
472
+ "schema": {
473
+ "description": "Request ID",
474
+ "type": "string"
475
+ }
476
+ },
477
+ {
478
+ "in": "query",
479
+ "name": "logs",
480
+ "required": false,
481
+ "schema": {
482
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
483
+ "type": "number"
484
+ }
485
+ }
486
+ ],
487
+ "responses": {
488
+ "200": {
489
+ "content": {
490
+ "application/json": {
491
+ "schema": {
492
+ "$ref": "#/components/schemas/QueueStatus"
493
+ }
494
+ }
495
+ },
496
+ "description": "The request status."
497
+ }
498
+ }
499
+ }
500
+ }
501
+ },
502
+ "security": [
503
+ {
504
+ "apiKeyAuth": []
505
+ }
506
+ ],
507
+ "servers": [
508
+ {
509
+ "url": "https://queue.fal.run"
510
+ }
511
+ ]
512
+ }
pipeline/fal_schemas/openai__gpt-image-2.6__flare__edit.json ADDED
@@ -0,0 +1 @@
 
 
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":[]}]}
pipeline/fal_schemas/openai__gpt-image-2.6__sunburst__edit.json ADDED
@@ -0,0 +1 @@
 
 
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":[]}]}
pipeline/fal_schemas/wayback_2026-11-06.tsv ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ openai/gpt-image-2.6/sunburst/edit failed: HTTPError HTTP Error 429: Too Many Requests
2
+ openai/gpt-image-2.6/flare/edit failed: HTTPError HTTP Error 429: Too Many Requests
3
+ fal-ai/nano-banana-2/edit failed: HTTPError HTTP Error 429: Too Many Requests
4
+ fal-ai/qwen-image-edit-2511 failed: HTTPError HTTP Error 429: Too Many Requests
pipeline/fal_schemas/xai__grok-imagine-image__v2.0__edit.json ADDED
@@ -0,0 +1,459 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "GrokImagineImageV20EditInput": {
5
+ "properties": {
6
+ "aspect_ratio": {
7
+ "default": "auto",
8
+ "description": "Aspect ratio of the edited image. Standard auto uses the nearest supported ratio of the first reference.",
9
+ "enum": [
10
+ "2:1",
11
+ "20:9",
12
+ "19.5:9",
13
+ "16:9",
14
+ "4:3",
15
+ "3:2",
16
+ "1:1",
17
+ "2:3",
18
+ "3:4",
19
+ "9:16",
20
+ "9:19.5",
21
+ "9:20",
22
+ "1:2",
23
+ "auto",
24
+ "21:9",
25
+ "5:2"
26
+ ],
27
+ "title": "Aspect Ratio",
28
+ "type": "string"
29
+ },
30
+ "enable_safety_checker": {
31
+ "default": true,
32
+ "description": "Authorized callers may set false to request relaxed screening.",
33
+ "title": "Enable Safety Checker",
34
+ "type": "boolean"
35
+ },
36
+ "image_urls": {
37
+ "description": "List of URLs of the images to edit. A maximum of 5 images are supported.",
38
+ "examples": [
39
+ [
40
+ "https://v3b.fal.media/files/b/0a8b911d/Abk8vStrvmSPlzUqI_NN3_image_043.png"
41
+ ]
42
+ ],
43
+ "items": {
44
+ "type": "string"
45
+ },
46
+ "title": "Image URLs",
47
+ "type": "array"
48
+ },
49
+ "num_images": {
50
+ "default": 1,
51
+ "description": "Number of images to generate.",
52
+ "maximum": 10,
53
+ "minimum": 1,
54
+ "title": "Number of Images",
55
+ "type": "integer"
56
+ },
57
+ "output_format": {
58
+ "default": "jpeg",
59
+ "description": "The format of the generated image.",
60
+ "enum": [
61
+ "jpeg",
62
+ "png",
63
+ "webp"
64
+ ],
65
+ "title": "Output Format",
66
+ "type": "string"
67
+ },
68
+ "prompt": {
69
+ "description": "Text description of the desired image.",
70
+ "examples": [
71
+ "Make this scene more realistic but still keep the game vibes"
72
+ ],
73
+ "maxLength": 8000,
74
+ "title": "Prompt",
75
+ "type": "string"
76
+ },
77
+ "quality": {
78
+ "default": "medium",
79
+ "description": "Quality level of the edited image. `auto` lets xAI choose; it currently uses `medium` for editing.",
80
+ "enum": [
81
+ "low",
82
+ "medium",
83
+ "auto"
84
+ ],
85
+ "title": "Quality",
86
+ "type": "string"
87
+ },
88
+ "resolution": {
89
+ "default": "1k",
90
+ "description": "Resolution of the generated image: 1k, 1.5k, or 2k.",
91
+ "enum": [
92
+ "1k",
93
+ "1.5k",
94
+ "2k"
95
+ ],
96
+ "title": "Resolution",
97
+ "type": "string"
98
+ },
99
+ "sync_mode": {
100
+ "default": false,
101
+ "description": "If `True`, the media will be returned as a data URI and the output data won't be available in the request history.",
102
+ "title": "Sync Mode",
103
+ "type": "boolean"
104
+ }
105
+ },
106
+ "required": [
107
+ "prompt"
108
+ ],
109
+ "title": "XAIImageEditV2Input",
110
+ "type": "object",
111
+ "x-fal-order-properties": [
112
+ "prompt",
113
+ "image_urls",
114
+ "num_images",
115
+ "aspect_ratio",
116
+ "resolution",
117
+ "output_format",
118
+ "sync_mode",
119
+ "enable_safety_checker",
120
+ "quality"
121
+ ]
122
+ },
123
+ "GrokImagineImageV20EditOutput": {
124
+ "properties": {
125
+ "images": {
126
+ "description": "The URL of the edited image.",
127
+ "examples": [
128
+ [
129
+ {
130
+ "url": "https://v3b.fal.media/files/b/0a8b911d/XMqiVoO2ECXUZEUYmPl2l.jpg"
131
+ }
132
+ ]
133
+ ],
134
+ "items": {
135
+ "$ref": "#/components/schemas/ImageFile"
136
+ },
137
+ "title": "Images",
138
+ "type": "array"
139
+ },
140
+ "revised_prompt": {
141
+ "anyOf": [
142
+ {
143
+ "type": "string"
144
+ },
145
+ {
146
+ "type": "null"
147
+ }
148
+ ],
149
+ "description": "The enhanced prompt that was used to generate the image.",
150
+ "title": "Revised Prompt"
151
+ }
152
+ },
153
+ "required": [
154
+ "images"
155
+ ],
156
+ "title": "XAIImageEditOutput",
157
+ "type": "object",
158
+ "x-fal-order-properties": [
159
+ "images",
160
+ "revised_prompt"
161
+ ]
162
+ },
163
+ "ImageFile": {
164
+ "properties": {
165
+ "content_type": {
166
+ "anyOf": [
167
+ {
168
+ "type": "string"
169
+ },
170
+ {
171
+ "type": "null"
172
+ }
173
+ ],
174
+ "description": "The mime type of the file.",
175
+ "examples": [
176
+ "image/png"
177
+ ],
178
+ "title": "Content Type"
179
+ },
180
+ "file_name": {
181
+ "anyOf": [
182
+ {
183
+ "type": "string"
184
+ },
185
+ {
186
+ "type": "null"
187
+ }
188
+ ],
189
+ "description": "The name of the file. It will be auto-generated if not provided.",
190
+ "examples": [
191
+ "z9RV14K95DvU.png"
192
+ ],
193
+ "title": "File Name"
194
+ },
195
+ "file_size": {
196
+ "anyOf": [
197
+ {
198
+ "type": "integer"
199
+ },
200
+ {
201
+ "type": "null"
202
+ }
203
+ ],
204
+ "description": "The size of the file in bytes.",
205
+ "examples": [
206
+ 4404019
207
+ ],
208
+ "title": "File Size"
209
+ },
210
+ "height": {
211
+ "anyOf": [
212
+ {
213
+ "type": "integer"
214
+ },
215
+ {
216
+ "type": "null"
217
+ }
218
+ ],
219
+ "description": "The height of the image",
220
+ "title": "Height"
221
+ },
222
+ "url": {
223
+ "description": "The URL where the file can be downloaded from.",
224
+ "title": "Url",
225
+ "type": "string"
226
+ },
227
+ "width": {
228
+ "anyOf": [
229
+ {
230
+ "type": "integer"
231
+ },
232
+ {
233
+ "type": "null"
234
+ }
235
+ ],
236
+ "description": "The width of the image",
237
+ "title": "Width"
238
+ }
239
+ },
240
+ "required": [
241
+ "url"
242
+ ],
243
+ "title": "ImageFile",
244
+ "type": "object",
245
+ "x-fal-order-properties": [
246
+ "url",
247
+ "content_type",
248
+ "file_name",
249
+ "file_size",
250
+ "width",
251
+ "height"
252
+ ]
253
+ },
254
+ "QueueStatus": {
255
+ "properties": {
256
+ "cancel_url": {
257
+ "description": "The cancel url.",
258
+ "type": "string"
259
+ },
260
+ "logs": {
261
+ "additionalProperties": true,
262
+ "description": "The logs.",
263
+ "type": "object"
264
+ },
265
+ "metrics": {
266
+ "additionalProperties": true,
267
+ "description": "The metrics.",
268
+ "type": "object"
269
+ },
270
+ "queue_position": {
271
+ "description": "The queue position.",
272
+ "type": "integer"
273
+ },
274
+ "request_id": {
275
+ "description": "The request id.",
276
+ "type": "string"
277
+ },
278
+ "response_url": {
279
+ "description": "The response url.",
280
+ "type": "string"
281
+ },
282
+ "status": {
283
+ "enum": [
284
+ "IN_QUEUE",
285
+ "IN_PROGRESS",
286
+ "COMPLETED"
287
+ ],
288
+ "type": "string"
289
+ },
290
+ "status_url": {
291
+ "description": "The status url.",
292
+ "type": "string"
293
+ }
294
+ },
295
+ "required": [
296
+ "status",
297
+ "request_id"
298
+ ],
299
+ "type": "object"
300
+ }
301
+ },
302
+ "securitySchemes": {
303
+ "apiKeyAuth": {
304
+ "description": "Fal Key",
305
+ "in": "header",
306
+ "name": "Authorization",
307
+ "type": "apiKey"
308
+ }
309
+ }
310
+ },
311
+ "info": {
312
+ "description": "The OpenAPI schema for the xai/grok-imagine-image/v2.0/edit queue.",
313
+ "title": "Queue OpenAPI for xai/grok-imagine-image/v2.0/edit",
314
+ "version": "1.0.0",
315
+ "x-fal-metadata": {
316
+ "about": "Edit images using Grok Imagine Image 2.0.",
317
+ "category": "image-to-image",
318
+ "documentationUrl": "https://fal.ai/models/xai/grok-imagine-image/v2.0/edit/api",
319
+ "endpointId": "xai/grok-imagine-image/v2.0/edit",
320
+ "playgroundUrl": "https://fal.ai/models/xai/grok-imagine-image/v2.0/edit",
321
+ "thumbnailUrl": "https://v3b.fal.media/files/b/0aa53f9f/NPxHgnCK_ldUc0dOfNe1q.jpg"
322
+ }
323
+ },
324
+ "openapi": "3.1.0",
325
+ "paths": {
326
+ "/xai/grok-imagine-image/v2.0/edit": {
327
+ "post": {
328
+ "requestBody": {
329
+ "content": {
330
+ "application/json": {
331
+ "schema": {
332
+ "$ref": "#/components/schemas/GrokImagineImageV20EditInput"
333
+ }
334
+ }
335
+ },
336
+ "required": true
337
+ },
338
+ "responses": {
339
+ "200": {
340
+ "content": {
341
+ "application/json": {
342
+ "schema": {
343
+ "$ref": "#/components/schemas/QueueStatus"
344
+ }
345
+ }
346
+ },
347
+ "description": "The request status."
348
+ }
349
+ }
350
+ }
351
+ },
352
+ "/xai/grok-imagine-image/v2.0/edit/requests/{request_id}": {
353
+ "get": {
354
+ "parameters": [
355
+ {
356
+ "in": "path",
357
+ "name": "request_id",
358
+ "required": true,
359
+ "schema": {
360
+ "description": "Request ID",
361
+ "type": "string"
362
+ }
363
+ }
364
+ ],
365
+ "responses": {
366
+ "200": {
367
+ "content": {
368
+ "application/json": {
369
+ "schema": {
370
+ "$ref": "#/components/schemas/GrokImagineImageV20EditOutput"
371
+ }
372
+ }
373
+ },
374
+ "description": "Result of the request."
375
+ }
376
+ }
377
+ }
378
+ },
379
+ "/xai/grok-imagine-image/v2.0/edit/requests/{request_id}/cancel": {
380
+ "put": {
381
+ "parameters": [
382
+ {
383
+ "in": "path",
384
+ "name": "request_id",
385
+ "required": true,
386
+ "schema": {
387
+ "description": "Request ID",
388
+ "type": "string"
389
+ }
390
+ }
391
+ ],
392
+ "responses": {
393
+ "200": {
394
+ "content": {
395
+ "application/json": {
396
+ "schema": {
397
+ "properties": {
398
+ "success": {
399
+ "description": "Whether the request was cancelled successfully.",
400
+ "type": "boolean"
401
+ }
402
+ },
403
+ "type": "object"
404
+ }
405
+ }
406
+ },
407
+ "description": "The request was cancelled."
408
+ }
409
+ }
410
+ }
411
+ },
412
+ "/xai/grok-imagine-image/v2.0/edit/requests/{request_id}/status": {
413
+ "get": {
414
+ "parameters": [
415
+ {
416
+ "in": "path",
417
+ "name": "request_id",
418
+ "required": true,
419
+ "schema": {
420
+ "description": "Request ID",
421
+ "type": "string"
422
+ }
423
+ },
424
+ {
425
+ "in": "query",
426
+ "name": "logs",
427
+ "required": false,
428
+ "schema": {
429
+ "description": "Whether to include logs (`1`) in the response or not (`0`).",
430
+ "type": "number"
431
+ }
432
+ }
433
+ ],
434
+ "responses": {
435
+ "200": {
436
+ "content": {
437
+ "application/json": {
438
+ "schema": {
439
+ "$ref": "#/components/schemas/QueueStatus"
440
+ }
441
+ }
442
+ },
443
+ "description": "The request status."
444
+ }
445
+ }
446
+ }
447
+ }
448
+ },
449
+ "security": [
450
+ {
451
+ "apiKeyAuth": []
452
+ }
453
+ ],
454
+ "servers": [
455
+ {
456
+ "url": "https://queue.fal.run"
457
+ }
458
+ ]
459
+ }
pipeline/judge_prompt.txt ADDED
@@ -0,0 +1,80 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ An image-editing model was asked to apply this edit to the BEFORE image (first image):
2
+ "{ins}"
3
+ The AFTER image (second image) is its output. Check the edit strictly, as a careful human reviewer would.
4
+ 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.
5
+ Verdict rules:
6
+ - done: every check is true (placement, origin cleared for moves/replacements, right item, attribute, framing kept) and there are no major unrequested changes.
7
+ - 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).
8
+ - 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.
9
+ Do not judge the people's faces or identity; ignore image quality.
10
+
11
+ SCHEMA:
12
+ {
13
+ "type": "object",
14
+ "additionalProperties": false,
15
+ "properties": {
16
+ "instruction_clear": {
17
+ "type": "boolean",
18
+ "description": "the BEFORE image has exactly one thing the instruction can refer to, and any named place exists"
19
+ },
20
+ "target_in_before": {
21
+ "type": "string",
22
+ "description": "the item the instruction refers to and where it is in BEFORE"
23
+ },
24
+ "target_in_after": {
25
+ "type": "string",
26
+ "description": "what is at that place in AFTER, and where the item is now (or 'gone')"
27
+ },
28
+ "placement_ok": {
29
+ "type": "boolean",
30
+ "description": "the result is where the instruction says (or, if no place is named, where a reader would expect); true for remove"
31
+ },
32
+ "origin_cleared": {
33
+ "type": "boolean",
34
+ "description": "for move/relocate and replace: the old item is no longer at its old place; true for other operations"
35
+ },
36
+ "right_item_changed": {
37
+ "type": "boolean",
38
+ "description": "the edit was applied to the intended item, not to a different item or person"
39
+ },
40
+ "attribute_ok": {
41
+ "type": "boolean",
42
+ "description": "the requested colour, words, material, pattern or object type is correct"
43
+ },
44
+ "framing_kept": {
45
+ "type": "boolean",
46
+ "description": "AFTER shows the same view as BEFORE: no zoom, crop, reframing, rotation or added/removed border"
47
+ },
48
+ "unrequested_changes": {
49
+ "type": "array",
50
+ "items": {
51
+ "type": "string"
52
+ },
53
+ "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)"
54
+ },
55
+ "verdict": {
56
+ "type": "string",
57
+ "enum": [
58
+ "done",
59
+ "partial",
60
+ "not_done"
61
+ ]
62
+ },
63
+ "reason": {
64
+ "type": "string"
65
+ }
66
+ },
67
+ "required": [
68
+ "instruction_clear",
69
+ "target_in_before",
70
+ "target_in_after",
71
+ "placement_ok",
72
+ "origin_cleared",
73
+ "right_item_changed",
74
+ "attribute_ok",
75
+ "framing_kept",
76
+ "unrequested_changes",
77
+ "verdict",
78
+ "reason"
79
+ ]
80
+ }
pipeline/provider_docs/ARCHIVE_NOTES.md ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ Local copies of every page are in this folder, fetched 2026-10-30 (fetch_log.tsv).
2
+ Wayback Machine snapshots taken 2026-10-30: fetch_log.tsv (first 9) and wayback_retry.tsv (next 5).
3
+ Alibaba Cloud pages (wan-image-generation-and-editing-api-reference, wan-image-edit,
4
+ qwen-image-generation-and-editing-api-reference) could not be archived: the Wayback save returned 520 on four tries.
5
+ Older public snapshots exist for two of them (2026-09-20, 2026-08-21); the local copies here are the 2026-10-30 versions.
6
+ kling__rendered_text.txt is the rendered page text (the raw HTML loads its content with JavaScript).
pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_qwen-image-generation-and-editing-api-reference ADDED
@@ -0,0 +1,787 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+ <!DOCTYPE html>
3
+ <html lang="en" class="transparent alicloud back-to-top new_default light" traceid="2ff6309617933771335466818e">
4
+ <link rel="stylesheet" href="//g.alicdn.com/aliyun-help/help-portal-fe/0.12.65/css/index.css" />
5
+ <head>
6
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
7
+ <meta name="spm-id" content="a2c63">
8
+ <meta name="data-spm" content="a2c63" />
9
+ <meta name="aplus-core" content="aplus.js">
10
+ <meta name="aplus-ajax" content="chksum">
11
+ <meta name="aplus-waiting" content="MAN">
12
+ <meta name="aplus-pvhash" content="1">
13
+ <!-- MINOR_LANG_ENTRY_GATE：ko/de/tr/vi/th 入口卡点，翻译/内容就绪后把 content 追加 ko,de,tr,vi,th -->
14
+ <!-- ES_ENTRY_GATE：es 已放开（本分支 ES_ENTRY_ENABLED=true），content 已含 es；如需回退从此处删除 es -->
15
+ <!-- FR_ENTRY_GATE：fr 已在预发验证分支放开（本分支 FR_ENTRY_ENABLED=true）；线上卡点分支的 content 为 en,zh,tc,ja,id,pt-BR -->
16
+ <meta name="kloud:supported-langs" content="en,zh,tc,ja,id,pt-BR,fr,es"/>
17
+
18
+ <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
19
+ <meta name="viewport" content="width=device-width,initial-scale=1.0">
20
+ <meta name="applicable-device" content="pc,mobile">
21
+ <meta name="aplus-rhost-v" content="sg.mmstat.com">
22
+ <meta name="aplus-rhost-g" content="sg.mmstat.com">
23
+ <title>
24
+ Qwen-Image text-to-image image editing API reference - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center
25
+
26
+ </title>
27
+ <meta name="keywords" content="Qwen API,image generation,image editing,qwen-image-2.1-pro,qwen-image-2.1-turbo,qwen-image-3.0,text-to-image,image-to-image,OpenAI compatible">
28
+ <meta name="description" content="Qwen-Image text-to-image image editing API reference,Alibaba Cloud Model Studio: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 referenc...">
29
+ <script>
30
+ window.globalData = {
31
+ website: "intl",
32
+ language: "en",
33
+ nodeId:"3047054",
34
+ channel: "",
35
+ notfound: "",
36
+ statusCode: "",
37
+ errorType: ""
38
+ };
39
+ // UT的全局配置变量，在CDN加载前配置
40
+ window.$ACE_TRACKER_CONFIG = {
41
+ enableHistory: true,
42
+ enableHash: false
43
+ };
44
+ </script>
45
+ <!-- <base href="https://www.alibabacloud.com">-->
46
+ <link rel="canonical" href="https://www.alibabacloud.com/help/en/model-studio/qwen-image-generation-and-editing-api-reference"/>
47
+ <meta property="og:title" content="Qwen Image Generation and Editing API Reference - Alibaba Cloud" />
48
+ <meta property="og:type" content="website" />
49
+ <meta property="og:url" content="https://www.alibabacloud.com/help/en/model-studio/qwen-image-generation-and-editing-api-reference" />
50
+ <meta property="og:image" content="https://img.alicdn.com/tfs/TB1xpNqnmslXu8jSZFuXXXg7FXa-1200-630.png_.webp" />
51
+ <meta property="og:description" content="Qwen-Image text-to-image image editing API reference,Alibaba Cloud Model Studio: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 referenc..." />
52
+ <link rel="shortcut icon" href="//img.alicdn.com/tfs/TB1ugg7M9zqK1RjSZPxXXc4tVXa-32-32.png"/>
53
+ <link rel="stylesheet" href="https://o.alicdn.com/fund/alicloud-pure-layout/css/index.min.css" />
54
+ <link
55
+ rel="icon"
56
+ href="https://img.alicdn.com/imgextra/i2/O1CN01TFs5Qw27uYvfA6gib_!!6000000007857-55-tps-32-32.svg"
57
+ type="image/x-icon"
58
+ />
59
+ </head>
60
+ <body data-spm="" class="HAS_ALPS_RESOURCE"><script>
61
+ with(document)with(body)with(insertBefore(createElement("script"),firstChild))setAttribute("exparams","category=&userid=&aplus&yunid=&&trid=2ff6309617933771335466818e&asid=AQAAAABtw+RqZGYpSgAAAACtGO9GTtxz5A==",id="tb-beacon-aplus",src=(location>"https"?"//g":"//g")+".alicdn.com/alilog/mlog/aplus_v2.js")
62
+ </script>
63
+
64
+ <script async src="https://o.alicdn.com/fund/alicloud-pure-layout/index.js"></script>
65
+
66
+ <div id="app">
67
+ <div class="aliyun-app-layout">
68
+
69
+ <!-- docId:3047054 -->
70
+ <input type="hidden" id="website" value="intl">
71
+ <div class="products-wrapper$tip" data-spm="879954">
72
+ <section id="products" class="intl-product container">
73
+ <div class="row">
74
+ <div class="col-lg-3 col-md-3 col-sm-4 col-xs-12" id="navDocument">
75
+ <div class="doc-nav">
76
+ <a class="doc-center" href="/help/en">
77
+ <i class="icon-docs icon-docs-back"></i>
78
+ Document Center
79
+ </a>
80
+ </div>
81
+ <div class="placeholder-ele">&nbsp;</div>
82
+ </div>
83
+ <div class="col-lg-7 col-md-7 col-sm-8 col-xs-12 doc-content">
84
+ <div class="all-products action" id="J_AllProducts">
85
+ <div class="all-products-head">
86
+ <div class="all-products-title">All Products</div>
87
+ <div class="all-products-search-wrapper">
88
+ <div class="all-products-search focus">
89
+ <input autocomplete="off" class="all-products-search-box-input" id="J_AllProductsSearch" placeholder="Search Product" data-spm-anchor-id="a2c4g.11186623.6.i0.1f753945H9RVzu">
90
+ <i class="icon-search icon-docs icon-docs-search"></i>
91
+ <ul class="all-products-search-result" style="display: none;">
92
+ </ul>
93
+ </div>
94
+ </div>
95
+ </div>
96
+ <div class="all-products-body" id="J_AllProductsBody"></div>
97
+ </div>
98
+ <div class="search-product-modal">
99
+ Search
100
+ </div>
101
+ <div class="breadcrumbs-top" data-spm="a1">
102
+ <div class="row nav-breadcrumb">
103
+ <div class="col-md-12 hidden-sm hidden-xs">
104
+ <ul class="breadcrumb text-sm">
105
+ <li><a class="active" title="Document Center" href="/help/en">Document Center</a></li>
106
+ <li><a class="active" title="Alibaba Cloud Model Studio" href="/help/en/model-studio/">Alibaba Cloud Model Studio</a></li>
107
+ <li><a class="active" title="API Reference (Models)" href="/help/en/model-studio/model-api-reference/">API Reference (Models)</a></li>
108
+ <li><a class="active" title="Image Generation" href="/help/en/model-studio/image-generation/">Image Generation</a></li>
109
+ <li><a class="active" title="Qwen" href="/help/en/model-studio/qwen-image-api-reference/">Qwen</a></li>
110
+ <li><a class="active" title="Qwen Image Generation and Editing" href="/help/en/model-studio/qwen-image-generation-and-editing-api-reference">Qwen Image Generation and Editing</a></li>
111
+ </ul>
112
+ </div>
113
+ <div class="col-md-4 col-sm-12">
114
+ <button type="button" class="navbar-toggle bc mr0" data-toggle="collapse"
115
+ data-target="#sideMenu-mobile">
116
+ <span class="icon-bar"></span>
117
+ <span class="icon-bar"></span>
118
+ all-products-head <span class="icon-bar"></span>
119
+ </button>
120
+ </div>
121
+ </div>
122
+ <form class="search-bar clearfix" method="GET" action="/s/en">
123
+ <input type="hidden" name="type" value="doc"/>
124
+ <div class="select">
125
+ <p class="select-text">
126
+ <span class="placeholder">This Product</span>
127
+ <i class="icon-docs icon-docs-selected"></i>
128
+ </p>
129
+ <ul class="select-options" style="display:none;">
130
+ <li class="option selected" data-value="h_pid_$productId">This Product</li>
131
+ <li class="option" data-value="">All Products</li>
132
+ </ul>
133
+ <input type="hidden" name="rangeinfo" value="h_pid_2400256"/>
134
+ </div>
135
+ <input autocomplete="off" class="search-key" type="text" placeholder="Search by keyword" name="k"/>
136
+ <ul class="help-top-search-result" style="display: block;"></ul>
137
+ <button class="search-submit" type="submit">
138
+ <i class="icon-docs icon-docs-search"></i>
139
+ </button>
140
+ <div class="collapse-menus select">
141
+ <p class="select-text">
142
+ <span class="placeholder">Alibaba Cloud Model Studio:Qwen Image Generation and Editing API Reference</span>
143
+ <i class="icon-docs icon-docs-more"></i>
144
+ </p>
145
+ </div>
146
+ </form>
147
+ </div>
148
+ <header id="header-faq" class="clearfix">
149
+ <a class="doc-center" href="/help/en">
150
+ <i class="icon-docs icon-docs-back"></i>
151
+ Document Center
152
+ </a>
153
+ <div class="download-links">
154
+ </div>
155
+ <h1 class="page-title">Alibaba Cloud Model Studio:Qwen Image Generation and Editing API Reference</h1>
156
+ <div class="doc-status">
157
+ Last Updated:Oct 11, 2026
158
+ </div>
159
+ </header>
160
+ <article class="product-description markdown-body">
161
+ <div lang="en" class="icms-help-docs-content">
162
+ <div lang="en" class="icms-help-docs-content"><p data-tag="shortdesc" class="shortdesc">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.</p><h2 id="model-overview">Model overview <span id="en-6740266-model-title"></span> <span id="en-6740266-model-overview"></span></h2>
163
+ <table style="display:table;table-layout:fixed;width:100%"><colgroup><col style="width:24%"/><col style="width:38%"/><col style="width:38%"/></colgroup><thead><tr><th><p><strong>Model</strong></p></th><th><p><strong>Description</strong></p></th><th><p><strong>Output image specifications</strong></p></th></tr></thead><tbody><tr><td><p>qwen-image-3.0-pro</p></td><td><p>Qwen Image Generation and Editing 3.0 model that supports both text-to-image (T2I) and image-to-image/image editing (I2I).</p></td><td rowspan="4"><p>Image resolution:</p><ul><li><p><strong>Text-to-image (T2I)</strong>: Total pixels must be between 512*512 and 2048*2048.</p></li><li><p><strong>Image-to-image (I2I)</strong>: Total pixels must be between 512*512 and 2048*2048.</p></li><li><p><strong>Default</strong>: When <code>size</code> is not specified, the model automatically recommends a resolution based on the prompt.</p></li></ul><p>Image format: PNG</p></td></tr><tr><td><p>qwen-image-3.0</p></td><td><p>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.</p></td></tr><tr><td><p>qwen-image-2.1-pro</p></td><td><p>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.</p></td></tr><tr><td><p>qwen-image-2.1-turbo</p></td><td><p>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.</p></td></tr></tbody></table>
164
+ <h2 id="availability">Availability <span id="1fd78afa5brlj"></span> <span id="en-6740266-prereq"></span></h2>
165
+ <p>The model, endpoint URL, and API key must belong to the same region. Cross-region calls fail.</p>
166
+ <ul>
167
+ <li><a href="/help/en/model-studio/video-generate-edit-model">Select a model</a>: Verify that the model is available in your target region.</li>
168
+ <li><strong>Select a URL</strong>: Choose the endpoint URL that matches your model&#x27;s region. Both HTTP and DashScope SDK URLs are supported.</li>
169
+ <li><strong>Configure an API key</strong>: Get an <a href="/help/en/model-studio/get-api-key">API key</a> for the region, and then <a href="/help/en/model-studio/get-api-key">configure the API key as an environment variable</a>.</li>
170
+ <li><strong>Install the SDK</strong>: To make API calls with the SDK, <a href="/help/en/model-studio/install-sdk">install the DashScope SDK</a>.</li>
171
+ </ul>
172
+ <div class="note note-note"><div class="note-icon-wrapper"></div><div class="note-content"><p><strong>Note</strong>The sample code in this topic applies to the <strong>Singapore</strong> region.</p></div></div>
173
+ <div class="note note-important"><div class="note-icon-wrapper"></div><div class="note-content"><p><strong>Important</strong>Alibaba Cloud Model Studio has released workspace-specific domains for the China (Beijing) and Singapore regions. <strong>The new dedicated domains deliver superior performance and higher stability for inference requests</strong>. We recommend migrating to the new domains:</p><ul>
174
+ <li>China (Beijing): from <code>https://dashscope.aliyuncs.com</code> to <code>https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com</code></li>
175
+ <li>Singapore: from <code>https://dashscope-intl.aliyuncs.com</code> to <code>https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com</code></li>
176
+ </ul><p><code>{WorkspaceId}</code> is your workspace ID, which can be found on the <strong>Workspace Details</strong> page in the Alibaba Cloud Model Studio console. The existing domain remains fully functional.</p></div></div>
177
+ <h2 id="access-methods">Access methods <span id="en-6740266-access-title"></span></h2>
178
+ <p>Qwen Image Generation and Editing offers three access methods with identical model capabilities. Choose the one that fits your application:</p>
179
+ <table style="display:table;table-layout:fixed;width:100%"><colgroup><col style="width:28%"/><col style="width:72%"/></colgroup><thead><tr><th><p><strong>Access method</strong></p></th><th><p><strong>When to use</strong></p></th></tr></thead><tbody><tr><td><p><a href="/help/en/model-studio/qwen-image-generation-and-editing-api-reference#en-6740266-openai-title">OpenAI-compatible</a></p></td><td><p>Applications already built on the OpenAI Images protocol or the OpenAI SDK. Switch <code>base_url</code> and <code>model</code> to migrate. Synchronous calls only. Image input supports both public URL and Base64.</p></td></tr><tr><td><p><a href="/help/en/model-studio/qwen-image-generation-and-editing-api-reference#en-6740266-sync-title">DashScope synchronous</a></p></td><td><p>Recommended. Full feature coverage, including both public URL and Base64 image input.</p></td></tr><tr><td><p><a href="/help/en/model-studio/qwen-image-generation-and-editing-api-reference#en-6740266-async-title">DashScope asynchronous</a></p></td><td><p>Batch generation, or when you do not want to hold a connection open. Submit a task and poll for results with <code>task_id</code>.</p></td></tr></tbody></table>
180
+ <h2 id="openai-compatible">OpenAI-compatible <span id="en-6740266-openai-title"></span></h2>
181
+ <p>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: <strong>omit</strong> <code>image</code> <strong>for T2I, and provide</strong> <code>image</code> <strong>for I2I</strong>.</p>
182
+ <div class="note note-note"><div class="note-icon-wrapper"></div><div class="note-content"><p><strong>Note</strong>The OpenAI-compatible mode is a <strong>synchronous, non-streaming</strong> endpoint. Image editing uses the <code>image</code> extension field on <code>/images/generations</code>. It does <strong>not</strong> use the multipart file upload format of the official OpenAI <code>/images/edits</code> endpoint. The following are not yet supported: asynchronous calls, streaming output, partial images, <code>/images/edits</code>, multipart, and mask. Passing <code>response_format=b64_json</code> does not raise an error, but it is ignored and the response still contains image URLs. For asynchronous calls, use <a href="/help/en/model-studio/qwen-image-generation-and-editing-api-reference#en-6740266-async-title">DashScope asynchronous</a>.</p></div></div>
183
+ <h3 id="url">URL <span id="en-6740266-openai-url-title"></span></h3>
184
+ <section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs" class="tabbed-content-box section"><section id="singapore" class="section"><h4 id="singapore-h4">Singapore</h4><p>HTTP endpoint: <code>POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/images/generations</code></p><p>base_url for SDK calls: <code>https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1</code></p></section><section id="us-virginia" class="section"><h4 id="us-virginia-h4">US (Virginia)</h4><p>HTTP endpoint: <code>POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/compatible-mode/v1/images/generations</code></p><p>base_url for SDK calls: <code>https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/compatible-mode/v1</code></p></section><section id="china-beijing" class="section"><h4 id="china-beijing-h4">China (Beijing)</h4><p>HTTP endpoint: <code>POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/images/generations</code></p><p>base_url for SDK calls: <code>https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1</code></p></section><section id="china-hong-kong" class="section"><h4 id="china-hong-kong-h4">China (Hong Kong)</h4><p>HTTP endpoint: <code>POST https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/compatible-mode/v1/images/generations</code></p><p>base_url for SDK calls: <code>https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/compatible-mode/v1</code></p></section><section id="germany-frankfurt" class="section"><h4 id="germany-frankfurt-h4">Germany (Frankfurt)</h4><p>HTTP endpoint: <code>POST https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/compatible-mode/v1/images/generations</code></p><p>base_url for SDK calls: <code>https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/compatible-mode/v1</code></p></section><section id="japan-tokyo" class="section"><h4 id="japan-tokyo-h4">Japan (Tokyo)</h4><p>HTTP endpoint: <code>POST https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/compatible-mode/v1/images/generations</code></p><p>base_url for SDK calls: <code>https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/compatible-mode/v1</code></p></section></section>
185
+ <p>Replace <code>{WorkspaceId}</code> with your actual <a href="/help/en/model-studio/regions#h2_migrate_domain">workspace ID</a>.</p>
186
+ <table bordertype="no-border" style="display:table;table-layout:fixed;width:100%"><colgroup><col style="width:50%"/><col style="width:50%"/></colgroup><tbody><tr><td><h3>Request parameters <span id="en-6740266-openai-req-params-title"></span></h3><h4>Headers <span id="en-6740266-openai-headers-h4"></span></h4><p><strong>Content-Type</strong> <code>string</code> <strong>(Required)</strong></p><p>The content type of the request. Must be <code>application/json</code>.</p><p><strong>Authorization</strong> <code>string</code> <strong>(Required)</strong></p><p>Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.</p><h4>Request body <span id="en-6740266-openai-body-h4"></span></h4><p>Unlike the DashScope protocol, the OpenAI-compatible mode places <strong>all parameters at the top level</strong> of the request body. There is no <code>input</code> or <code>parameters</code> nesting.</p><p><strong>model</strong> <code>string</code> <strong>(Required)</strong></p><p>The model name. Available values: <code>qwen-image-3.0-pro</code>, <code>qwen-image-3.0</code>, <code>qwen-image-2.1-pro</code>, and <code>qwen-image-2.1-turbo</code>.</p><p><strong>prompt</strong> <code>string</code> <strong>(Required)</strong></p><p>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.</p><p><strong>image</strong> <code>string</code><strong> or </strong><code>array</code> (Optional)</p><p>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.</p><p><strong>Note</strong>: <code>null</code> and empty arrays are rejected with a 400 error.</p><strong>Image requirements:</strong><ul>
187
+ <li>Image format: JPG, JPEG, PNG, BMP, TIFF, WEBP, and GIF.</li>
188
+ <li>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.</li>
189
+ <li>Aspect ratio: The ratio of the longer side to the shorter side must not exceed 10:1.</li>
190
+ <li>Image size: Up to 10 MB.</li>
191
+ </ul><strong>Supported input formats</strong><ol>
192
+ <li>Public URL: HTTP and HTTPS protocols are supported.</li>
193
+ <li>Base64 encoding: Format is <code>data:{MIME_type};base64,{base64_data}</code>.</li>
194
+ </ol><p><strong>n</strong> <code>integer</code> (Optional)</p><p>The number of output images. Value range: 1 to 6. Default: 1. Must be an integer. A string value such as <code>&quot;1&quot;</code> returns a 400 error.</p><p><strong>size</strong> <code>string</code> (Optional)</p><p>The output image resolution in the format <code>widthxheight</code>, for example <code>&quot;1024x1024&quot;</code>. You can also pass <code>auto</code>. If not specified, the model automatically recommends a resolution based on the prompt.</p><div class="note note-warning"><div class="note-icon-wrapper"></div><div class="note-content"><p><strong>Warning</strong>The OpenAI protocol uses the <strong>letter</strong> <code>x</code> <strong>as the separator</strong> (<code>1024x1024</code>), not the asterisk <code>*</code> used by the DashScope protocol (<code>1024*1024</code>). Update this value when migrating from DashScope.</p></div></div><ul>
195
+ <li><strong>Text-to-image (T2I)</strong>: Pixel area from 512x512 to 2048x2048. Aspect ratio: 1:8 to 8:1.</li>
196
+ <li><strong>Image-to-image (I2I)</strong>: Pixel area from 512x512 to 2048x2048. Aspect ratio: 1:8 to 8:1.</li>
197
+ </ul><p><strong>negative_prompt</strong> <code>string</code> (Optional)</p><p>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.</p><p><strong>seed</strong> <code>integer</code> (Optional)</p><p>The random seed. Value range: <code>[0, 2147483647]</code>. If omitted, the service generates a random seed. Use a fixed seed for reproducible results.</p><p><strong>prompt_extend</strong> <code>boolean</code> (Optional)</p><p>Whether to enable intelligent prompt rewriting. Default: <code>true</code> (recommended). When enabled, the model optimizes the positive prompt using the method specified by <code>prompt_extend_mode</code>, which significantly improves results for simple descriptions.</p><p><strong>prompt_extend_mode</strong> <code>string</code> (Optional)</p><p>The prompt rewriting method. Default: <code>direct</code>. Options:</p><ul>
198
+ <li><code>direct</code>: Direct Prompt Enhancement (DPE), suitable for most scenarios. Supported for both T2I and I2I.</li>
199
+ <li><code>agent</code>: Agent Prompt Enhancement (APE), provides more refined rewriting. Only supports text-to-image (T2I). Passing <code>agent</code> for image-to-image (I2I) will return a 400 error.</li>
200
+ </ul><p><strong>enable_thinking</strong> <code>boolean</code> (Optional)</p><p>Enables thinking mode. The default is <code>true</code>. This enhances model reasoning to improve image quality, but increases generation time. It requires <code>prompt_extend=true</code>. Supported for Direct T2I, Direct I2I, and Agent T2I. Not supported for I2I Agent.</p><p><strong>watermark</strong> <code>boolean</code> (Optional)</p><p>Whether to add a watermark. Default: <code>false</code>.</p><div class="note note-note"><div class="note-icon-wrapper"></div><div class="note-content"><p><strong>Note</strong><code>image</code>, <code>negative_prompt</code>, <code>seed</code>, <code>prompt_extend</code>, <code>prompt_extend_mode</code>, <code>enable_thinking</code>, and <code>watermark</code> 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 <code>extra_body</code>.</p></div></div></td><td><div outputclass="tabbed-codeblock" data-tag="fig" id="fig-code-group" class="tabbed-codeblock-box"><div class="tab-box"></div><input id="fig-code-group-text-to-image-tab" type="radio" name="check-fig-code-group" checked=""/><label for="fig-code-group-text-to-image-tab">Text-to-image</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-text-to-image" outputclass="language-bash" code-type="xCode" class="pre codeblock language-bash"><code>curl --location &#x27;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/images/generations&#x27; \
201
+ --header &#x27;Content-Type: application/json&#x27; \
202
+ --header &quot;Authorization: Bearer $DASHSCOPE_API_KEY&quot; \
203
+ --data &#x27;{
204
+ &quot;model&quot;: &quot;qwen-image-3.0-pro&quot;,
205
+ &quot;prompt&quot;: &quot;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 &#x27;\&#x27;&#x27;Il Messaggero&#x27;\&#x27;&#x27; 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&#x27;\&#x27;&#x27;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.&quot;,
206
+ &quot;size&quot;: &quot;1024x1024&quot;,
207
+ &quot;n&quot;: 1,
208
+ &quot;prompt_extend&quot;: true
209
+ }&#x27;
210
+ </code></pre></div><input id="fig-code-group-image-to-image-tab" type="radio" name="check-fig-code-group"/><label for="fig-code-group-image-to-image-tab">Image-to-image</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-image-to-image" outputclass="language-bash" code-type="xCode" class="pre codeblock language-bash"><code>curl --location &#x27;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/images/generations&#x27; \
211
+ --header &#x27;Content-Type: application/json&#x27; \
212
+ --header &quot;Authorization: Bearer $DASHSCOPE_API_KEY&quot; \
213
+ --data &#x27;{
214
+ &quot;model&quot;: &quot;qwen-image-3.0-pro&quot;,
215
+ &quot;prompt&quot;: &quot;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.&quot;,
216
+ &quot;image&quot;: &quot;https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png&quot;,
217
+ &quot;size&quot;: &quot;1024x1024&quot;,
218
+ &quot;n&quot;: 1,
219
+ &quot;prompt_extend&quot;: true
220
+ }&#x27;
221
+ </code></pre></div></div></td></tr></tbody></table>
222
+ <table bordertype="no-border" style="display:table;table-layout:fixed;width:100%"><colgroup><col style="width:50%"/><col style="width:50%"/></colgroup><tbody><tr><td><h3>Response parameters <span id="en-6740266-openai-resp-title"></span></h3><p><strong>created</strong> <code>integer</code></p><p>The Unix timestamp, in seconds, when the response was created.</p><p><strong>data</strong> <code>array</code></p><p>The list of generated results. When <code>n</code> is greater than 1, the array contains multiple elements.</p><section class="collapse expanded" id="accordion-properties"><p>Properties</p><div><p><strong>url</strong> <code>string</code></p><p>The URL of the generated image in PNG format. <strong>The link is valid for 24 hours.</strong> Download and save the image promptly.</p></div></section><p><strong>usage</strong> <code>object</code></p><p>The resource usage of this call. Only returned on success. These are <strong>image input and output metering fields, not token usage</strong>.</p><section class="collapse expanded" id="accordion-properties-2"><p>Properties</p><div><section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-2" class="tabbed-content-box section"><section id="qwen-image-3-0-series" class="section"><h4 id="qwen-image-3-0-series-h4">qwen-image-3.0 series</h4><p><strong>output_width</strong> <code>integer</code></p><p>The width of the final output image in pixels.</p><p><strong>output_height</strong> <code>integer</code></p><p>The height of the final output image in pixels.</p><p><strong>input_image_count</strong> <code>integer</code></p><p>The number of input images in the request. Returns 0 for text-to-image (T2I), and the actual count for image-to-image (I2I).</p><p><strong>input_image_type</strong> <code>string</code></p><p>The input image billing tier. Determined by the output resolution pixel area: <code>qima_input_1k</code> if area ≤ 2,250,000, or <code>qima_input_2k</code> if area &gt; 2,250,000.</p><p><strong>output_image_count</strong> <code>integer</code></p><p>The actual number of output images returned.</p><p><strong>output_image_type</strong> <code>string</code></p><p>The output image billing tier. Determined by the output resolution pixel area: <code>qima_output_1k</code> if area ≤ 2,250,000, or <code>qima_output_2k</code> if area &gt; 2,250,000.</p></section><section id="qwen-image-2-1-series" class="section"><h4 id="qwen-image-2-1-series-h4">qwen-image-2.1 series</h4><p><strong>image_count</strong> <code>integer</code></p><p>The number of images generated by the model.</p><p><strong>width</strong> <code>integer</code></p><p>The width of the generated image in pixels.</p><p><strong>height</strong> <code>integer</code></p><p>The height of the generated image in pixels.</p></section></section></div></section><p><strong>error</strong> <code>object</code></p><p>The error details. Only returned for failed requests.</p><section class="collapse expanded" id="accordion-properties-3"><p>Properties</p><div><p><strong>message</strong> <code>string</code></p><p>Detailed error message.</p><p><strong>type</strong> <code>string</code></p><p>The error type, such as <code>invalid_request_error</code>.</p><p><strong>param</strong> <code>string</code></p><p>The name of the parameter that caused the error, or <code>null</code> when the error cannot be attributed to a specific parameter.</p><p><strong>code</strong> <code>string</code></p><p>Error code. See <a href="/help/en/model-studio/error-code">Error codes</a>.</p></div></section><div class="note note-note"><div class="note-icon-wrapper"></div><div class="note-content"><p><strong>Note</strong>Unlike the DashScope protocol, the OpenAI-compatible mode <strong>does not return</strong> <code>request_id</code> in the response body. The unique request identifier is returned in the <code>x-request-id</code> HTTP response header. With the OpenAI Python SDK, read <code>response._request_id</code> on success and <code>APIStatusError.request_id</code> on failure. Include this identifier when reporting an issue.</p></div></div></td><td><section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-3" class="tabbed-content-box section"><section id="success" class="section"><h4 id="success-h4">Success</h4><p>Image URLs are retained for only 24 hours and then automatically purged. Save generated images promptly.</p><div outputclass="tabbed-codeblock" data-tag="fig" id="fig-code-group-2" class="tabbed-codeblock-box"><div class="tab-box"></div><input id="fig-code-group-2-qwen-image-3-0-series-tab" type="radio" name="check-fig-code-group-2" checked=""/><label for="fig-code-group-2-qwen-image-3-0-series-tab">qwen-image-3.0 series</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-2-qwen-image-3-0-series" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
223
+ &quot;created&quot;: 1788339600,
224
+ &quot;data&quot;: [
225
+ {
226
+ &quot;url&quot;: &quot;https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx&quot;
227
+ }
228
+ ],
229
+ &quot;usage&quot;: {
230
+ &quot;output_height&quot;: 1024,
231
+ &quot;output_width&quot;: 1024,
232
+ &quot;input_image_count&quot;: 0,
233
+ &quot;input_image_type&quot;: &quot;qima_input_1k&quot;,
234
+ &quot;output_image_count&quot;: 1,
235
+ &quot;output_image_type&quot;: &quot;qima_output_1k&quot;
236
+ }
237
+ }
238
+ </code></pre></div><input id="fig-code-group-2-qwen-image-2-1-series-tab" type="radio" name="check-fig-code-group-2"/><label for="fig-code-group-2-qwen-image-2-1-series-tab">qwen-image-2.1 series</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-2-qwen-image-2-1-series" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
239
+ &quot;created&quot;: 1788339600,
240
+ &quot;data&quot;: [
241
+ {
242
+ &quot;url&quot;: &quot;https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx&quot;
243
+ }
244
+ ],
245
+ &quot;usage&quot;: {
246
+ &quot;image_count&quot;: 1,
247
+ &quot;width&quot;: 1024,
248
+ &quot;height&quot;: 1024
249
+ }
250
+ }
251
+ </code></pre></div></div></section><section id="error" class="section"><h4 id="error-h4">Error</h4><p>If the request fails, the response contains an <code>error</code> object whose <code>code</code> and <code>message</code> fields identify the cause. See <a href="/help/en/model-studio/error-code">Error codes</a> for troubleshooting.</p><pre data-tag="codeblock" id="code-block" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
252
+ &quot;error&quot;: {
253
+ &quot;message&quot;: &quot;Field &#x27;prompt&#x27; is required&quot;,
254
+ &quot;type&quot;: &quot;invalid_request_error&quot;,
255
+ &quot;param&quot;: null,
256
+ &quot;code&quot;: &quot;InvalidParameter&quot;
257
+ }
258
+ }
259
+ </code></pre></section></section></td></tr></tbody></table>
260
+ <h3 id="sdk">SDK <span id="en-6740266-openai-sdk-title"></span></h3>
261
+ <p>Install or upgrade the OpenAI Python SDK first:</p>
262
+ <pre data-tag="codeblock" id="code-block-2" outputclass="language-bash" code-type="xCode" class="pre codeblock language-bash"><code>pip install -U openai
263
+ </code></pre>
264
+ <div class="note note-important"><div class="note-icon-wrapper"></div><div class="note-content"><p><strong>Important</strong>Image generation can take a long time. Set an explicit, generous client timeout. For multi-image output (a larger <code>n</code>) or concurrent requests, start at 600 seconds so the client does not disconnect early.</p></div></div>
265
+ <div outputclass="tabbed-codeblock" data-tag="fig" id="fig-code-group-3" class="tabbed-codeblock-box"><div class="tab-box"></div><input id="fig-code-group-3-text-to-image-tab" type="radio" name="check-fig-code-group-3" checked=""/><label for="fig-code-group-3-text-to-image-tab">Text-to-image</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-3-text-to-image" outputclass="language-python" code-type="xCode" class="pre codeblock language-python"><code>import os
266
+ from openai import OpenAI
267
+
268
+ client = OpenAI(
269
+ api_key=os.getenv(&quot;DASHSCOPE_API_KEY&quot;),
270
+ base_url=&quot;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1&quot;,
271
+ timeout=600.0,
272
+ )
273
+
274
+ response = client.images.generate(
275
+ model=&quot;qwen-image-3.0-pro&quot;,
276
+ prompt=&quot;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 &#x27;Il Messaggero&#x27; 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&#x27;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.&quot;,
277
+ size=&quot;1024x1024&quot;,
278
+ n=1,
279
+ # All parameters above are official OpenAI parameters. Extension fields such as
280
+ # image and prompt_extend go through extra_body. See the I2I example.
281
+ )
282
+
283
+ for item in response.data:
284
+ print(item.url)
285
+ print(f&quot;request_id: {response._request_id}&quot;)
286
+ </code></pre></div><input id="fig-code-group-3-image-to-image-tab" type="radio" name="check-fig-code-group-3"/><label for="fig-code-group-3-image-to-image-tab">Image-to-image</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-3-image-to-image" outputclass="language-python" code-type="xCode" class="pre codeblock language-python"><code>import os
287
+ from openai import OpenAI
288
+
289
+ client = OpenAI(
290
+ api_key=os.getenv(&quot;DASHSCOPE_API_KEY&quot;),
291
+ base_url=&quot;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1&quot;,
292
+ timeout=600.0,
293
+ )
294
+
295
+ response = client.images.generate(
296
+ model=&quot;qwen-image-3.0-pro&quot;,
297
+ prompt=&quot;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.&quot;,
298
+ size=&quot;1024x1024&quot;,
299
+ n=1,
300
+ extra_body={
301
+ # A single image can also be passed as a plain string. Base64 is also accepted:
302
+ # data:{MIME_type};base64,{base64_data}
303
+ &quot;image&quot;: [
304
+ &quot;https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png&quot;
305
+ ],
306
+ &quot;prompt_extend&quot;: True,
307
+ },
308
+ )
309
+
310
+ for item in response.data:
311
+ print(item.url)
312
+ print(f&quot;request_id: {response._request_id}&quot;)
313
+ </code></pre></div><input id="fig-code-group-3-reading-request-id-tab" type="radio" name="check-fig-code-group-3"/><label for="fig-code-group-3-reading-request-id-tab">Reading request_id</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-3-reading-request-id" outputclass="language-python" code-type="xCode" class="pre codeblock language-python"><code>import os
314
+ from openai import OpenAI, APIStatusError
315
+
316
+ client = OpenAI(
317
+ api_key=os.getenv(&quot;DASHSCOPE_API_KEY&quot;),
318
+ base_url=&quot;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1&quot;,
319
+ timeout=600.0,
320
+ )
321
+
322
+ try:
323
+ response = client.images.generate(
324
+ model=&quot;qwen-image-3.0-pro&quot;,
325
+ prompt=&quot;A vertical outdoor portrait photograph with a warm afternoon street atmosphere.&quot;,
326
+ )
327
+ print(response.data[0].url)
328
+ except APIStatusError as exc:
329
+ print(f&quot;status_code: {exc.status_code}&quot;)
330
+ print(f&quot;request_id: {exc.request_id}&quot;)
331
+ print(exc)
332
+ </code></pre></div></div>
333
+ <h2 id="dashscope-synchronous-api-recommended">DashScope synchronous API (recommended) <span id="en-6740266-sync-title"></span> <span id="en-6740266-sync"></span></h2>
334
+ <h3 id="http">HTTP <span id="en-6740266-http-title"></span> <span id="en-6740266-http"></span></h3>
335
+ <section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-4" class="tabbed-content-box section"><section id="singapore-2" class="section"><h4 id="singapore-2-h4">Singapore</h4><p><code>POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation</code></p></section><section id="us-virginia-2" class="section"><h4 id="us-virginia-2-h4">US (Virginia)</h4><p><code>POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation</code></p></section><section id="china-beijing-2" class="section"><h4 id="china-beijing-2-h4">China (Beijing)</h4><p><code>POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation</code></p></section><section id="china-hong-kong-2" class="section"><h4 id="china-hong-kong-2-h4">China (Hong Kong)</h4><p><code>POST https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation</code></p></section><section id="germany-frankfurt-2" class="section"><h4 id="germany-frankfurt-2-h4">Germany (Frankfurt)</h4><p><code>POST https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation</code></p></section><section id="japan-tokyo-2" class="section"><h4 id="japan-tokyo-2-h4">Japan (Tokyo)</h4><p><code>POST https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation</code></p></section></section>
336
+ <p>Replace <code>{WorkspaceId}</code> with your actual <a href="/help/en/model-studio/regions#h2_migrate_domain">workspace ID</a>.</p>
337
+ <table bordertype="no-border" style="display:table;table-layout:fixed;width:100%"><colgroup><col style="width:50%"/><col style="width:50%"/></colgroup><tbody><tr><td><h4>Request parameters <span id="en-6740266-req-params-h4"></span> <span id="en-6740266-req-section"></span></h4><h5>Headers <span id="en-6740266-headers-h5"></span></h5><p><strong>Content-Type</strong> <code>string</code> <strong>(Required)</strong></p><p>The content type of the request. Must be <code>application/json</code>.</p><p><strong>Authorization</strong> <code>string</code> <strong>(Required)</strong></p><p>Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.</p><h5>Request body <span id="en-6740266-body-h5"></span></h5><p><strong>model</strong> <code>string</code> <strong>(Required)</strong></p><p>The model name. Available values: <code>qwen-image-3.0-pro</code>, <code>qwen-image-3.0</code>, <code>qwen-image-2.1-pro</code>, and <code>qwen-image-2.1-turbo</code>.</p><p><strong>input</strong> <code>object</code> <strong>(Required)</strong></p><p>The input parameter object, which contains the following fields:</p><section class="collapse expanded" id="accordion-properties-4"><p>Properties</p><div><p><strong>messages</strong> <code>array</code> <strong>(Required)</strong></p><p>The request content array. <strong>Only single-round conversations are supported</strong>, so the array must contain <strong>exactly one object</strong> with <code>role</code> and <code>content</code> properties.</p><section class="collapse expanded" id="accordion-properties-5"><p>Properties</p><div><p><strong>role</strong><code>string</code> <strong>(Required)</strong></p><p>The role of the message sender. Must be set to <code>user</code>.</p><p><strong>content</strong><code>array</code> <strong>(Required)</strong></p><p>The message content array, with different combinations depending on the use case:</p><ul>
338
+ <li><strong>Text-to-image (T2I)</strong>: Contains only one <code>{&quot;text&quot;: &quot;...&quot;}</code> object.</li>
339
+ <li><strong>Image-to-image (I2I)</strong>: the qwen-image-2.1 series contains 1-10 <code>{&quot;image&quot;: &quot;...&quot;}</code> objects, the qwen-image-3.0 series contains 1-3, and 1 <code>{&quot;text&quot;: &quot;...&quot;}</code> object.</li>
340
+ </ul><section class="collapse expanded" id="accordion-properties-6"><p>Properties</p><div><p><strong>image</strong> <code>string</code> <strong>(Required for I2I)</strong></p><p>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.</p><strong>Image requirements:</strong><ul>
341
+ <li>Image format: JPG, JPEG, PNG, BMP, TIFF, WEBP, and GIF.</li>
342
+ <li>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.</li>
343
+ <li>Aspect ratio: The ratio of the longer side to the shorter side must not exceed 10:1.</li>
344
+ <li>Image size: Up to 10 MB.</li>
345
+ </ul><strong>Supported input formats</strong><ol>
346
+ <li>Public URL: HTTP and HTTPS protocols are supported.</li>
347
+ <li>Base64 encoding: Format is <code>data:{MIME_type};base64,{base64_data}</code>.</li>
348
+ </ol><p><strong>text</strong><code>string</code><strong>(Required)</strong></p><p>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.</p><p><strong>Note</strong>: Only one text object is allowed. Omitting it or providing multiple text objects will result in an error.</p></div></section></div></section></div></section><p><strong>parameters</strong> <code>object</code> (Optional)</p><p>Additional parameters to control image generation.</p><section class="collapse expanded" id="accordion-properties-7"><p>Properties</p><div><p><strong>prompt_extend</strong> <code>boolean</code> (Optional)</p><p>Whether to enable intelligent prompt rewriting. Default: <code>true</code> (recommended). When enabled, the model optimizes the positive prompt using the method specified by <code>prompt_extend_mode</code>, which significantly improves results for simple descriptions.</p><p><strong>prompt_extend_mode</strong> <code>string</code> (Optional)</p><p>The prompt rewriting method. Default: <code>direct</code>. Options:</p><ul>
349
+ <li><code>direct</code>: Direct Prompt Enhancement (DPE), suitable for most scenarios. Supported for both T2I and I2I.</li>
350
+ <li><code>agent</code>: Agent Prompt Enhancement (APE), provides more refined rewriting. Only supports text-to-image (T2I). Passing <code>agent</code> for image-to-image (I2I) will return a 400 error.</li>
351
+ </ul><p><strong>enable_thinking</strong> <code>boolean</code> (Optional)</p><p>Enables thinking mode. The default is <code>true</code>. This enhances model reasoning to improve image quality, but increases generation time. It requires <code>prompt_extend=true</code>. Supported for Direct T2I, Direct I2I, and Agent T2I. Not supported for I2I Agent.</p><p><strong>n</strong> <code>integer</code> (Optional)</p><p>The number of output images. Value range: 1 to 6. Default: 1.</p><p><strong>size</strong> <code>string</code> (Optional)</p><p>The output image resolution in the format <code>width*height</code>, for example <code>&quot;1024*1024&quot;</code>. If not specified, the model automatically recommends a resolution based on the prompt.</p><ul>
352
+ <li><strong>Text-to-image (T2I)</strong>: Pixel area from 512*512 to 2048*2048. Aspect ratio: 1:8 to 8:1.</li>
353
+ <li><strong>Image-to-image (I2I)</strong>: Pixel area from 512*512 to 2048*2048. Aspect ratio: 1:8 to 8:1.</li>
354
+ </ul><p><strong>negative_prompt</strong> <code>string</code> (Optional)</p><p>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.</p><p><strong>seed</strong> <code>integer</code> (Optional)</p><p>The random seed. Value range: <code>[0, 2147483647]</code>. If omitted, the service generates a random seed. Use a fixed seed for reproducible results.</p><p><strong>watermark</strong> <code>boolean</code> (Optional)</p><p>Whether to add a watermark. Default: <code>false</code>.</p></div></section></td><td><div outputclass="tabbed-codeblock" data-tag="fig" id="fig-code-group-4" class="tabbed-codeblock-box"><div class="tab-box"></div><input id="fig-code-group-4-text-to-image-tab" type="radio" name="check-fig-code-group-4" checked=""/><label for="fig-code-group-4-text-to-image-tab">Text-to-image</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-4-text-to-image" outputclass="language-bash" code-type="xCode" class="pre codeblock language-bash"><code>curl --location &#x27;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation&#x27; \
355
+ --header &#x27;Content-Type: application/json&#x27; \
356
+ --header &quot;Authorization: Bearer $DASHSCOPE_API_KEY&quot; \
357
+ --data &#x27;{
358
+ &quot;model&quot;: &quot;qwen-image-3.0-pro&quot;,
359
+ &quot;input&quot;: {
360
+ &quot;messages&quot;: [
361
+ {
362
+ &quot;role&quot;: &quot;user&quot;,
363
+ &quot;content&quot;: [
364
+ {
365
+ &quot;text&quot;: &quot;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 &#x27;\&#x27;&#x27;Il Messaggero&#x27;\&#x27;&#x27; 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&#x27;\&#x27;&#x27;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.&quot;
366
+ }
367
+ ]
368
+ }
369
+ ]
370
+ },
371
+ &quot;parameters&quot;: {
372
+ &quot;prompt_extend&quot;: true
373
+ }
374
+ }&#x27;
375
+ </code></pre></div><input id="fig-code-group-4-image-to-image-tab" type="radio" name="check-fig-code-group-4"/><label for="fig-code-group-4-image-to-image-tab">Image-to-image</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-4-image-to-image" outputclass="language-bash" code-type="xCode" class="pre codeblock language-bash"><code>curl --location &#x27;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation&#x27; \
376
+ --header &#x27;Content-Type: application/json&#x27; \
377
+ --header &quot;Authorization: Bearer $DASHSCOPE_API_KEY&quot; \
378
+ --data &#x27;{
379
+ &quot;model&quot;: &quot;qwen-image-3.0-pro&quot;,
380
+ &quot;input&quot;: {
381
+ &quot;messages&quot;: [
382
+ {
383
+ &quot;role&quot;: &quot;user&quot;,
384
+ &quot;content&quot;: [
385
+ {
386
+ &quot;image&quot;: &quot;https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png&quot;
387
+ },
388
+ {
389
+ &quot;text&quot;: &quot;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.&quot;
390
+ }
391
+ ]
392
+ }
393
+ ]
394
+ },
395
+ &quot;parameters&quot;: {
396
+ &quot;prompt_extend&quot;: true
397
+ }
398
+ }&#x27;
399
+ </code></pre></div></div></td></tr></tbody></table>
400
+ <table bordertype="no-border" style="display:table;table-layout:fixed;width:100%"><colgroup><col style="width:50%"/><col style="width:50%"/></colgroup><tbody><tr><td><h4>Response parameters <span id="en-6740266-resp-h4"></span> <span id="en-6740266-resp-section"></span></h4><p><strong>output</strong> <code>object</code></p><p>Contains the model generation results.</p><section class="collapse expanded" id="accordion-properties-8"><p>Properties</p><div><p><strong>rewrite_status</strong> <code>string</code></p><p>The prompt rewriting status. The value depends on whether rewriting was enabled in the request and the result of the rewrite.</p><p><strong>choices</strong> <code>array</code></p><p>The list of result options.</p><section class="collapse expanded" id="accordion-properties-9"><p>Properties</p><div><p><strong>finish_reason</strong> <code>string</code></p><p>The reason why the task stopped. The value is <code>stop</code> when the task completes normally.</p><p><strong>message</strong> <code>object</code></p><p>The message returned by the model.</p><section class="collapse expanded" id="accordion-properties-10"><p>Properties</p><div><p><strong>role</strong><code>string</code></p><p>The role of the message. Fixed as <code>assistant</code>.</p><p><strong>content</strong><code>array</code></p><p>The message content containing the generated image information.</p><section class="collapse expanded" id="accordion-properties-11"><p>Properties</p><div><p><strong>image</strong> <code>string</code></p><p>The URL of the generated image in PNG format. <strong>The link is valid for 24 hours</strong>. Please download and save the image promptly.</p></div></section></div></section></div></section></div></section><p><strong>usage</strong> <code>object</code></p><p>The resource usage of this call. Only returned on success. These are <strong>image input and output metering fields, not token usage</strong>.</p><section class="collapse expanded" id="accordion-properties-12"><p>Properties</p><div><section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-5" class="tabbed-content-box section"><section id="qwen-image-3-0-series-2" class="section"><h4 id="qwen-image-3-0-series-2-h4">qwen-image-3.0 series</h4><p><strong>output_width</strong> <code>integer</code></p><p>The width of the final output image in pixels.</p><p><strong>output_height</strong> <code>integer</code></p><p>The height of the final output image in pixels.</p><p><strong>input_image_count</strong> <code>integer</code></p><p>The number of input images in the request. Returns 0 for text-to-image (T2I), and the actual count for image-to-image (I2I).</p><p><strong>input_image_type</strong> <code>string</code></p><p>The input image billing tier. Determined by the output resolution pixel area: <code>qima_input_1k</code> if area ≤ 2,250,000, or <code>qima_input_2k</code> if area &gt; 2,250,000.</p><p><strong>output_image_count</strong> <code>integer</code></p><p>The actual number of output images returned.</p><p><strong>output_image_type</strong> <code>string</code></p><p>The output image billing tier. Determined by the output resolution pixel area: <code>qima_output_1k</code> if area ≤ 2,250,000, or <code>qima_output_2k</code> if area &gt; 2,250,000.</p></section><section id="qwen-image-2-1-series-2" class="section"><h4 id="qwen-image-2-1-series-2-h4">qwen-image-2.1 series</h4><p><strong>image_count</strong> <code>integer</code></p><p>The number of images generated by the model.</p><p><strong>width</strong> <code>integer</code></p><p>The width of the generated image in pixels.</p><p><strong>height</strong> <code>integer</code></p><p>The height of the generated image in pixels.</p></section></section></div></section><p><strong>request_id</strong> <code>string</code></p><p>Unique request identifier for tracing and troubleshooting.</p><p><strong>code</strong> <code>string</code></p><p>Error code. Returned only for failed requests. See <a href="/help/en/model-studio/error-code">Error codes</a>.</p><p><strong>message</strong> <code>string</code></p><p>Detailed error message. Returned only for failed requests. See <a href="/help/en/model-studio/error-code">Error codes</a>.</p></td><td><section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-6" class="tabbed-content-box section"><section id="success-2" class="section"><h4 id="success-2-h4">Success</h4><p>Task data (task status and image URLs) is retained for only 24 hours and then automatically purged. Save generated images promptly.</p><div outputclass="tabbed-codeblock" data-tag="fig" id="fig-code-group-5" class="tabbed-codeblock-box"><div class="tab-box"></div><input id="fig-code-group-5-qwen-image-3-0-series-tab" type="radio" name="check-fig-code-group-5" checked=""/><label for="fig-code-group-5-qwen-image-3-0-series-tab">qwen-image-3.0 series</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-5-qwen-image-3-0-series" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
401
+ &quot;output&quot;: {
402
+ &quot;choices&quot;: [
403
+ {
404
+ &quot;finish_reason&quot;: &quot;stop&quot;,
405
+ &quot;message&quot;: {
406
+ &quot;content&quot;: [
407
+ {
408
+ &quot;image&quot;: &quot;https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx&quot;
409
+ }
410
+ ],
411
+ &quot;role&quot;: &quot;assistant&quot;
412
+ }
413
+ }
414
+ ]
415
+ },
416
+ &quot;usage&quot;: {
417
+ &quot;output_height&quot;: 1024,
418
+ &quot;output_width&quot;: 1024,
419
+ &quot;input_image_count&quot;: 1,
420
+ &quot;input_image_type&quot;: &quot;qima_input_1k&quot;,
421
+ &quot;output_image_count&quot;: 1,
422
+ &quot;output_image_type&quot;: &quot;qima_output_1k&quot;
423
+ },
424
+ &quot;request_id&quot;: &quot;571ae02f-5c9d-436c-83c2-f221e6df0xxx&quot;
425
+ }
426
+ </code></pre></div><input id="fig-code-group-5-qwen-image-2-1-series-tab" type="radio" name="check-fig-code-group-5"/><label for="fig-code-group-5-qwen-image-2-1-series-tab">qwen-image-2.1 series</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-5-qwen-image-2-1-series" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
427
+ &quot;output&quot;: {
428
+ &quot;choices&quot;: [
429
+ {
430
+ &quot;finish_reason&quot;: &quot;stop&quot;,
431
+ &quot;message&quot;: {
432
+ &quot;content&quot;: [
433
+ {
434
+ &quot;image&quot;: &quot;https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx&quot;
435
+ }
436
+ ],
437
+ &quot;role&quot;: &quot;assistant&quot;
438
+ }
439
+ }
440
+ ]
441
+ },
442
+ &quot;usage&quot;: {
443
+ &quot;image_count&quot;: 1,
444
+ &quot;width&quot;: 1024,
445
+ &quot;height&quot;: 1024
446
+ },
447
+ &quot;request_id&quot;: &quot;571ae02f-5c9d-436c-83c2-f221e6df0xxx&quot;
448
+ }
449
+ </code></pre></div></div></section><section id="error-2" class="section"><h4 id="error-2-h4">Error</h4><p>If the task fails, the response includes the error code and message. See <a href="/help/en/model-studio/error-code">Error codes</a> for troubleshooting.</p><pre data-tag="codeblock" id="code-block-3" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
450
+ &quot;request_id&quot;: &quot;31f808fd-8eef-9004-xxxxx&quot;,
451
+ &quot;code&quot;: &quot;InvalidApiKey&quot;,
452
+ &quot;message&quot;: &quot;Invalid API-key provided.&quot;
453
+ }
454
+ </code></pre></section></section></td></tr></tbody></table>
455
+ <h3 id="sdk-2">SDK <span id="en-6740266-sdk-title"></span> <span id="en-6740266-sdk"></span></h3>
456
+ <p>The following examples demonstrate how to call the API using Python and Java SDKs for image-to-image / image editing (I2I).</p>
457
+ <div outputclass="tabbed-codeblock" data-tag="fig" id="fig-code-group-6" class="tabbed-codeblock-box"><div class="tab-box"></div><input id="fig-code-group-6-python-tab" type="radio" name="check-fig-code-group-6" checked=""/><label for="fig-code-group-6-python-tab">Python</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-6-python" outputclass="language-python" code-type="xCode" class="pre codeblock language-python"><code>import os
458
+ import base64
459
+ import mimetypes
460
+ import dashscope
461
+ from dashscope import MultiModalConversation
462
+
463
+ dashscope.base_http_api_url = &#x27;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1&#x27;
464
+
465
+ def encode_file(file_path):
466
+ mime_type, _ = mimetypes.guess_type(file_path)
467
+ if not mime_type or not mime_type.startswith(&quot;image/&quot;):
468
+ raise ValueError(&quot;Unsupported or unrecognized image format&quot;)
469
+ with open(file_path, &quot;rb&quot;) as image_file:
470
+ encoded_string = base64.b64encode(image_file.read()).decode(&#x27;utf-8&#x27;)
471
+ return f&quot;data:{mime_type};base64,{encoded_string}&quot;
472
+
473
+ # [Method 1] Use a public image URL
474
+ image_url = &quot;https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png&quot;
475
+
476
+ # [Method 2] Use a Base64-encoded image
477
+ # image_url = encode_file(&quot;./your_image.png&quot;)
478
+
479
+ response = MultiModalConversation.call(
480
+ api_key=os.getenv(&quot;DASHSCOPE_API_KEY&quot;),
481
+ model=&quot;qwen-image-3.0-pro&quot;,
482
+ messages=[{
483
+ &quot;role&quot;: &quot;user&quot;,
484
+ &quot;content&quot;: [
485
+ {&quot;image&quot;: image_url},
486
+ {&quot;text&quot;: &quot;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.&quot;}
487
+ ]
488
+ }],
489
+ prompt_extend=True
490
+ )
491
+
492
+ print(response)
493
+ if response.status_code == 200:
494
+ url = response.output.choices[0].message.content[0][&quot;image&quot;]
495
+ print(f&quot;Generated image URL: {url}&quot;)
496
+ else:
497
+ print(f&quot;Error: {response.code} - {response.message}&quot;)
498
+ </code></pre></div><input id="fig-code-group-6-java-tab" type="radio" name="check-fig-code-group-6"/><label for="fig-code-group-6-java-tab">Java</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-6-java" outputclass="language-java" code-type="xCode" class="pre codeblock language-java"><code>import java.util.Arrays;
499
+ import java.util.Base64;
500
+ import java.util.Collections;
501
+ import java.io.IOException;
502
+ import java.nio.file.Files;
503
+ import java.nio.file.Path;
504
+ import java.nio.file.Paths;
505
+ import com.alibaba.dashscope.aigc.multimodalconversation.MultiModalConversation;
506
+ import com.alibaba.dashscope.aigc.multimodalconversation.MultiModalConversationParam;
507
+ import com.alibaba.dashscope.aigc.multimodalconversation.MultiModalConversationResult;
508
+ import com.alibaba.dashscope.common.MultiModalMessage;
509
+ import com.alibaba.dashscope.common.Role;
510
+ import com.alibaba.dashscope.utils.Constants;
511
+
512
+ public class ImageEditExample {
513
+ public static void main(String[] args) {
514
+ Constants.baseHttpApiUrl = &quot;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1&quot;;
515
+
516
+ // [Method 1] Use a public image URL
517
+ String imageUrl = &quot;https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png&quot;;
518
+
519
+ // [Method 2] Use a Base64-encoded image
520
+ // String imageUrl = encodeFile(&quot;/path/to/your/image.png&quot;);
521
+
522
+ MultiModalConversation conv = new MultiModalConversation();
523
+ MultiModalMessage userMessage = MultiModalMessage.builder()
524
+ .role(Role.USER.getValue())
525
+ .content(Arrays.asList(
526
+ Collections.singletonMap(&quot;image&quot;, imageUrl),
527
+ Collections.singletonMap(&quot;text&quot;, &quot;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.&quot;)
528
+ ))
529
+ .build();
530
+ MultiModalConversationParam param = MultiModalConversationParam.builder()
531
+ .apiKey(System.getenv(&quot;DASHSCOPE_API_KEY&quot;))
532
+ .model(&quot;qwen-image-3.0-pro&quot;)
533
+ .messages(Arrays.asList(userMessage))
534
+ .parameter(&quot;prompt_extend&quot;, true)
535
+ .build();
536
+ try {
537
+ MultiModalConversationResult result = conv.call(param);
538
+ System.out.println(result);
539
+ } catch (Exception e) {
540
+ e.printStackTrace();
541
+ }
542
+ }
543
+
544
+ public static String encodeFile(String filePath) {
545
+ Path path = Paths.get(filePath);
546
+ if (!Files.exists(path)) {
547
+ throw new IllegalArgumentException(&quot;File does not exist: &quot; + filePath);
548
+ }
549
+ String mimeType = null;
550
+ try {
551
+ mimeType = Files.probeContentType(path);
552
+ } catch (IOException e) {
553
+ throw new IllegalArgumentException(&quot;Cannot detect file type: &quot; + filePath);
554
+ }
555
+ if (mimeType == null || !mimeType.startsWith(&quot;image/&quot;)) {
556
+ throw new IllegalArgumentException(&quot;Unsupported or unrecognized image format&quot;);
557
+ }
558
+ byte[] fileBytes = null;
559
+ try {
560
+ fileBytes = Files.readAllBytes(path);
561
+ } catch (IOException e) {
562
+ throw new IllegalArgumentException(&quot;Cannot read file content: &quot; + filePath);
563
+ }
564
+ String encodedString = Base64.getEncoder().encodeToString(fileBytes);
565
+ return &quot;data:&quot; + mimeType + &quot;;base64,&quot; + encodedString;
566
+ }
567
+ }
568
+ </code></pre></div></div>
569
+ <h2 id="dashscope-asynchronous-api">DashScope asynchronous API <span id="en-6740266-async-title"></span> <span id="en-6740266-async"></span></h2>
570
+ <p>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 <code>X-DashScope-Async: enable</code> header. After the service accepts the request, it returns a task ID (<code>task_id</code>), which you then use to poll the query API for the final result.</p>
571
+ <div class="note note-important"><div class="note-icon-wrapper"></div><div class="note-content"><p><strong>Important</strong>The endpoint for the asynchronous API differs from the synchronous API. Use the endpoints in this section instead of the synchronous endpoint.</p></div></div>
572
+ <h3 id="http-2">HTTP <span id="en-6740266-async-http-title"></span> <span id="en-6740266-async-http"></span></h3>
573
+ <p>Asynchronous calls use a two-step workflow:</p>
574
+ <ol>
575
+ <li><strong>Create a task to get a task ID</strong>: Send a request to create a task. The response contains a <strong>task ID (task_id)</strong>.</li>
576
+ <li><strong>Poll for results using the task ID</strong>: Use the task_id to poll the task status until the task completes and the image URL is returned.</li>
577
+ </ol>
578
+ <h4 id="step-1-create-a-task-to-get-a-task-id">Step 1: Create a task to get a task ID <span id="en-6740266-async-step1-title"></span> <span id="en-6740266-async-step1"></span></h4>
579
+ <section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-7" class="tabbed-content-box section"><section id="singapore-3" class="section"><h4 id="singapore-3-h4">Singapore</h4><p><code>POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation</code></p></section><section id="us-virginia-3" class="section"><h4 id="us-virginia-3-h4">US (Virginia)</h4><p><code>POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation</code></p></section><section id="china-beijing-3" class="section"><h4 id="china-beijing-3-h4">China (Beijing)</h4><p><code>POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation</code></p></section><section id="china-hong-kong-3" class="section"><h4 id="china-hong-kong-3-h4">China (Hong Kong)</h4><p><code>POST https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation</code></p></section><section id="germany-frankfurt-3" class="section"><h4 id="germany-frankfurt-3-h4">Germany (Frankfurt)</h4><p><code>POST https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation</code></p></section><section id="japan-tokyo-3" class="section"><h4 id="japan-tokyo-3-h4">Japan (Tokyo)</h4><p><code>POST https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation</code></p></section></section>
580
+ <table bordertype="no-border" style="display:table;table-layout:fixed;width:100%"><colgroup><col style="width:50%"/><col style="width:50%"/></colgroup><tbody><tr><td><h5>Request parameters <span id="en-6740266-async-req-params-h5"></span></h5><h6>Headers <span id="en-6740266-async-headers-h6"></span></h6><p><strong>Content-Type</strong> <code>string</code> <strong>(Required)</strong></p><p>The content type of the request. Must be <code>application/json</code>.</p><p><strong>Authorization</strong> <code>string</code> <strong>(Required)</strong></p><p>Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.</p><p><strong>X-DashScope-Async</strong> <code>string</code> <strong>(Required)</strong></p><p>Enables asynchronous processing. Must be <code>enable</code>. The endpoint in this section accepts asynchronous requests only and does not support synchronous calls.</p><div class="note note-important"><div class="note-icon-wrapper"></div><div class="note-content"><p><strong>Important</strong>If this request header is missing, the error &quot;current user api does not support synchronous calls&quot; is returned.</p></div></div><h6>Request body <span id="en-6740266-async-body-h6"></span></h6><p><strong>model</strong> <code>string</code> <strong>(Required)</strong></p><p>The model name. Available values: <code>qwen-image-3.0-pro</code>, <code>qwen-image-3.0</code>, <code>qwen-image-2.1-pro</code>, and <code>qwen-image-2.1-turbo</code>.</p><p><strong>input</strong> <code>object</code> <strong>(Required)</strong></p><p>The input parameter object, which contains the following fields:</p><section class="collapse expanded" id="accordion-properties-13"><p>Properties</p><div><p><strong>messages</strong> <code>array</code> <strong>(Required)</strong></p><p>The request content array. <strong>Only single-round conversations are supported</strong>, so the array must contain <strong>exactly one object</strong> with <code>role</code> and <code>content</code> properties.</p><section class="collapse expanded" id="accordion-properties-14"><p>Properties</p><div><p><strong>role</strong><code>string</code> <strong>(Required)</strong></p><p>The role of the message sender. Must be set to <code>user</code>.</p><p><strong>content</strong><code>array</code> <strong>(Required)</strong></p><p>The message content array, with different combinations depending on the use case:</p><ul>
581
+ <li><strong>Text-to-image (T2I)</strong>: Contains only one <code>{&quot;text&quot;: &quot;...&quot;}</code> object.</li>
582
+ <li><strong>Image-to-image (I2I)</strong>: the qwen-image-2.1 series contains 1-10 <code>{&quot;image&quot;: &quot;...&quot;}</code> objects, the qwen-image-3.0 series contains 1-3, and 1 <code>{&quot;text&quot;: &quot;...&quot;}</code> object.</li>
583
+ </ul><section class="collapse expanded" id="accordion-properties-15"><p>Properties</p><div><p><strong>image</strong> <code>string</code> <strong>(Required for I2I)</strong></p><p>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.</p><strong>Image requirements:</strong><ul>
584
+ <li>Image format: JPG, JPEG, PNG, BMP, TIFF, WEBP, and GIF.</li>
585
+ <li>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.</li>
586
+ <li>Aspect ratio: The ratio of the longer side to the shorter side must not exceed 10:1.</li>
587
+ <li>Image size: Up to 10 MB.</li>
588
+ </ul><strong>Supported input formats</strong><ol>
589
+ <li>Public URL: HTTP and HTTPS protocols are supported.</li>
590
+ <li>Base64 encoding: Format is <code>data:{MIME_type};base64,{base64_data}</code>.</li>
591
+ </ol><p><strong>text</strong><code>string</code><strong>(Required)</strong></p><p>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.</p><p><strong>Note</strong>: Only one text object is allowed. Omitting it or providing multiple text objects will result in an error.</p></div></section></div></section></div></section><p><strong>parameters</strong> <code>object</code> (Optional)</p><p>Additional parameters to control image generation.</p><section class="collapse expanded" id="accordion-properties-16"><p>Properties</p><div><p><strong>prompt_extend</strong> <code>boolean</code> (Optional)</p><p>Whether to enable intelligent prompt rewriting. Default: <code>true</code> (recommended). When enabled, the model optimizes the positive prompt using the method specified by <code>prompt_extend_mode</code>, which significantly improves results for simple descriptions.</p><p><strong>prompt_extend_mode</strong> <code>string</code> (Optional)</p><p>The prompt rewriting method. Default: <code>direct</code>. Options:</p><ul>
592
+ <li><code>direct</code>: Direct Prompt Enhancement (DPE), suitable for most scenarios. Supported for both T2I and I2I.</li>
593
+ <li><code>agent</code>: Agent Prompt Enhancement (APE), provides more refined rewriting. Only supports text-to-image (T2I). Passing <code>agent</code> for image-to-image (I2I) will return a 400 error.</li>
594
+ </ul><p><strong>enable_thinking</strong> <code>boolean</code> (Optional)</p><p>Enables thinking mode. The default is <code>true</code>. This enhances model reasoning to improve image quality, but increases generation time. It requires <code>prompt_extend=true</code>. Supported for Direct T2I, Direct I2I, and Agent T2I. Not supported for I2I Agent.</p><p><strong>n</strong> <code>integer</code> (Optional)</p><p>The number of output images. Value range: 1 to 6. Default: 1.</p><p><strong>size</strong> <code>string</code> (Optional)</p><p>The output image resolution in the format <code>width*height</code>, for example <code>&quot;1024*1024&quot;</code>. If not specified, the model automatically recommends a resolution based on the prompt.</p><ul>
595
+ <li><strong>Text-to-image (T2I)</strong>: Pixel area from 512*512 to 2048*2048. Aspect ratio: 1:8 to 8:1.</li>
596
+ <li><strong>Image-to-image (I2I)</strong>: Pixel area from 512*512 to 2048*2048. Aspect ratio: 1:8 to 8:1.</li>
597
+ </ul><p><strong>negative_prompt</strong> <code>string</code> (Optional)</p><p>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.</p><p><strong>seed</strong> <code>integer</code> (Optional)</p><p>The random seed. Value range: <code>[0, 2147483647]</code>. If omitted, the service generates a random seed. Use a fixed seed for reproducible results.</p><p><strong>watermark</strong> <code>boolean</code> (Optional)</p><p>Whether to add a watermark. Default: <code>false</code>.</p></div></section></td><td><div outputclass="tabbed-codeblock" data-tag="fig" id="fig-code-group-7" class="tabbed-codeblock-box"><div class="tab-box"></div><input id="fig-code-group-7-text-to-image-tab" type="radio" name="check-fig-code-group-7" checked=""/><label for="fig-code-group-7-text-to-image-tab">Text-to-image</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-7-text-to-image" outputclass="language-bash" code-type="xCode" class="pre codeblock language-bash"><code>curl --location &#x27;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation&#x27; \
598
+ --header &#x27;Content-Type: application/json&#x27; \
599
+ --header &quot;Authorization: Bearer $DASHSCOPE_API_KEY&quot; \
600
+ --header &#x27;X-DashScope-Async: enable&#x27; \
601
+ --data &#x27;{
602
+ &quot;model&quot;: &quot;qwen-image-3.0-pro&quot;,
603
+ &quot;input&quot;: {
604
+ &quot;messages&quot;: [
605
+ {
606
+ &quot;role&quot;: &quot;user&quot;,
607
+ &quot;content&quot;: [
608
+ {
609
+ &quot;text&quot;: &quot;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 &#x27;\&#x27;&#x27;Il Messaggero&#x27;\&#x27;&#x27; 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&#x27;\&#x27;&#x27;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.&quot;
610
+ }
611
+ ]
612
+ }
613
+ ]
614
+ },
615
+ &quot;parameters&quot;: {
616
+ &quot;prompt_extend&quot;: true
617
+ }
618
+ }&#x27;
619
+ </code></pre></div><input id="fig-code-group-7-image-to-image-tab" type="radio" name="check-fig-code-group-7"/><label for="fig-code-group-7-image-to-image-tab">Image-to-image</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-7-image-to-image" outputclass="language-bash" code-type="xCode" class="pre codeblock language-bash"><code>curl --location &#x27;https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/image-generation/generation&#x27; \
620
+ --header &#x27;Content-Type: application/json&#x27; \
621
+ --header &quot;Authorization: Bearer $DASHSCOPE_API_KEY&quot; \
622
+ --header &#x27;X-DashScope-Async: enable&#x27; \
623
+ --data &#x27;{
624
+ &quot;model&quot;: &quot;qwen-image-3.0-pro&quot;,
625
+ &quot;input&quot;: {
626
+ &quot;messages&quot;: [
627
+ {
628
+ &quot;role&quot;: &quot;user&quot;,
629
+ &quot;content&quot;: [
630
+ {
631
+ &quot;image&quot;: &quot;https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/yBRq1ZPYEaXdyOdv/img/33a80a19-7ac7-4c64-b0fa-7d685b7046a0.png&quot;
632
+ },
633
+ {
634
+ &quot;text&quot;: &quot;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.&quot;
635
+ }
636
+ ]
637
+ }
638
+ ]
639
+ },
640
+ &quot;parameters&quot;: {
641
+ &quot;prompt_extend&quot;: true
642
+ }
643
+ }&#x27;
644
+ </code></pre></div></div></td></tr></tbody></table>
645
+ <table bordertype="no-border" style="display:table;table-layout:fixed;width:100%"><colgroup><col style="width:50%"/><col style="width:50%"/></colgroup><tbody><tr><td><h5>Response parameters <span id="en-6740266-async-resp1-h5"></span> <span id="en-6740266-async-resp1-section"></span></h5><p><strong>output</strong> <code>object</code></p><p>The task acceptance information.</p><section class="collapse expanded" id="accordion-properties-17"><p>Properties</p><div><p><strong>task_id</strong> <code>string</code></p><p>The asynchronous task ID, used to query the task status and result. Make sure to save it.</p><p><strong>task_status</strong> <code>string</code></p><p>The task status. Usually <code>PENDING</code> when the task is submitted, indicating only that the task has been accepted, not that the image has been generated.</p></div></section><p><strong>request_id</strong> <code>string</code></p><p>Unique request identifier for tracing and troubleshooting.</p><p><strong>code</strong> <code>string</code></p><p>Error code. Returned only for failed requests. See <a href="/help/en/model-studio/error-code">Error codes</a>.</p></td><td><section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-8" class="tabbed-content-box section"><section id="successful-response" class="section"><h4 id="successful-response-h4">Successful response</h4><p>Save the <code>task_id</code> to query the task status and result.</p><pre data-tag="codeblock" id="code-block-4" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
646
+ &quot;output&quot;: {
647
+ &quot;task_status&quot;: &quot;PENDING&quot;,
648
+ &quot;task_id&quot;: &quot;0385dc79-5ff8-4d82-bcb6-xxxxxx&quot;
649
+ },
650
+ &quot;request_id&quot;: &quot;4909100c-7b5a-9f92-bfe5-xxxxxx&quot;
651
+ }
652
+ </code></pre></section><section id="error-response" class="section"><h4 id="error-response-h4">Error response</h4><p>Task creation failed. See <a href="/help/en/model-studio/error-code">Error codes</a>.</p><pre data-tag="codeblock" id="code-block-5" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
653
+ &quot;code&quot;: &quot;InvalidApiKey&quot;,
654
+ &quot;message&quot;: &quot;Invalid API-key provided.&quot;,
655
+ &quot;request_id&quot;: &quot;7438d53d-6eb8-4596-8835-xxxxxx&quot;
656
+ }
657
+ </code></pre></section></section></td></tr></tbody></table>
658
+ <h4 id="step-2-poll-for-results-using-the-task-id">Step 2: Poll for results using the task ID <span id="en-6740266-async-step2-title"></span> <span id="en-6740266-async-step2"></span></h4>
659
+ <section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-9" class="tabbed-content-box section"><section id="singapore-4" class="section"><h4 id="singapore-4-h4">Singapore</h4><p><code>GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id}</code></p></section><section id="us-virginia-4" class="section"><h4 id="us-virginia-4-h4">US (Virginia)</h4><p><code>GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v1/tasks/{task_id}</code></p></section><section id="china-beijing-4" class="section"><h4 id="china-beijing-4-h4">China (Beijing)</h4><p><code>GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/tasks/{task_id}</code></p></section><section id="china-hong-kong-4" class="section"><h4 id="china-hong-kong-4-h4">China (Hong Kong)</h4><p><code>GET https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/api/v1/tasks/{task_id}</code></p></section><section id="germany-frankfurt-4" class="section"><h4 id="germany-frankfurt-4-h4">Germany (Frankfurt)</h4><p><code>GET https://{WorkspaceId}.eu-central-1.maas.aliyuncs.com/api/v1/tasks/{task_id}</code></p></section><section id="japan-tokyo-4" class="section"><h4 id="japan-tokyo-4-h4">Japan (Tokyo)</h4><p><code>GET https://{WorkspaceId}.ap-northeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id}</code></p></section></section>
660
+ <p>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.</p>
661
+ <table bordertype="no-border" style="display:table;table-layout:fixed;width:100%"><colgroup><col style="width:50%"/><col style="width:50%"/></colgroup><tbody><tr><td><h5>Request parameters <span id="en-6740266-async-step2-req-h5"></span></h5><h6>Headers <span id="en-6740266-async-step2-headers-h6"></span></h6><p><strong>Authorization</strong> <code>string</code> <strong>(Required)</strong></p><p>Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.</p><h6>URL path parameters <span id="en-6740266-async-step2-path-h6"></span></h6><p><strong>task_id</strong> <code>string</code> <strong>(Required)</strong></p><p>The ID of the task.</p></td><td><section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-10" class="tabbed-content-box section"><section id="query-task-result" class="section"><h4 id="query-task-result-h4">Query task result</h4><p>Replace <code>{task_id}</code> with the <code>task_id</code> value returned by the previous API call. The <code>task_id</code> is valid for queries for 24 hours, Replace <code>{WorkspaceId}</code> with your actual <a href="/help/en/model-studio/regions#h2_migrate_domain">workspace ID</a>.</p><pre data-tag="codeblock" id="code-block-6" outputclass="language-bash" code-type="xCode" class="pre codeblock language-bash"><code>curl -X GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id} \
662
+ --header &quot;Authorization: Bearer $DASHSCOPE_API_KEY&quot;
663
+ </code></pre></section></section></td></tr></tbody></table>
664
+ <table bordertype="no-border" style="display:table;table-layout:fixed;width:100%"><colgroup><col style="width:50%"/><col style="width:50%"/></colgroup><tbody><tr><td><h5>Response parameters <span id="en-6740266-async-resp2-h5"></span> <span id="en-6740266-async-resp2-section"></span></h5><p><strong>output</strong> <code>object</code></p><p>The task output information.</p><section class="collapse expanded" id="accordion-properties-18"><p>Properties</p><div><p><strong>task_id</strong> <code>string</code></p><p>The task ID. Valid for queries for 24 hours.</p><p><strong>task_status</strong> <code>string</code></p><p>The status of the task.</p><section class="collapse expanded" id="accordion-enumeration-values"><p>Enumeration values</p><div><ul>
665
+ <li>PENDING</li>
666
+ <li>RUNNING</li>
667
+ <li>SUCCEEDED</li>
668
+ <li>FAILED</li>
669
+ <li>CANCELED</li>
670
+ <li>UNKNOWN: The task does not exist or its status is unknown.</li>
671
+ </ul></div></section><strong>State transitions during polling:</strong><ul>
672
+ <li>PENDING → RUNNING → SUCCEEDED or FAILED.</li>
673
+ <li>The initial query status is usually PENDING or RUNNING.</li>
674
+ <li>When the status changes to SUCCEEDED, the response contains the generated image URL.</li>
675
+ <li>If the status is FAILED, check the error message and retry the task.</li>
676
+ </ul><p><strong>submit_time</strong> <code>string</code></p><p>The time when the task was submitted. The time is in UTC+8 and the format is YYYY-MM-DD HH:mm:ss.SSS.</p><p><strong>scheduled_time</strong> <code>string</code></p><p>The time when the task was executed. The time is in UTC+8 and the format is YYYY-MM-DD HH:mm:ss.SSS.</p><p><strong>end_time</strong> <code>string</code></p><p>The time when the task was completed. The time is in UTC+8 and the format is YYYY-MM-DD HH:mm:ss.SSS.</p><p><strong>rewrite_status</strong> <code>string</code></p><p>The prompt rewriting status. The value depends on whether rewriting was enabled in the request and the result of the rewrite.</p><p><strong>choices</strong> <code>array</code></p><p>The list of result options.</p><section class="collapse expanded" id="accordion-properties-19"><p>Properties</p><div><p><strong>finish_reason</strong> <code>string</code></p><p>The reason why the task stopped. The value is <code>stop</code> when the task completes normally.</p><p><strong>message</strong> <code>object</code></p><p>The message returned by the model.</p><section class="collapse expanded" id="accordion-properties-20"><p>Properties</p><div><p><strong>role</strong><code>string</code></p><p>The role of the message. Fixed as <code>assistant</code>.</p><p><strong>content</strong><code>array</code></p><p>The message content containing the generated image information.</p><section class="collapse expanded" id="accordion-properties-21"><p>Properties</p><div><p><strong>image</strong> <code>string</code></p><p>The URL of the generated image in PNG format. <strong>The link is valid for 24 hours</strong>. Please download and save the image promptly.</p></div></section></div></section></div></section></div></section><p><strong>usage</strong> <code>object</code></p><p>The resource usage of this call. Only returned on success. These are <strong>image input and output metering fields, not token usage</strong>.</p><section class="collapse expanded" id="accordion-properties-22"><p>Properties</p><div><section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-11" class="tabbed-content-box section"><section id="qwen-image-3-0-series-3" class="section"><h4 id="qwen-image-3-0-series-3-h4">qwen-image-3.0 series</h4><p><strong>output_width</strong> <code>integer</code></p><p>The width of the final output image in pixels.</p><p><strong>output_height</strong> <code>integer</code></p><p>The height of the final output image in pixels.</p><p><strong>input_image_count</strong> <code>integer</code></p><p>The number of input images in the request. Returns 0 for text-to-image (T2I), and the actual count for image-to-image (I2I).</p><p><strong>input_image_type</strong> <code>string</code></p><p>The input image billing tier. Determined by the output resolution pixel area: <code>qima_input_1k</code> if area ≤ 2,250,000, or <code>qima_input_2k</code> if area &gt; 2,250,000.</p><p><strong>output_image_count</strong> <code>integer</code></p><p>The actual number of output images returned.</p><p><strong>output_image_type</strong> <code>string</code></p><p>The output image billing tier. Determined by the output resolution pixel area: <code>qima_output_1k</code> if area ≤ 2,250,000, or <code>qima_output_2k</code> if area &gt; 2,250,000.</p></section><section id="qwen-image-2-1-series-3" class="section"><h4 id="qwen-image-2-1-series-3-h4">qwen-image-2.1 series</h4><p><strong>image_count</strong> <code>integer</code></p><p>The number of images generated by the model.</p><p><strong>width</strong> <code>integer</code></p><p>The width of the generated image in pixels.</p><p><strong>height</strong> <code>integer</code></p><p>The height of the generated image in pixels.</p></section></section></div></section><p><strong>request_id</strong> <code>string</code></p><p>Unique request identifier for tracing and troubleshooting.</p><p><strong>code</strong> <code>string</code></p><p>Error code. Returned only for failed requests. See <a href="/help/en/model-studio/error-code">Error codes</a>.</p><p><strong>message</strong> <code>string</code></p><p>Detailed error message. Returned only for failed requests. See <a href="/help/en/model-studio/error-code">Error codes</a>.</p></td><td><section data-tag="tabbed-content-box" outputclass="tabbed-content-box" id="sec-tabs-12" class="tabbed-content-box section"><section id="task-succeeded" class="section"><h4 id="task-succeeded-h4">Task succeeded</h4><p>Task data (task status and image URLs) is retained for only 24 hours and then automatically purged. Save generated images promptly.</p><div outputclass="tabbed-codeblock" data-tag="fig" id="fig-code-group-8" class="tabbed-codeblock-box"><div class="tab-box"></div><input id="fig-code-group-8-qwen-image-3-0-series-tab" type="radio" name="check-fig-code-group-8" checked=""/><label for="fig-code-group-8-qwen-image-3-0-series-tab">qwen-image-3.0 series</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-8-qwen-image-3-0-series" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
677
+ &quot;output&quot;: {
678
+ &quot;task_id&quot;: &quot;17d7d840-82b9-485b-a954-724d06bc88d2&quot;,
679
+ &quot;task_status&quot;: &quot;SUCCEEDED&quot;,
680
+ &quot;submit_time&quot;: &quot;2026-08-07 15:50:14.837&quot;,
681
+ &quot;scheduled_time&quot;: &quot;2026-08-07 15:50:14.884&quot;,
682
+ &quot;end_time&quot;: &quot;2026-08-07 15:50:33.607&quot;,
683
+ &quot;rewrite_status&quot;: &quot;not_use&quot;,
684
+ &quot;choices&quot;: [
685
+ {
686
+ &quot;finish_reason&quot;: &quot;stop&quot;,
687
+ &quot;message&quot;: {
688
+ &quot;role&quot;: &quot;assistant&quot;,
689
+ &quot;content&quot;: [
690
+ {
691
+ &quot;image&quot;: &quot;https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx&quot;,
692
+ &quot;type&quot;: &quot;image&quot;
693
+ }
694
+ ]
695
+ }
696
+ }
697
+ ]
698
+ },
699
+ &quot;usage&quot;: {
700
+ &quot;output_height&quot;: 1024,
701
+ &quot;output_width&quot;: 1024,
702
+ &quot;input_image_count&quot;: 0,
703
+ &quot;input_image_type&quot;: &quot;qima_input_1k&quot;,
704
+ &quot;output_image_count&quot;: 1,
705
+ &quot;output_image_type&quot;: &quot;qima_output_1k&quot;
706
+ },
707
+ &quot;request_id&quot;: &quot;2bd94002-5624-9129-916b-fbdde107b4ba&quot;
708
+ }
709
+ </code></pre></div><input id="fig-code-group-8-qwen-image-2-1-series-tab" type="radio" name="check-fig-code-group-8"/><label for="fig-code-group-8-qwen-image-2-1-series-tab">qwen-image-2.1 series</label><div class="codeblock-item"><pre data-tag="codeblock" id="code-code-group-8-qwen-image-2-1-series" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
710
+ &quot;output&quot;: {
711
+ &quot;task_id&quot;: &quot;17d7d840-82b9-485b-a954-724d06bc88d2&quot;,
712
+ &quot;task_status&quot;: &quot;SUCCEEDED&quot;,
713
+ &quot;submit_time&quot;: &quot;2026-08-07 15:50:14.837&quot;,
714
+ &quot;scheduled_time&quot;: &quot;2026-08-07 15:50:14.884&quot;,
715
+ &quot;end_time&quot;: &quot;2026-08-07 15:50:33.607&quot;,
716
+ &quot;rewrite_status&quot;: &quot;not_use&quot;,
717
+ &quot;choices&quot;: [
718
+ {
719
+ &quot;finish_reason&quot;: &quot;stop&quot;,
720
+ &quot;message&quot;: {
721
+ &quot;role&quot;: &quot;assistant&quot;,
722
+ &quot;content&quot;: [
723
+ {
724
+ &quot;image&quot;: &quot;https://dashscope-result-sz.oss-cn-shenzhen.aliyuncs.com/xxx.png?Expires=xxx&quot;,
725
+ &quot;type&quot;: &quot;image&quot;
726
+ }
727
+ ]
728
+ }
729
+ }
730
+ ]
731
+ },
732
+ &quot;usage&quot;: {
733
+ &quot;image_count&quot;: 1,
734
+ &quot;width&quot;: 1024,
735
+ &quot;height&quot;: 1024
736
+ },
737
+ &quot;request_id&quot;: &quot;2bd94002-5624-9129-916b-fbdde107b4ba&quot;
738
+ }
739
+ </code></pre></div></div></section><section id="task-failed" class="section"><h4 id="task-failed-h4">Task failed</h4><p>When a task fails, <code>task_status</code> is FAILED with an error code and message. See <a href="/help/en/model-studio/error-code">Error codes</a>.</p><pre data-tag="codeblock" id="code-block-7" outputclass="language-json" code-type="xCode" class="pre codeblock language-json"><code>{
740
+ &quot;output&quot;: {
741
+ &quot;task_id&quot;: &quot;17d7d840-82b9-485b-a954-724d06bc88d2&quot;,
742
+ &quot;task_status&quot;: &quot;FAILED&quot;,
743
+ &quot;code&quot;: &quot;InternalError&quot;,
744
+ &quot;message&quot;: &quot;An internal error has occurred.&quot;
745
+ },
746
+ &quot;request_id&quot;: &quot;31f808fd-8eef-9004-xxxxx&quot;
747
+ }
748
+ </code></pre></section></section></td></tr></tbody></table>
749
+ <h2 id="error-codes">Error codes <span id="OajFO"></span> <span id="en-6740266-error-codes-conref"></span></h2>
750
+ <p>If the model call fails and returns an error message, see <a href="/help/en/model-studio/error-code">Error codes</a> for resolution.</p></div>
751
+ </div>
752
+ </article>
753
+ <script type="text/javascript">
754
+ window.storeDocs = {
755
+ language: '$lang',
756
+ docGithubLink: '$!githubInfo.url'
757
+ }
758
+ </script>
759
+ <div class="nav-footer">
760
+ </div>
761
+ <div class="alicloud-document-ask clearfix"></div>
762
+ <div class="feedback-message" style="display:none;">
763
+ <span class="hasfeedback acon acon-done-16"></span>
764
+ Thank you! We've received your feedback.
765
+ </div>
766
+ </div>
767
+ <div class="col-log-2 col-md-2 col-sm-0 col-xs-0 nav-catalog">
768
+ <div class="article-catalog" id="articleCatalog"></div>
769
+ </div>
770
+ </div>
771
+ </section>
772
+ </div>
773
+ </div>
774
+ </div>
775
+ <script
776
+ crossorigin
777
+ src="https://g.alicdn.com/code/lib/??react/16.8.6/umd/react.production.min.js,react-dom/16.8.6/umd/react-dom.production.min.js"
778
+ ></script>
779
+ <script
780
+ src="https://g.alicdn.com/code/lib/lodash.js/4.17.21/lodash.min.js"
781
+ crossorigin="anonymous"
782
+ ></script>
783
+ <script src="//g.alicdn.com/aliyun-help/help-portal-fe/0.12.65/js/vendor.js"></script>
784
+ <script src="//g.alicdn.com/aliyun-help/help-portal-fe/0.12.65/js/index.js"></script>
785
+ <script defer src="https://cloud-assets.alicdn.com/alicdn/dawn/user-tracker/latest/js/index.js"></script>
786
+ </body>
787
+ </html>
pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_wan-image-edit ADDED
The diff for this file is too large to render. See raw diff
 
pipeline/provider_docs/alibaba__www.alibabacloud.com_help_en_model-studio_wan-image-generation-and-editing-api-reference ADDED
The diff for this file is too large to render. See raw diff
 
pipeline/provider_docs/bfl__api.bfl.ai_openapi.json ADDED
@@ -0,0 +1 @@
 
 
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."}]}
pipeline/provider_docs/bfl__docs.bfl.ml_flux_3_flux3_image_layout.md ADDED
@@ -0,0 +1,243 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ > ## Documentation Index
2
+ > Fetch the complete documentation index at: https://docs.bfl.ml/llms.txt
3
+ > Use this file to discover all available pages before exploring further.
4
+
5
+ # FLUX 3 Image Editing
6
+
7
+ > 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.
8
+
9
+ FLUX 3 Image
10
+
11
+ # FLUX 3 Image Editing
12
+
13
+ Edit an image with a written instruction, combine up to ten references, and add bounding boxes to place elements or target an edit.
14
+
15
+ ## Quickstart
16
+
17
+ Send an image in `images` and say what to change. This request recolors an owl
18
+ and keeps the rest of the photo as it was. Drag the handle to compare:
19
+
20
+ Previous clip
21
+
22
+ Next clip
23
+
24
+ Set `BFL_API_KEY` to a key from the [BFL dashboard](https://dashboard.bfl.ai), then submit:
25
+
26
+ ```python Python theme={null}
27
+ import os
28
+ import requests
29
+
30
+ response = requests.post(
31
+ "https://api.bfl.ai/v1/flux-3-image",
32
+ headers={"x-key": os.environ["BFL_API_KEY"]},
33
+ json={
34
+ "prompt": "In this image, change <owl_subject>, 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.",
35
+ "images": ["https://cdn.sanity.io/images/2gpum2i6/production/1731db585c799dbb4e2c48731ea0b5bfc92a47d7-1800x1193.webp"],
36
+ },
37
+ timeout=60,
38
+ )
39
+ response.raise_for_status()
40
+ print(response.json())
41
+ ```
42
+
43
+ ```bash cURL theme={null}
44
+ curl --fail-with-body https://api.bfl.ai/v1/flux-3-image \
45
+ -H "x-key: $BFL_API_KEY" \
46
+ -H "Content-Type: application/json" \
47
+ -d '{
48
+ "prompt": "In this image, change <owl_subject>, 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.",
49
+ "images": ["https://cdn.sanity.io/images/2gpum2i6/production/1731db585c799dbb4e2c48731ea0b5bfc92a47d7-1800x1193.webp"]
50
+ }'
51
+ ```
52
+
53
+ `aspect_ratio` defaults to `auto`, so the edit has the same aspect ratio as the
54
+ image you send. The output is `1k`. For the same size as the input image, up to 4MP,
55
+ set `resolution` to `match_input`. Poll the returned `polling_url` until `status` is `Ready`, then
56
+ download the image from `result.sample` within 1 hour.
57
+ [FLUX 3 Text to Image](https://docs.bfl.ml/flux_3/flux3_image_generate.md#quickstart) has complete
58
+ clients that submit, poll, and save.
59
+
60
+ ## Edit with an instruction
61
+
62
+ These examples call `generate()` from the
63
+ [complete clients](https://docs.bfl.ml/flux_3/flux3_image_generate.md#quickstart), which submits a
64
+ request, polls until it is ready, and saves the image.
65
+
66
+ Send the image in `images` and write the change as an instruction. Name the
67
+ element precisely enough that only one thing in the image matches. This
68
+ request changes the color of one bird in a flock:
69
+
70
+ Previous clip
71
+
72
+ Next clip
73
+
74
+ ```python theme={null}
75
+ generate({
76
+ "prompt": "change the color of only one bird in the middle to #e01075",
77
+ "images": ["https://cdn.sanity.io/images/2gpum2i6/production/4792198dfeba9223bf3ecf020fed2942de7f0bd7-1800x1200.webp"],
78
+ }, name="pink_bird")
79
+ ```
80
+
81
+ With `aspect_ratio` left at `auto`, the output keeps the aspect ratio of the
82
+ image you send.
83
+
84
+ You don't have to draw a box for a single edit. Before it generates, FLUX 3
85
+ Image expands your instruction into a detailed prompt, and for many edits it
86
+ also finds the element you named and adds a box for it. The expanded prompt,
87
+ including any boxes it added, comes back in `result.prompt`. To control exactly
88
+ which elements change, use [bounding boxes](https://docs.bfl.ml/flux_3/flux3_image_bounding_boxes.md#edit-an-image).
89
+
90
+ ## Multi reference
91
+
92
+ Refer to each image by its position or by what it shows. "Image 1" is the
93
+ first entry in `images`, "image 2" the second, and so on up to ten. Here,
94
+ image 1 is the scene and image 2 supplies the object to place in it:
95
+
96
+ replace the cartridge from image 1 with the van in image 2, adjust the lighting on the van to integrate well within image 1
97
+
98
+ ```python theme={null}
99
+ generate({
100
+ "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",
101
+ "images": [
102
+ "https://cdn.sanity.io/images/2gpum2i6/production/ec365238b6efa1b29f573e83b774c6d539408ea8-1800x1200.webp",
103
+ "https://cdn.sanity.io/images/2gpum2i6/production/ff3bf81b5a8b38f0d870561217b68a72964259ab-1131x1414.webp",
104
+ ],
105
+ }, name="turntable_van")
106
+ ```
107
+
108
+ With `aspect_ratio` at `auto`, the output uses the aspect ratio of the first
109
+ image in `images`. The turntable is first, so the result is landscape. For a
110
+ different shape, put a different image first or set `aspect_ratio`.
111
+
112
+ For product shots, try-ons, and group compositions, say how the images relate:
113
+ "the person from image 1 wears the jacket from image 2 and stands in the
114
+ kitchen from image 3".
115
+
116
+ ## Examples
117
+
118
+ Each example shows the inputs, the result, and the prompt that produced it.
119
+
120
+ ### Single Image Reference
121
+
122
+ Send one image and write the change as an instruction. Drag the handle to
123
+ compare:
124
+
125
+ Previous clip
126
+
127
+ Next clip
128
+
129
+ ### Multi Image Reference
130
+
131
+ Refer to each image by its position in `images`. The output keeps the
132
+ aspect ratio of image 1.
133
+
134
+ **Replace an object with a new design**
135
+
136
+ 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.
137
+
138
+ **Add elements from several images**
139
+
140
+ 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
141
+
142
+ **Furnish a room**
143
+
144
+ 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
145
+
146
+ ### Edit with Bboxes
147
+
148
+ Each edit changes one boxed element and anchors the rest. Select an
149
+ example, then switch between before and after.
150
+
151
+ ## Send a request
152
+
153
+ Copy a request body from the [bounding box examples](https://docs.bfl.ml/flux_3/flux3_image_bounding_boxes.md#examples)
154
+ and paste it where indicated below, including its outer braces. To adapt an edit to your image, update the image URL, element
155
+ descriptions, and source and target boxes.
156
+
157
+ ```python Python theme={null}
158
+ import json
159
+
160
+ body = r'''
161
+ Paste the complete copied JSON body here.
162
+ '''
163
+ generate(json.loads(body))
164
+ ```
165
+
166
+ ```bash cURL theme={null}
167
+ curl --fail-with-body https://api.bfl.ai/v1/flux-3-image \
168
+ -H "x-key: $BFL_API_KEY" \
169
+ -H "Content-Type: application/json" \
170
+ -d @- <<'EOF'
171
+ Paste the copied request body here.
172
+ EOF
173
+ ```
174
+
175
+ `generate()` is defined in the [complete clients](https://docs.bfl.ml/flux_3/flux3_image_generate.md#quickstart).
176
+ It submits the request, polls until the image is ready, and saves it. With
177
+ cURL, poll the returned `polling_url` until `status` is `Ready`, then download
178
+ `result.sample`.
179
+
180
+ > **Coordinate conversion and editing tips**
181
+ >
182
+ > Use the aspect ratio you designed the layout for, because the grid
183
+ > stretches with the frame. For edits, `auto`
184
+ > follows the first reference; without a reference, it produces a square.
185
+ >
186
+ > ```python theme={null}
187
+ > def to_bbox(left, top, right, bottom, width, height):
188
+ > return [round(top / height * 1000), round(left / width * 1000),
189
+ > round(bottom / height * 1000), round(right / width * 1000)]
190
+ >
191
+ > to_bbox(384, 108, 1536, 972, 1920, 1080) # [100, 200, 900, 800]
192
+ > ```
193
+ >
194
+ > To move or resize an element, use different source and target boxes.
195
+ > Use matching boxes to ask for it to stay in place. State additions and
196
+ > removals in the written instruction as well as the rows.
197
+ >
198
+ > Very small boxes can fail. In our tests, a new element in a box about
199
+ > 40 × 25 pixels often did not appear, so give new elements a larger box.
200
+ >
201
+ > Give text its own box and quote the words in `desc`.
202
+ > See [Layout prompts](https://docs.bfl.ml/guides/prompting_layout.md) for more examples.
203
+
204
+ > **Try drawing a box**
205
+ >
206
+ > Draw over a marked region, or choose one below the image, then select
207
+ > an object. This demo uses saved edits and makes no API requests.
208
+ >
209
+ > Place an object
210
+ >
211
+ > Draw over a marked region and choose an object to see a saved edit in that region.
212
+ >
213
+ > Pre-generated edits
214
+ >
215
+ > ![A storybook forest clearing](https://docs.bfl.ml/images/flux3/bbox/base.webp)
216
+ >
217
+ > Reset edits
218
+
219
+ > **Pixel-perfect edits**
220
+ >
221
+ > Pixels outside the boxes usually stay the same. Shadows, reflections,
222
+ > or nearby lighting may still change.
223
+ >
224
+ > Compare each input with its edit. Switch to Changed pixels to see which
225
+ > areas the edit touched.
226
+
227
+ ## Keep exploring
228
+
229
+ > **[FLUX 3 Text to Image](https://docs.bfl.ml/flux_3/flux3_image_generate.md)**
230
+ >
231
+ > Complete clients that submit, poll, and save, plus edits and
232
+ > multi-reference requests.
233
+
234
+ > **[API reference](https://docs.bfl.ml/api-reference/utility/generate-an-image-with-flux-3.md)**
235
+ >
236
+ > The full request schema, limits, and response codes.
237
+
238
+ > **[Layout prompts](https://docs.bfl.ml/guides/prompting_layout.md)**
239
+ >
240
+ > How to write the caption and element table for a layout.
241
+
242
+
243
+ This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.
pipeline/provider_docs/bytedance__docs.byteplus.com_en_docs_modelark_image-generation-api ADDED
The diff for this file is too large to render. See raw diff
 
pipeline/provider_docs/fetch_log.tsv ADDED
@@ -0,0 +1,17 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ 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
2
+ 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
3
+ google 200 1231239 302 https://web.archive.org/web/20261030161547/https://ai.google.dev/api/generate-content https://ai.google.dev/api/generate-content
4
+ 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
5
+ 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
6
+ bfl 200 88278 302 https://web.archive.org/web/20261030161805/https://api.bfl.ai/openapi.json https://api.bfl.ai/openapi.json
7
+ 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
8
+ 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
9
+ 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
10
+ xai 200 17560 429 https://docs.x.ai/developers/rest-api-reference/inference/images.md
11
+ xai 200 16607 429 https://docs.x.ai/developers/model-capabilities/images/generation.md
12
+ kling 200 76456 429 https://kling.ai/document-api/api/image/3-0-omni/image-omni
13
+ alibaba 200 134009 429 https://www.alibabacloud.com/help/en/model-studio/wan-image-generation-and-editing-api-reference
14
+ alibaba 200 137091 429 https://www.alibabacloud.com/help/en/model-studio/wan-image-edit
15
+ alibaba 200 98695 429 https://www.alibabacloud.com/help/en/model-studio/qwen-image-generation-and-editing-api-reference
16
+ luma 200 46699 429 https://docs.agents.lumalabs.ai/guides/faq/index.md
17
+ luma 200 21765 429 https://docs.agents.lumalabs.ai/api/resources/generations/methods/create/index.md
pipeline/provider_docs/google__ai.google.dev_api_generate-content ADDED
The diff for this file is too large to render. See raw diff
 
pipeline/provider_docs/google__ai.google.dev_gemini-api_docs_image-generation ADDED
The diff for this file is too large to render. See raw diff
 
pipeline/provider_docs/ideogram__api.ideogram.ai_openapi.json ADDED
The diff for this file is too large to render. See raw diff
 
pipeline/provider_docs/kling__kling.ai_document-api_api_image_3-0-omni_image-omni ADDED
@@ -0,0 +1,364 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html><html lang="en"><head><meta name="buildId" content="107808738"></meta>
2
+
3
+ <script>window.__CDN_DISPATCH__={"kling-web-sgp":["v15-kling.klingai.com","v17-kling.klingai.com"]}</script><script charset="UTF-8">window['kConf_ytech.klingWeb.kling-api-doc_i18n']={"feat/add-i18n-track-csr":{"cn":"https://p4-kling.klingai.com/kcdn/cdn-kcdn112452/i18n-platform-new/kling-api-doc.production.75c0aa83b34e1e28.json","sgp":"https://s15-kling.klingai.com/kos/s101/nlav112918/i18n-platform-new/kling-api-doc.production.f97114314d3565ba.json"},"master":{"cn":"https://p4-kling.klingai.com/kcdn/cdn-kcdn112452/i18n-platform-new/kling-api-doc.baseline.cn.e6a29bc4b9e250f5.json","sgp":"https://s15-kling.klingai.com/kos/s101/nlav112918/i18n-platform-new/kling-api-doc.baseline.sgp.a8f18da810acdfe8.json"},"test":{"cn":"https://p4-kling.klingai.com/kcdn/cdn-kcdn112452/i18n-platform-new/kling-api-doc.production.bfb6d49214521ae5.json","sgp":"https://s15-kling.klingai.com/kos/s101/nlav112918/i18n-platform-new/kling-api-doc.production.129048208df42422.json"},"tob-ui":{"cn":"https://p2-kling.klingai.com/kcdn/cdn-kcdn112452/i18n-platform-new/kling-api-doc.production.f8598c3562a3bf91.json","sgp":"https://s15-kling.klingai.com/kos/s101/nlav112918/i18n-platform-new/kling-api-doc.production.f2a7a2f0643e4653.json"}}</script><script>window.kfxEnv={"channelId":"","version":"32529059","appId":"963f8684d1"}</script><script>
4
+ (function() {
5
+ try{
6
+
7
+ var cookieMap = document.cookie.split(';').reduce(function(map, cookie) {
8
+ var trimmedCookie = cookie.trim();
9
+ var separatorIndex = trimmedCookie.indexOf('=');
10
+ if (separatorIndex > -1) {
11
+ map[trimmedCookie.slice(0, separatorIndex)] = trimmedCookie.slice(separatorIndex + 1);
12
+ }
13
+ return map;
14
+ }, {});
15
+
16
+ var generateDid = function() {
17
+ var timestamp = Date.now();
18
+ var random5Digits = Math.floor(Math.random() * 100000) + 100000;
19
+ var timeComponent = (random5Digits * 10000000000000 + timestamp).toString(36).slice(0, 12);
20
+ var randomComponent = Math.random().toString(36).substr(2, 12);
21
+ while (randomComponent.length < 12) {
22
+ randomComponent += Math.floor(Math.random() * 36).toString(36);
23
+ }
24
+ var deviceInfo = [ navigator.userAgent, navigator.language, navigator.platform, navigator.vendor, screen.width, screen.height, screen.colorDepth, screen.pixelDepth, window.devicePixelRatio ].join('')
25
+ var hashCode = (str) => {
26
+ str = str + Math.random().toString()
27
+ let hash = 0;
28
+ for (let i = 0; i < str.length; i++) {
29
+ var char = str.charCodeAt(i);
30
+ hash = ((hash << 5) - hash) + char;
31
+ hash = hash & hash;
32
+ }
33
+ let hashStr = Math.abs(hash).toString(36);
34
+ while (hashStr.length < 12) {
35
+ hashStr += Math.floor(Math.random() * 36).toString(36);
36
+ }
37
+ return hashStr;
38
+ };
39
+ var deviceInfoHash = hashCode(deviceInfo);
40
+ return 'web_' + timeComponent + randomComponent + deviceInfoHash;
41
+ };
42
+ var did = cookieMap.did || cookieMap._did || cookieMap.weblogger_did || generateDid();
43
+ var domain = '.' + window.location.hostname.split('.').slice(-2).join('.');
44
+ if (window.location.hostname === 'localhost' && false) {
45
+ domain = undefined;
46
+ }
47
+ console.log('did', did);
48
+ console.log('domain', domain);
49
+ document.cookie = 'did=' + did +
50
+ ';path=/' +
51
+ ';domain=' + domain +
52
+ ';max-age=2147483647' +
53
+ ';expires=Thu, 09 Jul 2093 10:04:46 GMT' +
54
+ ';secure' +
55
+ ';samesite=none';
56
+ } catch (e) {
57
+ console.error('injectCookieScript error', e)
58
+ }
59
+ })();
60
+ </script>
61
+ <meta charset="UTF-8">
62
+ <script>var __radarSeedFunc__=function(e){"use strict";var g=function(){return(g=Object.assign||function(e){for(var n,r=1,t=arguments.length;r<t;r++)for(var o in n=arguments[r])Object.prototype.hasOwnProperty.call(n,o)&&(e[o]=n[o]);return e}).apply(this,arguments)};function o(e,n){var r="function"==typeof Symbol&&e[Symbol.iterator];if(!r)return e;var t,o,i=r.call(e),a=[];try{for(;(void 0===n||0<n--)&&!(t=i.next()).done;)a.push(t.value)}catch(e){o={error:e}}finally{try{t&&!t.done&&(r=i.return)&&r.call(i)}finally{if(o)throw o.error}}return a}var n=console,r="ksurl.cn/csHfgepO, radar:",i=(n.log.bind(n,r),n.warn.bind(n,r),n.error.bind(n,r)),$={unknown:0,none:1,wifi:2,"4g":3,"3g":4,"2g":5,"5g":7,"slow-2g":5},a=window,t=a.location,c=a.navigator,u="__RADAR_PERFORMANCE_TIMING_",l="__radarSeedStore__",s="isCoreReady",f="isRuning",d="radarSessionId",v="resource",p="error",z="event",n="Queue",L=p+n,T=v+n,B=z+n,m="oInc",h="dimension",y="projectId",_="connection",x="immediate",k="commonData",F="customDimensions",J="config",b="queue";function q(e){return"function"==typeof e}function G(){for(var e=arguments,n=e[0],r=1;r<e.length;r++){var t=e[r];if(t)for(var o in t)n[o]=t[o]}return n}function w(e,n,r){return void 0===r&&(r={}),(Object.assign||G)({},e,n,r)}function S(e){return JSON.stringify(e)}function O(e,n,r,t){e.addEventListener(n,r,t)}function j(e,n,r,t){e.removeEventListener(n,r,t)}function H(e,n){a[e=void 0===e?u:e]=w(a[e]||{},n)}function K(){var e=Q(d,null,u);e||(e="xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,function(e){var n=16*Math.random()|0;return("x"===e?n:3&n|8).toString(16)}),U(d,e,u))}function Q(e,n,r){return a[r=void 0===r?u:r]&&void 0!==a[r][e]?a[r][e]:void 0===n?null:n}function U(e,n,r){a[r=void 0===r?u:r]||H(r,{}),a[r][e]=n}function A(e,n){return Q(e,n=void 0===n?null:n,l)}function W(e,n){U(e,n,l)}function V(e,n){try{a[l][e].push(n),(t=A("flush"))&&q(t)&&(r=A(b,[]),(A(x)||20<r.length)&&t())}catch(e){i("1000")}var r,t}var R="?",X=/\(error: (.*)\)/,Y=/captureMessage|captureException/;function E(e){return e[e.length-1]||{}}function Z(e,n,r,t){return e={filename:e,function:"<anonymous>"===n?R:n},void 0!==r&&(e.lineno=r),void 0!==t&&(e.colno=t),e}var ee=/^\s*at (\S+?)(?::(\d+))(?::(\d+))\s*$/i,ne=/^\s*at (?:(.+?\)(?: \[.+\])?|.*?) ?\((?:address at )?)?(?:async )?((?:<anonymous>|[-a-z]+:|.*bundle|\/)?.*?)(?::(\d+))?(?::(\d+))?\)?\s*$/i,re=/\((\S*)(?::(\d+))(?::(\d+))\)/,te=/^\s*(.*?)(?:\((.*?)\))?(?:^|@)?((?:[-a-z]+)?:\/.*?|\[native code\]|[^@]*(?:bundle|\d+\.js)|\/[\w\-. /=]+)(?::(\d+))?(?::(\d+))?\s*$/i,oe=/(\S+) line (\d+)(?: > eval line \d+)* > eval/i,ie=(!function(){for(var e=[],n=0;n<arguments.length;n++)e[n]=arguments[n];var p=e.sort(function(e,n){return e[0]-n[0]}).map(function(e){return e[1]});return function(e,n,r){void 0===n&&(n=0),void 0===r&&(r=0);for(var t,o=[],i=e.split("\n"),a=n;a<i.length;a++){var c=i[a];if(!(1024<c.length)){var u=X.test(c)?c.replace(X,"$1"):c;if(!u.match(/\S*Error: /)){try{for(var l=void 0,s=function(e){var n="function"==typeof Symbol&&Symbol.iterator,r=n&&e[n],t=0;if(r)return r.call(e);if(e&&"number"==typeof e.length)return{next:function(){return{value:(e=e&&t>=e.length?void 0:e)&&e[t++],done:!e}}};throw new TypeError(n?"Object is not iterable.":"Symbol.iterator is not defined.")}(p),f=s.next();!f.done;f=s.next()){var d=(0,f.value)(u);if(d){o.push(d);break}}}catch(e){l={error:e}}finally{try{f&&!f.done&&(t=s.return)&&t.call(s)}finally{if(l)throw l.error}}if(o.length>=50+r)break}}}n=o.slice(r);if(!n.length)return[];var v=Array.from(n);return/sentryWrapped/.test(E(v).function||"")&&v.pop(),v.reverse(),Y.test(E(v).function||"")&&(v.pop(),Y.test(E(v).function||"")&&v.pop()),v.slice(0,50).map(function(e){return g(g({},e),{filename:e.filename||E(v).filename,function:e.function||R})})}}.apply(void 0,function(e,n,r){if(r||2===arguments.length)for(var t,o=0,i=n.length;o<i;o++)!t&&o in n||((t=t||Array.prototype.slice.call(n,0,o))[o]=n[o]);return e.concat(t||Array.prototype.slice.call(n))}([],o([[30,function(e){var n=ee.exec(e);if(n)return r=(n=o(n,4))[1],t=n[2],n=n[3],Z(r,R,+t,+n);var r,t=ne.exec(e);return t?(t[2]&&0===t[2].indexOf("eval")&&(n=re.exec(t[2]))&&(t[2]=n[1],t[3]=n[2],t[4]=n[3]),n=(e=o(ie(t[1]||R,t[2]),2))[0],Z(r=e[1],n,t[3]?+t[3]:void 0,t[4]?+t[4]:void 0)):void 0}],[50,function(e){var n,r,t;if(e=te.exec(e))return e[3]&&-1<e[3].indexOf(" > eval")&&(t=oe.exec(e[3]))&&(e[1]=e[1]||"eval",e[3]=t[1],e[4]=t[2],e[5]=""),t=e[3],r=e[1]||R,r=(n=o(ie(r,t),2))[0],Z(t=n[1],r,e[4]?+e[4]:void 0,e[5]?+e[5]:void 0)}]]),!1)),function(e,n){var r=-1!==e.indexOf("safari-extension"),t=-1!==e.indexOf("safari-web-extension");return r||t?[-1!==e.indexOf("@")?e.split("@")[0]:R,(r?"safari-extension:":"safari-web-extension:").concat(n)]:[e,n]});var ae="unhandledrejection",I="beforeunload",ce="visibilitychange",ue={name:"RadarSeedCollect",version:"1.3.2"};function le(e,n){var r="getAttribute";return q(e[r])&&e[r](n)||""}function se(e){var n=e.target;return{failed:!0,file:(le(n,"src")||le(n,"href"))&&(n.src||n.href||"").toString(),res_path:(n=e&&e.path||e&&e.composedPath&&e.composedPath(),Array.isArray(n)?n.map(function(e){var n=le(e,"class")||e.className,r=e.tagName||"";return e.id&&(r+="#"+e.id),n&&(r+=n.split(/\s+/g).map(function(e){return"."+e}).join("")),r}).filter(function(e){return e}).join(","):"")}}function fe(e){try{var n=e.reason,r=e.error||(n&&n.message?n:void 0),t=function(e){var n="";try{n=e.toString(),e&&"object"==typeof e&&(n=JSON.stringify(e))}catch(e){}return n}(r&&r.message||e.message||e.reason);return{error_type:"script",error_cons_type:r&&r.name||e.name,msg:t,stack:e.stack||r&&r.stack,file:e.filename,line:e.lineno,col:e.colno}}catch(e){return{}}}var de=c.userAgent,r=a.screen,ve={domain:t.hostname,url:t.href,hash:t.hash,online:c.onLine,downlink:c[_]&&c[_].downlink,rtt:c[_]&&c[_].rtt,screen_width:r.width,screen_height:r.height,device_pixel_ratio:a.devicePixelRatio||1};function pe(){var e={page:t.href},n=Q(d),r=A(y);return{h5_extra_attr:S(ve),refer_url_package:e,url_package:e,project_id:r,radar_session_id:n}}function ge(){var e=A(J,{})[F]||{};return w({event_client_timestamp:Date.now(),collect_version:ue.version,collect_name:ue.name},e)}function me(e,n){void 0===n&&(n=1);var r,t=e.data,o=e.key,e=e.dimension||{},i={};r=A(m,0)+1,W(m,r);switch(o){case v:i=se(t);break;case p:i=fe(t)}return w(e,{sample_rate:n,other_session_increase_id:r},i||{})}function N(){j(a,p,C,!0),j(a,ae,C),j(a,I,N)}function C(e){var n;A(s)?N():(n=(n=e).message||null!=n.lineno||n.type===ae,V(b,((n={key:n?p:v,data:e})[h]=ge(),n[k]=pe(),n)))}var D=null;function he(e){var n=A(J,{}),e=function(e,n){n=function(e){return{identity_package:{device_id:P("did")||P("_did")||P("weblogger_did"),global_id:P("egid"),user_id:P("userId")||P("ud")||P("userName")},app_package:{language:c.language,product_name:e,version_name:P("appver")||""},device_package:{ua:de},service_name:"radarSDK",network_package:{type:function(){var e="",n=c[_]||c.mozConnection||c.webkitConnection;n&&(e=n.type||n.effectiveType);return $[e]||0}()},h5_extra_attr:S(ve)}}(n.product_name),e=(e||[]).map(function(e){var n,r=me(e);return w(((n={key:e.key,value:e.value||{}})[h]=r,n),e[k])});return{common:n,logs:[{client_timestamp:Date.now(),stat_package:{custom_stat_event:{key:"radar_log",value:S({data:e})}}}]}}(e,n),e=S(e),n="https://"+({oversea:"logsdk.kwai-pro.com",logger:"data-track.corp.kuaishou.com"}[n.env]||"log-sdk.ksapisrv.com")+"/rest/wd/common/log/collect/radar",e=(n={url:n,data:e}).url,n=n.data;if(c&&q(c.sendBeacon))try{c.sendBeacon(e,n)}catch(e){i("1003")}else i("1002")}function P(e){try{if(!D){D={};for(var n,r=(document.cookie||"").split("; "),t=0;t<r.length;t++)(n=r[t].split("="))[0]&&(D[n[0]]=decodeURIComponent(n[1]||""))}return D[e]||""}catch(e){}return""}function ye(){j(a,I,xe),j(document,ce,M)}function _e(){ye(),N()}function xe(){M(),_e()}function M(){try{A(s)&&ye();var e=A(b,[]);e.length&&(he(e),W(b,[]))}catch(e){i("1001")}}return e.destroy=_e,e.event=function(e,n){var r,e=w(ge(),e);V(b,((r={key:z})[h]=e,r.value=n,r[k]=pe(),r))},e.init=function(e){var n,r;A(f)||("object"==typeof e&&e?(n=e[y])&&"string"==typeof n?((r={})[y]=n,r.flush=M,r[J]=e,r[x]=!!e[x],n=r,K(),r=w(((r={})[f]=!1,r[s]=!1,r[m]=0,r[b]=[],r[L]=[],r[T]=[],r[B]=[],r),n),H(l,r),null!=(n=e.error)&&!n||(O(a,p,C,!0),O(a,ae,C,!0),O(a,I,N,!0)),O(a,I,xe,!0),O(document,ce,M,!0),W(f,!0)):i("109"):i("108"))},e.push=function(e){C(e)},Object.defineProperty(e,"__esModule",{value:!0}),e}({});
63
+ </script>
64
+ <script>__radarSeedFunc__.init({ "projectId": "c1d407593h", "env": "oversea" });</script>
65
+
66
+
67
+ <link rel="icon" href="/favicon.ico">
68
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
69
+ <meta name="description" content="Explore KlingAI Open Platform, quick start guides, model references, billing details, and integration resources for building AI video and image workflows.">
70
+ <meta property="og:type" content="website">
71
+ <meta property="og:title" content="KlingAI Open Platform">
72
+ <meta property="og:description" content="Explore KlingAI Open Platform, quick start guides, model references, billing details, and integration resources for building AI video and image workflows.">
73
+ <meta property="og:image" content="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/api-doc-share-global.593144c83f836151.png">
74
+ <meta property="og:image:type" content="image/png">
75
+ <meta property="og:image:width" content="1024">
76
+ <meta property="og:image:height" content="536">
77
+ <meta property="og:image:alt" content="KlingAI Open Platform">
78
+ <meta property="og:url" content="https://kling.ai/document-api">
79
+ <meta name="twitter:card" content="summary_large_image">
80
+ <meta name="twitter:title" content="KlingAI Open Platform">
81
+ <meta name="twitter:description" content="Explore KlingAI Open Platform, quick start guides, model references, billing details, and integration resources for building AI video and image workflows.">
82
+ <meta name="twitter:image" content="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/api-doc-share-global.593144c83f836151.png">
83
+ <link rel="apple-touch-icon" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/api-doc-share-global.593144c83f836151.png">
84
+ <script id="kling-breadcrumb-jsonld" type="application/ld+json">
85
+ {"@context":"https://schema.org","@type":"BreadcrumbList","@id":"https://kling.ai/document-api#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Kling AI","item":"https://kling.ai"},{"@type":"ListItem","position":2,"name":"API Documentation","item":"https://kling.ai/document-api"}]}
86
+ </script>
87
+ <!-- :::[gundam index-html-head]::: -->
88
+
89
+ <script id="js-cdn-protector">try {!function(r,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(r="undefined"!=typeof globalThis?globalThis:r||self).$ksCdnWebProtector=t()}(this,(function(){var r=function(){return r=Object.assign||function(r){for(var t,e=1,n=arguments.length;e<n;e++)for(var i in t=arguments[e])Object.prototype.hasOwnProperty.call(t,i)&&(r[i]=t[i]);return r},r.apply(this,arguments)};function t(r,t,e){if(e||2===arguments.length)for(var n,i=0,o=t.length;i<o;i++)!n&&i in t||(n||(n=Array.prototype.slice.call(t,0,i)),n[i]=t[i]);return r.concat(n||Array.prototype.slice.call(t))}"function"==typeof SuppressedError&&SuppressedError;var e=window,n=e.document,i=e.HTMLScriptElement,o=e.HTMLStyleElement,a=e.HTMLLinkElement,u=e.HTMLImageElement,c=e.HTMLVideoElement,f=e.HTMLAudioElement,s=e.HTMLSourceElement,l=e.SVGImageElement,d=e.HTMLIFrameElement,h="1.0.78",y="script",v="link",p="img",m="image",g="stylesheet",_="text/css",b=[g].concat(["prefetch","preload","modulepreload"]),E="crossorigin",x="__cdnRetryListenerList",T="__cdnRetryOnError",D="__cdnRetryOnLoad",R="__cdnRetryTimeoutHandler",C="addEventListener",I="DOMContentLoaded",U="data-cdn-hooked",w="data-cdn-sync",O="data-cdn-id",S={enumerable:!0,configurable:!0},A="cdn_protector",N="cdn_protector_error",L="cdn-protector__dispatch-domain",P="cdn-protector__error-domains",k=function(r){return r},j=function(){},M=function(){return!/Edge|MSIE|rv:/i.test(navigator.userAgent)},H=function(r){if(e&&(e[r],1))return e[r]},F=function(r,t,e,o,a){var u;void 0===e&&(e=j),void 0===o&&(o=!1),void 0===a&&(a="head");var c=r.getAttribute(O)||"",f=o||r.defer||r.async;if("loading"!==n.readyState||!M()||f){var s=function(r,t){var e=n.createElement(y);Object.keys(i.prototype).forEach((function(t){if("src"!==t&&r[t]&&"object"!=typeof r[t])try{e[t]=r[t]}catch(n){}}));var o=r.attributes,a=o&&o.length;if(a)for(var u=0;u<a;u++){var c=o[u];if(c&&["src",O,U].indexOf(c.name)<0)try{e.setAttribute(c.name,c.value)}catch(f){}}return e.src=t,e.onload=r.onload,e.onerror=r.onerror,e[x]=r[x],e}(r,t);s.setAttribute(O,c),null===(u=n.getElementsByTagName(a)[0])||void 0===u||u.appendChild(s)}else{var l=c?"".concat(O,'="').concat(c,'" '):"",d=r.outerHTML.replace(/data-cdn-id="[^"]+"/,"").replace(/src=(?:"[^"]+"|.+)([ >])/,"".concat(l,'src="').concat(t,'"$1'));if(n.write(d),e){var h=n.querySelector("script[".concat(O,'="').concat(c,'"]'));h&&(h.onload=e)}}},$=function(){return Math.random().toString(36).slice(2)},W=function(){return Math.random()},B=function(r){var t=undefined;r instanceof i||r instanceof u||r instanceof f||r instanceof c||r instanceof s||r instanceof d?t=r.src:r instanceof a?t=r.href:r instanceof l&&(t=r.href&&r.href.baseVal);var e=r;return!t||(e.getAttribute("src")||e.getAttribute("href")||r instanceof l)&&0===mr(t).indexOf("http")?t&&(/^(https?:\/\/|\/\/)?[^/]*\/ksc\d+\//.test(t)||/[?&]pkey=/i.test(t))||e.getAttribute("data-lazyload-placeholder")||"no-pre"===e.getAttribute("alt")?undefined:t:undefined},q=function(r){return(r instanceof i||r instanceof u||r instanceof l||r instanceof c||r instanceof f||r instanceof d||r instanceof a&&(b.indexOf(r.rel)>-1||r.type===_))&&!r.hasAttribute("data-cdn-ignore")},J=function(r,t,e){try{Object.defineProperty(r,t,e)}catch(n){}},K=function(r){return r instanceof c||r instanceof f},V=function(r,t,e){try{if(!r)return!1;if(!e.videoRetryEnable)return!1;if(!1===function(r){var t,e=null===(t=r.error)||void 0===t?void 0:t.code;return[2,3,4].indexOf(e)>-1}(r))return!1;if(e.videoRetryStrictly){var n=br(t);if(!n||!Y(n))return!1}return!Q(t)}catch(i){return!1}},z=function(r){return r.target||r.srcElement};function G(){if(H("performance"))try{return e.performance&&e.performance.getEntriesByType("resource")}catch(r){}return undefined}function X(r,t){void 0===t&&(t=!0);var e=r.duration,n=r.transferSize,i=r.responseStatus,o=r.encodedBodySize,a=r.decodedBodySize,u=i>=200&&i<300||304===i;return!i&&!n&&a>0||u&&!n&&(!a||e<10)?t:!!u||!(i>=400)&&(!(!e&&!n||!(i||o||a))&&!!(i||n||o||a))}function Q(r){var t=function(r){if(!r)return undefined;if(H("performance"))try{return e.performance&&e.performance.getEntriesByName(r)}catch(t){}return undefined}(r);return t&&t.length?t.some((function(r){return X(r)})):null}function Y(r,t){var e=(null==(t=t||G())?void 0:t.filter((function(t){return t.name&&t.name.indexOf("/".concat(r,"/"))>-1})))||[],n=e.filter((function(r){return!0===X(r,!1)})).length,i=e.length;return!i||!n||n<.4*i}function Z(r){r&&(H("requestIdleCallback")?e.requestIdleCallback(r):r())}function rr(r){return r?"object"==typeof r&&r instanceof Array?r.filter((function(r){return r})).join(","):r||"":""}function tr(r){for(var t=[],e=0;e<r.length;e++)-1===t.indexOf(r[e])&&t.push(r[e]);return t}function er(r,t){return r.indexOf(t)>-1}function nr(r,t){return!!r&&0===r.indexOf(t)}function ir(r,t){for(var e=0;e<r.length;e++)if(t(r[e],e,r))return r[e];return undefined}function or(r,t,e,n,i){return er(n,r[e])?-1:er(n,t[e])?1:"string"===i?r[e]?r[e].localeCompare(t[e]||""):0:(r[e]||0)-(t[e]||0)}function ar(r,t,e,n){if(t&&r){var i=t[e];r[e]=i||0===i||!1===i?i:n}}function ur(r,t,e){if(!r&&!t)return r;if(!r||!t)return r||t;var n=r||[];return(t||[]).forEach((function(r){e&&"object"==typeof r&&ir(n,(function(t){return t&&r&&t[e]===r[e]}))||er(n,r)||n.push(r)})),n}function cr(r,t,e,n){r[e]=ur(r[e],t[e],n)}var fr=function(r){var t=H("localStorage");return t&&t.getItem(r)},sr=function(r,t){var e=H("localStorage");return e&&e.setItem(r,t)},lr=function(){return Date.now()},dr=function(){var r=fr(P);if(r)try{return(JSON.parse(r)||[]).filter((function(r){var t=r&&r.timestamp;return t&&lr()-t<216e5&&r.domain}))}catch(t){}},hr=function(r){r&&e.clearTimeout(r)};function yr(r,t){if(!r)return[];var e=function(r,t){if(!r||!t||!t.length)return[];var e=t.filter((function(t){return t.v===r})),n=tr(e.map((function(r){return r.type}))),i=tr(e.map((function(r){return r.c_id}))),o=tr(e.map((function(r){return r.cs}))),a=t;return!0===kr.onlySameProjectRetry&&(a=t.filter((function(r){return!r.c_id||er(i,r.c_id)}))),a.sort((function(r,t){if(r.is_error!==t.is_error)return 1===r.is_error?1:-1;if(r.c_id!==t.c_id)return or(r,t,"c_id",i);if(r.is_realtime!==t.is_realtime)return 1===r.is_realtime?-1:1;if(r.type!==t.type)return or(r,t,"type",n);if(r.valid!==t.valid)return 1===r.valid?-1:1;if(r.cs!==t.cs){if(o.indexOf(r.cs)>-1)return 1;if(o.indexOf(t.cs)>-1)return-1}return 0}))}(r,t).filter((function(r){return 1!==r.is_error||(Hr[r.v]||0)<5})).map((function(r){return r.v}));return tr(e)}function vr(r,t){return r?yr(br(r),t):[]}var pr=function(r){return!r||!("string"!=typeof r||!(nr(r,"data:")||nr(r,"blob:")||nr(r,"file:")))},mr=function(r){if(!r)return"";if(r instanceof URL)return r.href;if(0===r.indexOf("//"))r=e.location.protocol+r;else{if(nr(r,"/"))return e.location.origin+r;if(pr(r))return"";-1===r.indexOf("http")&&(r="http://"+r)}return r},gr=function(r){if(!r)return null;try{return(r=mr(r))?new URL(r):null}catch(t){return null}},_r=function(r){return r?r.hostname+(r.port?":"+r.port:""):""},br=function(r){var t=gr(r);return _r(t)},Er=function(r,t){if(!r)return!1;if(pr(r))return!1;var n=gr(r);if(!n)return!1;var i,o,a=_r(n),u=n.pathname||"",c=kr.ignoreDomains,f=kr.allDispatchDomains,s=kr.domains,l=kr.ignoreUrlPaths,d=kr.htmlCdnDispatchKey;if(c&&c.some((function(r){return a===r})))return!1;if(l&&u&&l.some((function(r){return nr(u,r)})))return!1;if(i=t,o=kr.onlyDispatchDomainRetry,!1===(t=i===undefined?o:i))return!0;if(f&&f.some((function(r){return a===r.v})))return!0;if(s&&s.length&&s.some((function(r){return r===a||new RegExp("^".concat(r.replace(/\./g,"\\.").replace(/\*/g,".*"),"$")).test(a)})))return!0;var h,y=(h=d)&&H(h)&&e[h]||"";return!(!y||a!==y)};function xr(r,t,e){if(r&&t&&t.length&&e!==undefined){var n=br(r);t.forEach((function(r){var t=e?1:0;r.v===n&&r.is_error!==t&&(r.is_error=t)})),e?(Mr[n]=r,Hr[n]=(Hr[n]||0)+1):(Mr[n]=undefined,Hr[n]=0)}}var Tr=function(r){var t=tr(r).length-1;return Math.min(kr.retryTimes||5,t)},Dr=function(r){return r&&r.length?r.map((function(r){return Rr(r)})):[]},Rr=function(r){return r?r.replace(/\+/g,"."):r},Cr=null,Ir=[],Ur=function(){var r,t=H("__radarSeedFunc__")||$r;if(H("Radar")&&H("Weblog")||t&&"function"==typeof t.event||!0===kr.ignoreRadarWarning){var e=Ar(!0);e&&Sr(e)}else r="WARNING: Radar sdk is not defined. Please check if loaded correctly.",console.warn("%c[".concat("cdn-web-protector","] ").concat(r),"color:red;font-weight:600")},wr=function(r){var t,e,n;try{var i=H("Radar"),o=H("Weblog");if(!i||!o||Cr)return Cr;var a=kr.radarSeedConfig||{},u=H("_WEBLOGGER"),c=u&&u.instances&&u.instances[0],f=a.projectId;return c&&(f=null===(n=null===(e=null===(t=c.plugins)||void 0===t?void 0:t.radar)||void 0===e?void 0:e.options)||void 0===n?void 0:n.projectId),r||f?(f=f||"7c2de29911",c||(c=new o({env:a.env||"production"},{product_name:f,product:1})),Cr=new i({weblog:c,projectId:f,sampling:1,unuseAPIPlugin:!0,unuseErrorPlugin:!0,unuseResourcePlugin:!0})):Cr}catch(s){}},Or=function(r,t){r&&Ir.length<50&&Ir.push([r,t])},Sr=function(r){if(r&&Ir.length)try{Ir.forEach((function(t){r(t[0],t[1])})),Ir=[]}catch(t){}},Ar=function(r){var t,e=null,n=H("__radarSeedFunc__");if(n&&n.event&&"function"==typeof n.event){if((t=H("__radarSeedStore__"))&&t.flush&&"function"==typeof t.flush)return n.event;e=n.event}var i=$r&&$r.event;if(i&&"function"==typeof i)return i;var o=wr(r);if(o&&o.event&&"function"==typeof o.event)return o.event.bind(o);if(e)Sr(e);else if(!r)return Or;return e},Nr=function(t,e){var n=Ar();if(n)try{n({name:N,message:t,extra_info:r(r({},e=e||{}),{message:e.message,stack:e.stack})})}catch(i){}},Lr="xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,(function(r){var t=16*Math.random()|0;return("x"==r?t:3&t|8).toString(16)})),Pr={},kr={},jr={},Mr={},Hr={},Fr={},$r=H("__radarSeedFunc__")||{},Wr={retryCaches:Pr,probeCaches:jr,addDomains:function(r){if(r&&"object"==typeof r&&r.length){var t=kr.allDispatchDomains,e=kr.domains,n=r.filter((function(r){return!(null==t?void 0:t.some((function(t){return t.v===r})))}));if(n.length)n.map((function(r){return{v:r}})).forEach((function(r){t.push(r),e&&e.push(r.v)}))}},version:h,options:kr,_pageLoaded:!1,_pageUnload:!1};e.__cdn_web_protector__=e.__cdn_web_protector__||Wr,e.__cdn_protector__=e.__cdn_protector__||Wr;var Br=function(t,e){var n;t.dispatchDomains=(n=t.dispatchDomains||[])&&n.length?n.map((function(t){return r(r({},t),{v:Rr(t.v)})})):[],t.domains=t.domains?Dr(t.domains):[],Object.keys(t).forEach((function(r){t[r]!==undefined&&(kr[r]=t[r])}));var i=ur(kr.domains,t.domains||t.domain||[]);kr.domains=(i||[]).filter((function(r){return r&&"*"!==r&&"."!==r})),cr(kr,t,"dispatchDomains","v"),cr(kr,t,"ignoreDomains"),cr(kr,t,"ignoreUrlPaths"),cr(kr,t,"projectNames"),kr.allDispatchDomains=ur(kr.allDispatchDomains,function(r){var t=r.domains,e=r.ignoreDomains,n=r.dispatchDomains,i=[];if(t&&t.length>0){var o=t.filter((function(r){return r&&r.indexOf("*")<0&&0!==r.indexOf(".")})).map((function(r){return{v:r}}));i=i.concat(o)}n&&n.length>0&&(i=i.concat(n)),e&&e.length>0&&(i=i.filter((function(r){return!e.some((function(t){return r&&r.v===t}))})));var a=H("__CDN_DISPATCH__");return a&&Object.keys(a).forEach((function(r){var t=a[r];t&&t.length&&t.forEach((function(r){var t=ir(i,(function(t){return t.v===r}));t?t.is_realtime=1:i.push({v:r,c_id:0,is_realtime:1})}))})),i}(t),"v")||[],e||(ar(kr,t,"retryTimes",5),ar(kr,t,"onRetry",k),ar(kr,t,"bu",""),ar(kr,t,"htmlCdnDispatchKey","cdn_public_path"),ar(kr,t,"onlyDispatchDomainRetry",!0),ar(kr,t,"probeEnable",!0),ar(kr,t,"ajaxRetryEnable",!0),ar(kr,t,"asyncJsRetryEnable",!0),ar(kr,t,"videoRetryEnable",!0),ar(kr,t,"videoRetryStrictly",!0),ar(kr,t,"probeInterval",60),ar(kr,t,"timeoutDuration",30),ar(kr,t,"timeoutDomainExpiredDays",7))},qr=function(r,t,n){if(!1!==kr.dispatchKeyReplaceEnable&&H(r)){var i=Hr[t]||0;Hr[t]=i+1;var o=e[r];if(!o||"string"!=typeof o)return;var a=br(o);Jr(r,a,n),i>5&&function(r){try{if(!r)return;var t=P,e=dr()||[];if(ir(e,(function(t){return t.domain===r})))return;sr(t,JSON.stringify(e.concat({domain:r,timestamp:lr()})))}catch(n){}}(t)}},Jr=function(r,t,n){if(t&&n&&H(r)){var i=e[r];if(!i||"string"!=typeof i)return;e[r]=i.replace(t,n)}},Kr=[],Vr={},zr=null,Gr=null,Xr=[],Qr={},Yr={},Zr={},rt={},tt=null;function et(r){n.styleSheets&&n[C](I,(function(){nt(r)}))}function nt(r){hr(zr),zr=e.setTimeout((function(){try{var t=it(n.styleSheets,!0);t&&t.length&&(ot(t,r),!1!==kr.cssResourceProbeEnable&&(hr(tt),tt=e.setTimeout((function(){return Z((function(){try{var r=Object.keys(Zr);if(!r.length)return;var t=r.filter((function(r){if(!r||rt[r]||Xr.indexOf(r)>-1)return!1;var t=Zr[r];return!(!t||Yr[t]||kr.allDispatchDomains.filter((function(t){return t.is_error&&t.v===r})).length)}));if(!t.length)return;var e=G();e&&e.length&&t.forEach((function(r){var t=Zr[r];if(t){var n=e.filter((function(t){return t.name&&t.name.indexOf(r)>-1})),i=Y(r,n);n.length&&!i||function(r){try{if(!r)return;var t;(t=new Image).src=r;var e=function(){t&&(t.src="",t.onload=null,t.onerror=null,t=null)};t.onload=e,t.onerror=e}catch(n){}}(t)}}))}catch(n){}hr(tt),tt=null}))}),4e3)))}catch(i){Nr("processStyleSheets",i)}nt(r)}),300)}function it(r,t){var e;return void 0===t&&(t=!0),(e=r,[].slice.call(e)).filter((function(r){if(!ut(r))return!1;if(r.href){if(t&&Vr[r.href])return!1;if(!Er(r.href))return!1}else{var e=r.ownerNode;if(!e||!function(r){var t;try{if(!(null===(t=n.documentElement)||void 0===t?void 0:t.contains(r)))return!1}catch(e){}return!0}(e))return!1;if(!(e instanceof o))return!1;if(t)return Kr.indexOf(e)<0}return!0}))}function ot(r,t,e){void 0===r&&(r=[]),void 0===e&&(e=!1),r.forEach((function(r){var n=ut(r);if(null!==n&&n){r.href&&(Vr[r.href]=!0),r.ownerNode instanceof o&&Kr.push(r.ownerNode);for(var i=[],a=0,u=n.length;a<u;a++)try{var c=at(n[a],r,n,t,e)||[];i=i.concat(c)}catch(f){}i.length>0&&t.onSuccess&&t.onSuccess({status:"success",hooked:!0,nodeName:"css-resource",errorId:r.href||"style-tag__".concat($()),errorUrl:r.href||i[0].errorUrl||"",retryUrl:"",retryTimes:1,extraInfo:{cssRetryCaches:i}})}}))}function at(t,e,n,i,o){void 0===o&&(o=!1);var a=[],u=t&&t.cssText;if(st(u)){var c=kr.allDispatchDomains.filter((function(r){var t=r.v;if(!t)return!1;var e=Qr[t];return o?e&&e<0:r.is_error})).map((function(r){return r.v})),f=(c=tr(c)).length;if(!1!==kr.cssResourceProbeEnable||f){if(!f||!function(r){if("undefined"!=typeof CSSFontFaceRule)return r instanceof CSSImportRule;return r.type===CSSRule.IMPORT_RULE}(t)){var s={},l={backgroundImage:"background",borderImage:"border",listStyleImage:"list-style"},d=function(r){try{if(!r)return{};var t={};return r.replace(/([^{]+)\s*\{([^}]*)\}/g,"$2").split(";").forEach((function(r){var e=r.split(":"),n=e[0],i=e.slice(1).join(":");n&&i&&(t[n.trim()]=i.trim())})),t}catch(e){return{}}}(t.cssText),h=function(n){var u=d[n];if(!st(u))return"continue";var h=ir(Object.keys(l),(function(r){return n.indexOf(l[r])>-1}));h&&(n=h.replace(/([a-z])([A-Z])/g,(function(r,t,e){return"".concat(t,"-").concat(e.toLowerCase())})),u=t.style&&t.style[n]);var y=ct(u,c,i,e,o)||{},v=y.retryCssText,p=y.retryCaches,m=y.urlDomains;m&&m.length&&m.forEach((function(r){var t=r[0],e=r[1];t&&e&&!Zr[t]&&/\.(jpe?g|png|webp)$/gi.test(e)&&(Zr[t]=e)})),f&&v&&(s[n]=v,p&&p.length&&(a=a.concat(p.map((function(t){return r(r({},t),{nodeName:n})})))))};for(var y in d)h(y);return f&&Object.keys(s).map((function(r){t.style&&(t.style[r]=s[r])})),a}var v=ct(u,c,i,e,o)||{},p=v.retryCssText,m=v.retryCaches;if(p&&function(r,t,e,n){for(var i,o=!1,a=0;a<e.length;a++)if((null===(i=e[a])||void 0===i?void 0:i.cssText)===t){o=!0;break}if(o)return;var u=e.length;try{if(r.insertRule)try{r.insertRule(t,u)}catch(c){r.insertRule(t,0)}else r.addRule&&r.addRule(n.selectorText,t,u)}catch(f){Nr("insertRule",f)}}(e,p,n,t),m&&m.length){var g="rule-type-".concat(t.type);a=a.concat(m.map((function(t){return r(r({},t),{nodeName:g})})))}}}}function ut(r){try{return r.rules||r.cssRules}catch(t){return null}}function ct(r,n,i,o,a){if(void 0===a&&(a=!1),!r)return null;var u=r,c=[],f=[],s=function(r){for(var t,e=/url\(['"]?([^'"()]*)['"]?\)/g,n=[];null!==(t=e.exec(r));)t[1]&&n.push(t[1].trim());return tr(n)}(r),l=o.href;return s.forEach((function(r){var o=r;if(l&&!/^(https?:)?\/\//i.test(o)&&(o=function(r,n){if(!r||!n)return"";try{return"undefined"!=typeof e.URL?new URL(r,n).href:function(r,e){var n=e.match(/^(https?:\/\/[^/]+)(\/[^?#]*)/i);if(!n||!n[1])return"";n[0];var i=n[1],o=n[2];if(r.startsWith("/"))return i+r;var a=o.split("/").filter(Boolean),u=r.split("/");for(;".."===u[0];)a.length>0&&a.pop(),u.shift();"."===u[0]&&u.shift();var c=("/"+t(t([],a,!0),u,!0).join("/")).replace(/\/+/g,"/");return i+c}(r,n)}catch(i){}return""}(o,l)),o){if(a){if(Yr[o])return;var s=Q(o);if(Yr[o]=!!s,s)return}if(Er(o,!0)){var d=br(o);if(Qr[d]===undefined&&(Qr[d]=0),f.push([d,o]),!(n&&n.indexOf(d)<0)){var h=vr(o,kr.allDispatchDomains);if((h=h.filter((function(r){return n.indexOf(r)<0}))).length){var y=lt(o,{retryId:$(),retryUrls:[],retryTimes:0,errorUrl:o},h,i.onRetry);y!==o&&(u=u.replace(new RegExp(r.replace(/[.*+?^${}()|[\]\\]/g,(function(r){return"\\".concat(r)})),"g"),y),c.push({errorUrl:o,retryUrl:y}))}}}}})),{retryCssText:u===r?null:u,retryCaches:c,urlDomains:f}}function ft(t,e){try{if(!t||t.toLowerCase()!==v||!e)return;if(e.rel&&e.rel!==g)return;if(e.type&&e.type!==_)return;if(e.getAttribute(E))return;var n="href";J(e,n,r({get:function(){return this.getAttribute(n)},set:function(r){this.setAttribute(n,r),function(r,t,e){try{if(!r||!t||!e||r.toLowerCase()!==v)return;if(e.rel!==g&&e.type!==_)return;if(e.getAttribute(E))return;if(!Er(t))return;e.setAttribute(E,"anonymous")}catch(n){Nr("initCssCrossOrigin",n)}}(t,r,e)}},S))}catch(i){Nr("initCssLinkHref",i)}}function st(r){return r&&/url\(['"]?(https?:\/\/|\/\/|\/|\.\.?\/)[^'"()]*['"]?\)/i.test(r)||!1}function lt(r,t,e,n){var i=function(r,t){var e=tr(r.retryUrls&&r.retryUrls.map(br)),n=br(r.errorUrl);e.push(n);var i=t.filter((function(r){return!er(e,r)}))[0];return i||(i=t[r.retryTimes%t.length]),i&&i!==n?r.errorUrl.replace(n,i):""}(t,e);if(!i)return"";if(n&&"function"==typeof n){var o=n(i,r);return o&&"string"!=typeof o?i:null===o?"":o||i}return i}function dt(r,t,o){void 0===o&&(o=!1);var s=t.onRetry,h=B(r)||"",y=ht(r),p=y.retryCache,m=y.newTarget,g=y.retryId||$(),_=vr(h,kr.allDispatchDomains);if(!_.length)return!1;m?r.setAttribute(O,g):p&&p.status&&(p=undefined,r.setAttribute(O,"".concat(y.targetRetryId,"_").concat($())));var b=p||{retryId:g,retryUrls:[],retryTimes:0,startTime:Date.now(),errorUrl:h},E=lt(h,b,_,s);if(!E)return!1;if(b.retryTimes++,b.retryUrls.push(E),Pr[g]=b,r instanceof u&&r.src){if(r.src=E,r.srcset&&"string"==typeof r.srcset){var T=br(h),D=br(E);T&&D&&T!==D&&(r.srcset=r.srcset.split(T).join(D))}}else r instanceof i&&r.src?F(r,E,j,o):r instanceof a&&r.href?function(r,t,e){var i=r.getAttribute(O)||"",o=n.createElement(v);Object.keys(a.prototype).forEach((function(t){if("href"!==t&&r[t]&&"object"!=typeof r[t])try{o[t]=r[t]}catch(e){}})),o.href=t,o.onload=e||r.onload,o.onerror=r.onerror,o.setAttribute(O,i),o[x]=r[x],r.insertAdjacentElement("afterend",o)}(r,E):r instanceof c||r instanceof f||r instanceof d&&r.src?r.src=E:r instanceof l&&r.href&&r.href.baseVal&&(r.href.baseVal=E);xr(h,kr.allDispatchDomains,!0),function(r,t){var i=r&&br(r);!i||Xr.indexOf(i)>-1||(Xr.push(i),hr(Gr),Gr=e.setTimeout((function(){return Z((function(){try{var r=Xr.filter((function(r){return!Qr[r]}));if(!r.length)return;var e=G(),i=!1;if(r.forEach((function(r){var t=Y(r,e);i=t||i,Qr[r]=t?-1:1})),!i)return;var o=it(n.styleSheets,!1);o&&o.length&&ot(o,t,!0)}catch(a){}hr(Gr),Gr=null}))}),1e3))}(h,t)}var ht=function(r,t){var e=r&&r.getAttribute(O),n=e?Pr[e]:undefined;return n&&n.status&&t&&(n=undefined),{newTarget:!e,retryId:e,targetRetryId:e,retryCount:n&&n.retryTimes||0,maxRetryCount:n&&n.maxRetryCount||0,nodeName:r.nodeName,asyncHooked:r.getAttribute(U)&&!r.getAttribute(w),retryCache:n}},yt=function(r,t,e,n,i){if(n&&("fail"!==i||!0!==Q(e))){var o=n.retryCache||{},a={status:i,hooked:!0,nodeName:n.nodeName,errorId:n.retryId||"",errorUrl:o.errorUrl||"",retryUrls:o.retryUrls||[],startTime:o.startTime||0,retryUrl:e,retryTimes:n.retryCount},u=r.getAttribute("data-cdn-timeout-domains");u&&(a.extraInfo={timeout_domains:u}),t(a),n.retryCache&&(n.retryCache.status=i),pt(r)}},vt=function(r){return!!r&&(r>=200&&r<400)},pt=function(r){if(r&&q(r)){var t=r[D];t&&t._called&&(r[D]._called=!1)}},mt=null;function gt(){var r=kr.probeInterval||60;hr(mt),mt=e.setTimeout((function(){return function(r){if(Wr._pageUnload)return r&&r();var t=kr.allDispatchDomains.filter((function(r){var t=r.v;return!!t&&(!(!r.is_error&&!Fr[t])&&!(jr[t]&&jr[t].length>=5))})).map((function(r){return r.v}));if(!(t=tr(t)).length)return r&&r();var e=t.length,n=0,i=function(){if(n>=e)return r&&r();var o=t[n],a=Mr[o]||Fr[o];n++,o&&a?function(r,t,e){jr[t]=jr[t]||[],function(r,t,e,n,i){var o=new XMLHttpRequest;o.__cdn_ignore=!0,o.timeout=n||1e3,o.withCredentials=!1,o.open(t,r,!0),o.onreadystatechange=function(){4===o.readyState&&(o.status>=200&&o.status<400?i&&i(null,o.responseText):o.status>0&&i&&i(o))},o.onerror=function(){i&&i(o)},o.ontimeout=function(){i&&i(o)},o.send(e)}(r,"HEAD",null,0,(function(n){n?jr[t].push({url:r,status:n.status,time:Date.now()}):(Et(r,t,!1,!0),xr(t,kr.allDispatchDomains,!1),jr[t].push({url:r,status:200,time:Date.now()})),e(n)}))}(a,o,i):i()};i()}(gt)}),1e3*r)}var _t="cdn-protector-timeout-domain",bt=function(r){try{r&&r[R]&&(hr(r[R]),r[R]=null)}catch(t){}},Et=function(r,t,e,n){void 0===n&&(n=!0);try{if(Fr[t]=e?r:undefined,xr(t,kr.allDispatchDomains,!1),n){var i=JSON.parse(fr(_t)||"{}");e?i[t]=r?{url:r,domain:t,log_time:Date.now()}:undefined:i[t]&&delete i[t],sr(_t,JSON.stringify(i))}}catch(o){}},xt=function(r,t,e){r[x]&&r[x].filter((function(r){return r.type===e})).forEach((function(e){return n=e.listener,i=r,o=t,"function"!=typeof n?null:n.call(i,o);var n,i,o}))},Tt=function(t,e){var i=B(e);if(i){var o=br(i);if(q(e)&&Er(i)){var a=kr.ignoreDomains;if(!a||!a.some((function(r){return o===r}))){var u=new Event(t);J(u,"target",r({value:e,writable:!0},S)),n.dispatchEvent(u)}}}},Dt=function(t,e){void 0===e&&(e=!1),t.onload=function(r){return e&&Tt("load",t),(n=t[D],function(r){n&&!n._called&&(n._called=!0,n.call(this,r)),xt(this,r,"load")}).call(t,r);var n},J(t,"onload",r({get:function(){return this[D]},set:function(r){this[D]=r}},S))},Rt=function(t,e,n){void 0===n&&(n=!1),t.onerror=function(r){return n&&Tt("error",t),function(r,t){return function(e){var n=this;if("string"!=typeof e){var o=function(){r&&r.call(n,e),xt(n,e,"error")};e.stopPropagation&&e.stopPropagation();var a=B(this);if(!a)return o();if(!kr.asyncJsRetryEnable&&this instanceof i)return o();if(!q(this)||!Er(a)||!a)return o();if(K(this)&&!V(this,a,kr))return o();bt(this);var u=vr(a,kr.allDispatchDomains);if(!u.length)return o();var c=ht(this,!0),f=c.maxRetryCount||Tr(u);return c.retryCache&&(c.retryCache.maxRetryCount=f),c.retryCount>=f?(yt(this,t.onFail,a||"",c,"fail"),o()):!1===dt(this,t,!0)?o():void 0}}}(t[T],e).call(t,r)},J(t,"onerror",r({get:function(){return this[T]},set:function(r){this[T]=r}},S))};function Ct(r){var i=function(t,e){var n,i;t.setAttribute(U,"true"),Dt(t,e),Rt(t,r,e),i=(n=t)[C],n[x]=n[x]||[],n[C]=function(r,t,e){if("error"===r||"load"===r){var n="function"==typeof t?t:t.handleEvent;this[x].push({type:r,listener:n})}else i.call(this,r,t,e)}},o=function(r,t,e,n){try{var o=t.call(r,e,n);return[y,v,p,m].indexOf(e&&e.toLowerCase())>-1&&(ft(e,o),i(o,!1)),o}catch(a){return Nr("initAsync",a),t.call(r,e,n)}};if(kr.rewriteElementPrototypeEnable&&H("Document")){var a=Document.prototype.createElement;Document.prototype.createElement=function(r,t){return o(this,a,r,t)}}else{var u=n.createElement;n.createElement=function(r,t){return o(n,u,r,t)}}if(H("Image")){var c=e.Image;e.Image=function(){for(var r=[],e=0;e<arguments.length;e++)r[e]=arguments[e];try{var n=new(c.bind.apply(c,t([void 0],r,!1)));return n[x]=[],i(n,!0),n}catch(o){return Nr("initImageAsync",o),new(c.bind.apply(c,t([void 0],r,!1)))}},e.Image.prototype=c.prototype}if(H("Audio")){var f=e.Audio;e.Audio=function(){for(var r=[],e=0;e<arguments.length;e++)r[e]=arguments[e];try{var n=new(f.bind.apply(f,t([void 0],r,!1)));return n[x]=[],i(n,!0),n}catch(o){return Nr("initAudioAsync",o),new(f.bind.apply(f,t([void 0],r,!1)))}},e.Audio.prototype=f.prototype}}var It=function(){return!!H("__POWERED_BY_QIANKUN__")||!!H("__MICRO_APP_ENVIRONMENT__")},Ut="",wt="",Ot=!1;function St(r){var t,e;if(r&&r.length)for(var i=0,o=r.length;i<o;i++){var a=r[i];if(a&&a.url&&a.tag){var u=n.createElement(a.tag),c=a.attrs;Nt(u,a.attrs);var f=jt(a.url),s=Lt(a.ptag),l="link"===a.tag;l?u.href=f:u.src=f;try{if(l&&c&&c.rel===g){if(kt(f))continue;if("head"===a.ptag&&"loading"===n.readyState&&M()){u.setAttribute(w,"1");var d=u.outerHTML;n.write(d);continue}var h=(t=void 0,e=void 0,t=Pt(),(e=t&&t.length)?t[e-1]:null);if(h){h.insertAdjacentElement("afterend",u);continue}if(s){s.insertAdjacentElement("afterbegin",u);continue}}if("script"===a.tag){var y=c&&(c.defer!==undefined||c.async!==undefined);y||(u.async=!1,u.setAttribute(w,"1")),F(u,f,undefined,y,a.ptag);continue}}catch(v){}s&&s.appendChild(u);try{n.currentScript&&n.currentScript.remove()}catch(v){}}}}function At(){try{if(!(Ot=!(!0!==kr.webDispatchEnable||!kr.dispatchPlaceholder||H("__CDN_DISPATCH__")||"undefined"==typeof window.MutationObserver)))return;var r=kr.dispatchPlaceholder;if(!(wt=r?Dr([r])[0]:""))return;var t=function(){var r=fr(L),t=dr(),e=t?t.map((function(r){return r.domain})):[];er(e,r)&&(r="");r||(r=function(r){var t,e=kr.dispatchDomains;if(!wt||!(null==e?void 0:e.length))return;var n=null===(t=e.find((function(r){return r.v===wt})))||void 0===t?void 0:t.c_id;if(n===undefined)return;var i=e.filter((function(t){return!(t.c_id!==n||r&&r.length&&er(r,t.v))}));if(!i.length)return;for(var o=Math.floor(1e3*W()),a=0,u=i.length;a<u;a++){var c=i[a];if(c&&c.p&&2===c.p.length){var f=c.p||[],s=f[0],l=f[1];if(s!==undefined&&l!==undefined&&o>=s&&o<=l)return c.v}}var d=i.filter((function(r){return r.p}));if(d.length){var h=Ht(d);if(h)return h}return Ht(i.filter((function(r){return!r.p})))}(e));return r}();if(!t)return;if(function(r){if(!r||!Ot)return;if(Ut=r,e.__cdn_protector_dispatch__=r,!1===kr.dispatchHash)return;sr(L,r)}(t),wt===Ut)return;!function(r){if(!r)return;kr.htmlCdnDispatchKey&&Jr(kr.htmlCdnDispatchKey,wt,r);(kr.htmlCdnDispatchKeys||["cdn_public_path","cdn_public_path_video"]).forEach((function(t){return Jr(t,wt,r)}))}(t);var n=Ft();e[C](I,(function(){n&&n.disconnect()}))}catch(i){Nr("initWebDispatch",i)}}function Nt(r,t){if(r&&t&&"object"==typeof t)try{for(var e in t)Object.prototype.hasOwnProperty.call(t,e)&&("className"===e?r.className=t[e]:r.setAttribute(e,t[e]))}catch(n){}}function Lt(r){var t=n.getElementsByTagName;return"head"===r?n.head||t("head")[0]:n.body||t("body")[0]}function Pt(){return n.getElementsByTagName("link")}function kt(r){var t=Pt(),e=t&&t.length;if(e){for(var n=0;n<e;n++){var i=t[n];if(i&&i.rel===g&&i.href&&i.href===r)return!0}return!1}}function jt(r){return r&&Ot&&wt&&Ut?-1===r.indexOf(wt)||wt===Ut?r:Mt(r,Ut)||r:r}function Mt(r,t){try{return r&&t&&wt?r.replace(new RegExp(wt.replace(".","\\."),"g"),t):r}catch(e){}return r}function Ht(r){return r[Math.floor(W()*r.length)].v}var Ft=function(){var r=new MutationObserver((function(r){try{for(var t=0,e=r.length;t<e;t++){var n=r[t];if("childList"===n.type&&n.addedNodes&&n.addedNodes.length)for(var i=0,o=n.addedNodes.length;i<o;i++){var a=n.addedNodes[i];if(a&&a.nodeType===Node.ELEMENT_NODE){var u=a.innerHTML;u&&-1!==u.indexOf(wt)&&-1===u.indexOf("$ksCdnLoad")&&(a.innerHTML=Mt(u,Ut))}}}}catch(c){}}));return r.observe(n.documentElement,{childList:!0,subtree:!0}),r},$t=function(r,t){return kr.onRetry&&"function"==typeof kr.onRetry?kr.onRetry(r,t):r},Wt=function(r){!function(r){var t,e=Ar();if(e&&r.errorUrl){var n=rr(kr.projectNames),i=rr((r.retryUrls||[]).map((function(r){return br(r)}))),o={onload:Wr._pageLoaded,sdk_version:h,error_id:r.errorId,error_node_name:r.nodeName,htmlId:Lr,onLine:String(navigator.onLine),env:null===(t=kr.radarSeedConfig)||void 0===t?void 0:t.env,pid:n,retry_domains:i,bu:kr.bu||"",source_type:r.hooked?"async":"sync"},a=r.extraInfo||{};a.cssRetryCaches&&(o.cssRetryCaches=a.cssRetryCaches),a.timeout_domains&&(o.is_timeout_error=!0,o.timeout_domains=a.timeout_domains);try{e({name:A,event_type:br(r.errorUrl),category:String(r.hooked),src:r.errorUrl,result_type:r.status,message:r.retryUrl||"",webview_type:n,extra_info:JSON.stringify(o)},{event_count:r.retryTimes,duration:r.startTime?Date.now()-r.startTime:0})}catch(u){}}}(r)},Bt=!1;function qt(r,t,i){try{if(window.$ksCdnLoad=St,It()){var o=typeof(u=H("__MICRO_APP_ENVIRONMENT__")&&H("rawWindow")?H("rawWindow"):e).$ksCdnProtector__micro&&u.$ksCdnProtector__micro;if(o&&"function"==typeof o)return void o(r)}if(Br(r,Bt),Bt)return;Bt=!0,e.ksCdnProtector=e.$ksCdnWebProtector,It()||(e.$ksCdnProtector__micro=e.$ksCdnWebProtector),e[C]("load",(function(){Wr._pageLoaded=!0;var r=setTimeout((function(){Ur(),hr(r)}),1e4)})),e[C]("beforeunload",(function(){Wr._pageUnload=!0})),e[C]("pagehide",(function(r){r.persisted||(Wr._pageUnload=!0)})),e[C]("pageshow",(function(r){r.persisted&&(Wr._pageUnload=!1)})),At(),t&&t.forEach((function(t){return t(r)}));var a={onSuccess:Wt,onFail:Wt,onError:Wt,onRetry:$t};Ct(a),function(r){var t=r.onSuccess,e=r.onFail,i=function(t){if(t&&!Wr._pageUnload){var n=z(t),i=B(n);if(n&&i&&(bt(n),q(n)&&Er(i)&&(!K(n)||V(n,i,kr))&&(!n.getAttribute(U)||n.getAttribute(w)))){var o=vr(i,kr.allDispatchDomains);if(o.length){n.onerror&&"function"==typeof n.onerror&&!n[T]&&(n[T]=n.onerror,n.onerror=null);var a=ht(n,!0),u=a.maxRetryCount||Tr(o);if(a.retryCache&&(a.retryCache.maxRetryCount=u),a.retryCount>=u)return yt(n,e,i,a,"fail"),void(!n.onerror&&n[T]&&"function"==typeof n[T]&&n[T].call(n,t));dt(n,r)}}}},o=function(r){if(r){var e=z(r),n=B(e);if(e&&n&&q(e)){if(bt(e),e instanceof d&&!1!==kr.iframeRetryEnable&&!1===Q(n))return i(r);var o=ht(e,!0);if(o.retryId){yt(e,t,n,o,"success"),pt(e);var a=kr.htmlCdnDispatchKey;a&&!o.asyncHooked&&qr(a,br(o.retryCache&&o.retryCache.errorUrl||""),br(n))}}}};n[C]("error",i,!0),n[C]("load",o,!0),n[C]("loadedmetadata",o,!0)}(a),et(a),i&&i.forEach((function(r){return r(a)})),function(){try{var r=kr.probeEnable,t=kr.probeInterval;if(!1===r||!t)return;gt()}catch(e){Nr("initProbeTask",e)}}()}catch(c){Nr("initCdnProtector",c)}var u}function Jt(t){try{if("function"!=typeof e.fetch)return;var n=e.fetch;e.fetch=function(e,i){try{var o=Kt(e);if(!Er(o,!0))return n(e,i);var a=vr(o,kr.allDispatchDomains);if(!a.length)return n(e,i);var u=Tr(a),c={retryId:"",retryUrls:[],retryTimes:0,errorUrl:""},f=function(){return c.retryTimes>=u},s={fail:t.onFail,error:t.onError,success:t.onSuccess},l=function(r,t){var e=s[r];c.retryId&&e&&"function"==typeof e&&(e({status:r,hooked:!0,nodeName:"api-fetch",errorId:c.retryId,errorUrl:c.errorUrl||"",retryUrl:t||"",startTime:c.startTime,retryTimes:c.retryTimes,retryUrls:c.retryUrls}),"error"!==r&&(c.status=r))},d=function(n){0===c.retryTimes&&(c.retryId=$(),c.startTime=Date.now(),c.errorUrl=o,Pr[c.retryId]=c);var u=lt(o,c,a,t.onRetry);if(!u)return Promise.resolve({});c.retryTimes++,c.retryUrls.push(u);var f=function(t,e){try{return"string"==typeof e?t:e instanceof URL?new URL(t):e.id&&"GET"===e.method?t:r(r({},e),{url:t})}catch(n){return t}}(u,e);return n(f,i)},h=function(r,t){var e=Kt(r);return n(r,t).then((function(r){return t&&t.signal&&t.signal.aborted?r:vt(r&&r.status)?(l("success",e),r):f()?(l("fail",e),r):d(h)}))["catch"]((function(r){return"AbortError"===r.name?Promise.reject(r):f()?(l("fail",e),Promise.reject(r)):d(h)}))};return h(e,i)}catch(y){return n(e,i)}}}catch(i){}}function Kt(r){return r?"string"==typeof r?mr(r):r instanceof URL?r.href:r.url:""}var Vt="__cdn_method",zt="__cdn_url",Gt="__cdn_open_args",Xt="__cdn_request_header_args",Qt="__cdn_aborted",Yt="onreadystatechange";var Zt={};function re(r){try{e.__cdn_import__=function(t){try{if(!function(){try{return new Function('return import("")'),!0}catch(r){return!1}}())return t();var e=t.toString(),n=kr.moduleDeduplicationEnable,i="";return n&&(i=function(r){var t=te(r);if(!t)return"";var e=t.split("/").filter((function(r){return r}));return e[e.length-1]||""}(e))&&Zt[i]?Zt[i]:t()["catch"]((function(t){if(!ee(t))return Promise.reject(t);var n=function(r){if(!r||!r.message)return"";var t=r.message.match(/(https?:\/\/[^\s]+)/);return t&&t[0]||""}(t);if(n||(n=function(r){var t=te(r);if(!t)return"";if(/^https?:\/\//.test(t))return t;var e=G();if(!e||!e.length)return"";var n=ir(e,(function(r){return r.name.indexOf(t)>-1}));return n?n.name:""}(e)),!n||!Er(n,!0))return Promise.reject(t);if(!kr.asyncJsRetryEnable&&/\.js$/gi.test(n))return Promise.reject(t);var i=vr(n,kr.allDispatchDomains);return i.length?function(r,t,e){var n=Tr(t),i={retryId:"",retryUrls:[],retryTimes:0,errorUrl:""},o=function(){return i.retryTimes>=n},a={fail:e.onFail,error:e.onError,success:e.onSuccess},u=function(r,t){var e=a[r];i.retryId&&e&&"function"==typeof e&&(e({status:r,hooked:!0,nodeName:"dynamic-import",errorId:i.retryId,errorUrl:i.errorUrl||"",retryUrl:t||"",startTime:i.startTime,retryTimes:i.retryTimes,retryUrls:i.retryUrls}),"error"!==r&&(i.status=r))},c=function(n){0===i.retryTimes&&(i.retryId=$(),i.startTime=Date.now(),i.errorUrl=r,Pr[i.retryId]=i);var o=lt(r,i,t,e.onRetry);return o?(i.retryTimes++,i.retryUrls.push(o),n(o)):Promise.resolve({})},f=function(t){return function(r){return new Function("return import('".concat(r,"')"))()}(t).then((function(t){return u("success",r),t}))["catch"]((function(t){return ee(t)?o()?(u("fail",r),Promise.reject(t)):c(f):(u("success",r),Promise.reject(t))}))};return c(f)}(n,i,r):Promise.reject(t)})).then((function(r){var t=Promise.resolve(r);return n&&i&&(Zt[i]=t),t}))}catch(o){return t()}},e.__cdn_protector_import__=e.__cdn_import__}catch(t){Nr("initDynamicImport",t)}}function te(r){var t;if(!r)return"";var e=r.match(/import\(['"`](.*?)['"`]\)/);return(null===(t=null==e?void 0:e[1])||void 0===t?void 0:t.replace(/^\.\//,""))||""}function ee(r){if(!r||!r.message)return!1;var t=r.message.toLowerCase();return t.indexOf("failed to fetch")>-1||t.indexOf("error loading dynamically")>-1||t.indexOf("importing a module script failed")>-1}return function(r){return qt(r,[],t(t([],!1!==r.ajaxRetryEnable?[function(r){return Jt(r)},function(r){return function(r){try{var n=e.XMLHttpRequest.prototype,i=n.open,o=n.send,a=n.abort,u=n.setRequestHeader;n.open=function(r,e){for(var n=[],o=2;o<arguments.length;o++)n[o-2]=arguments[o];var a=this,u=mr(e);Er(u,!0)&&!a.__cdn_ignore&&(a[Vt]=r,a[zt]=u,a[Gt]=n),i.apply(a,t([r,e],n,!0))},n.setRequestHeader=function(r,t){var e=this;return e[zt]&&(e[Xt]=e[Xt]||{},e[Xt][r]=t),u.apply(e,[r,t])},n.abort=function(){var r=this;r[zt]&&(r[Qt]=!0),a.apply(r,[])},n.send=function(){for(var e,n=[],a=0;a<arguments.length;a++)n[a]=arguments[a];var c=this,f=c[zt];if(!f)return o.apply(c,n);var s=((e={onerror:c.onerror})[Yt]=c[Yt],e),l=function(r,t){var e=s[r];e&&"function"==typeof e&&e.call(c,t)},d=vr(f,kr.allDispatchDomains),h=Tr(d),y={retryId:"",retryUrls:[],retryTimes:0,errorUrl:""};c.__cdn_retry_info=y;var v=function(){return(y&&y.retryTimes||0)>=h},p={fail:r.onFail,error:r.onError,success:r.onSuccess},m=function(r,t){var e=p[r];y.retryId&&e&&"function"==typeof e&&(e({status:r,hooked:!0,nodeName:"api-xhr",errorId:y.retryId,errorUrl:y.errorUrl||"",retryUrl:t||"",startTime:y.startTime,retryTimes:y.retryTimes||0,retryUrls:y.retryUrls}),"error"!==r&&(y.status=r))},g=function(){y&&0===y.retryTimes&&(y.retryId=$(),y.startTime=Date.now(),y.errorUrl=f,Pr[y.retryId]=y);var e=lt(f,y,d,r.onRetry);if(e){y.retryTimes++,y.retryUrls.push(e),i.apply(c,t([c[Vt],e],c[Gt]||[],!0));var a=c[Xt]||{};Object.keys(a).forEach((function(r){u.apply(c,[r,a[r]])})),o.apply(c,n)}};c.onerror=function(r){return v()?(m("fail",f),l("onerror",r)):g()},c[Yt]=function(r){return c.readyState!==XMLHttpRequest.DONE||c[Qt]?l(Yt,r):vt(c.status)?(m("success",f),l(Yt,r)):c.status>0?v()?(m("fail",f),l(Yt,r)):g():void 0},o.apply(c,n)}}catch(c){}}(r)}]:[],!0),r.dynamicImportRetryEnable?[function(r){return re(r)}]:[],!0))}}));
90
+ window.$ksCdnWebProtector({dispatchDomains:[{"v":"v1-kling+klingai+com","cs":"1","type":2,"valid":1,"c_id":1},{"v":"v2-kling+kechuangai+com","cs":"2","type":2,"valid":1,"c_id":1,"p":[0,499]},{"v":"v1-kling+kechuangai+com","cs":"1","type":2,"valid":1,"c_id":1},{"v":"v2-kling+klingai+com","cs":"2","type":2,"valid":1,"c_id":1},{"v":"v4-kling+klingai+com","cs":"4","type":2,"valid":1,"c_id":1},{"v":"v4-kling+kechuangai+com","cs":"4","type":2,"valid":1,"c_id":1,"p":[500,999]},{"v":"p1-kling+klingai+com","cs":"1","type":3,"valid":1,"c_id":1},{"v":"p4-kling+klingai+com","cs":"4","type":3,"valid":1,"c_id":1,"p":[500,999]},{"v":"p2-kling+klingai+com","cs":"2","type":3,"valid":1,"c_id":1,"p":[0,499]},{"v":"p2-kling+kechuangai+com","cs":"2","type":3,"valid":0,"c_id":1},{"v":"p4-kling+kechuangai+com","cs":"4","type":3,"valid":0,"c_id":1},{"v":"p1-kling+kechuangai+com","cs":"1","type":3,"valid":0,"c_id":1},{"v":"s15-kling+klingai+com","cs":"15","type":1,"valid":1,"c_id":2},{"v":"s17-kling+klingai+com","cs":"13","type":1,"valid":1,"c_id":2},{"v":"s16-kling+klingai+com","cs":"16","type":1,"valid":1,"c_id":2},{"v":"v17-kling+klingai+com","cs":"13","type":2,"valid":1,"c_id":2},{"v":"v16-kling+klingai+com","cs":"16","type":2,"valid":1,"c_id":2},{"v":"v15-kling+klingai+com","cs":"15","type":2,"valid":1,"c_id":2},{"v":"d15-kling+klingai+com","cs":"15","type":5,"valid":1,"c_id":2},{"v":"d17-kling+klingai+com","cs":"13","type":5,"valid":1,"c_id":2},{"v":"d16-kling+klingai+com","cs":"16","type":5,"valid":1,"c_id":2}],bu:"kling",projectNames:["kling-server-sgp","kling-web"],radarSeedEnable:false,enableScriptPlaceholderReplace:true,dynamicImportRetryEnable:true,domains:["*.wsukwai.com","*.wsbkwai.com","*.wskwai.com","*.ndcjl.com","*.gskwai.com","*.kskwai.com","*.a.kwimgs.com","*.a.yximgs.com","*.adkwai.com","*.adbkwai.com","*.adukwai.com","*.eckwai.com","*.beckwai.com","*.becukwai.com","*.ecukwai.com","*.shbkwai.com","*.shukwai.com","*.shwkwai.com","*.paykwai.com","*.bpaykwai.com","*.tzgamepkg.com","*.btzgamepkg.com","h*.static.yximgs.com","*.kwimgs.com","*.ssrcdn.com","cdn*.klingai.com","static*.yximgs.com"],dispatchPlaceholder:"s15-kling.klingai.com"});} catch (e) { console.error('[cdn-web-protector-sdk] init error: ', e);}</script>
91
+
92
+ <script>/**radarProjectId: '7e322471ee',**/</script>
93
+ <title>KlingAI Open Platform</title>
94
+ <style>
95
+ .kling-seo-h1 {
96
+ position: absolute;
97
+ width: 1px;
98
+ height: 1px;
99
+ padding: 0;
100
+ margin: -1px;
101
+ overflow: hidden;
102
+ clip: rect(0, 0, 0, 0);
103
+ white-space: nowrap;
104
+ border: 0;
105
+ }
106
+ </style>
107
+ <script>
108
+ ; (function () {
109
+ var pathname = window.location.pathname
110
+ var normalizedPath = pathname
111
+ if (normalizedPath !== '/' && normalizedPath.endsWith('/')) {
112
+ normalizedPath = normalizedPath.slice(0, -1)
113
+ }
114
+ var canonicalUrl = window.location.origin.replace(/\/+$/, '') + normalizedPath
115
+ var link = document.getElementById('kling-canonical')
116
+ if (!link) {
117
+ link = document.querySelector("link[rel='canonical']")
118
+ }
119
+ if (link) {
120
+ link.href = canonicalUrl.split('?')[0].split('#')[0]
121
+ } else {
122
+ link = document.createElement('link')
123
+ link.id = 'kling-canonical'
124
+ link.rel = 'canonical'
125
+ link.href = canonicalUrl.split('?')[0].split('#')[0]
126
+ document.head.appendChild(link)
127
+ }
128
+
129
+ function toTitleText(segment) {
130
+ return segment
131
+ .split(/[-_]+/)
132
+ .filter(Boolean)
133
+ .map(function (word) {
134
+ var lower = word.toLowerCase()
135
+ if (lower === 'api' || lower === 'ai') {
136
+ return word.toUpperCase()
137
+ }
138
+ return word.charAt(0).toUpperCase() + word.slice(1)
139
+ })
140
+ .join(' ')
141
+ }
142
+
143
+ function truncateDescription(description) {
144
+ var normalized = description.replace(/\s+/g, ' ').trim()
145
+ if (normalized.length <= 160) {
146
+ return normalized
147
+ }
148
+ var truncated = normalized.slice(0, 159)
149
+ var lastSpaceIndex = truncated.lastIndexOf(' ')
150
+ var text = lastSpaceIndex >= 120 ? truncated.slice(0, lastSpaceIndex) : truncated.replace(/\s+$/, '')
151
+ return text + '…'
152
+ }
153
+
154
+ function buildDescription(pathname) {
155
+ var normalizedPath = (pathname || '/document-api').split('?')[0].split('#')[0]
156
+ if (normalizedPath !== '/' && normalizedPath.endsWith('/')) {
157
+ normalizedPath = normalizedPath.slice(0, -1)
158
+ }
159
+ var parts = normalizedPath
160
+ .replace(/^\/+/, '')
161
+ .split('/')
162
+ .filter(function (part) {
163
+ return part && part !== 'document-api' && part !== 'new' && part !== 'edit'
164
+ })
165
+ .map(toTitleText)
166
+ var pageName = parts.length ? parts.join(' ') : 'Kling AI API Documentation'
167
+ return truncateDescription(
168
+ 'Read the ' +
169
+ pageName +
170
+ ' documentation for Kling AI APIs. Learn request parameters, response formats, usage notes, and integration guidance for AI video and image generation.'
171
+ )
172
+ }
173
+
174
+ var metaDescription = document.querySelector("meta[name='description']")
175
+ if (metaDescription) {
176
+ metaDescription.setAttribute('content', buildDescription(window.location.pathname))
177
+ }
178
+
179
+ function setMeta(selector, attrs, content) {
180
+ var meta = document.querySelector(selector)
181
+ if (!meta) {
182
+ meta = document.createElement('meta')
183
+ Object.keys(attrs).forEach(function (key) {
184
+ meta.setAttribute(key, attrs[key])
185
+ })
186
+ document.head.appendChild(meta)
187
+ }
188
+ meta.setAttribute('content', content)
189
+ }
190
+
191
+ function buildTitle(pathname) {
192
+ var normalizedPath = (pathname || '/document-api').split('?')[0].split('#')[0]
193
+ if (normalizedPath !== '/' && normalizedPath.endsWith('/')) {
194
+ normalizedPath = normalizedPath.slice(0, -1)
195
+ }
196
+ var parts = normalizedPath
197
+ .replace(/^\/+/, '')
198
+ .split('/')
199
+ .filter(function (part) {
200
+ return part && part !== 'document-api' && part !== 'new' && part !== 'edit'
201
+ })
202
+ .map(toTitleText)
203
+ return parts.length ? 'Kling AI API ' + parts.join(' ') : 'Kling AI API Documentation'
204
+ }
205
+
206
+ function setBreadcrumbJsonLd(pathname, pageName) {
207
+ var origin = window.location.origin.replace(/\/+$/, '')
208
+ var pageUrl = origin + pathname
209
+ var itemListElement = [
210
+ {
211
+ '@type': 'ListItem',
212
+ position: 1,
213
+ name: 'Kling AI',
214
+ item: origin
215
+ },
216
+ {
217
+ '@type': 'ListItem',
218
+ position: 2,
219
+ name: 'API Documentation',
220
+ item: origin + '/document-api'
221
+ }
222
+ ]
223
+ if (pathname !== '/document-api') {
224
+ itemListElement.push({
225
+ '@type': 'ListItem',
226
+ position: 3,
227
+ name: pageName,
228
+ item: pageUrl
229
+ })
230
+ }
231
+ var script = document.getElementById('kling-breadcrumb-jsonld')
232
+ if (!script) {
233
+ script = document.createElement('script')
234
+ script.id = 'kling-breadcrumb-jsonld'
235
+ script.type = 'application/ld+json'
236
+ document.head.appendChild(script)
237
+ }
238
+ script.textContent = JSON.stringify({
239
+ '@context': 'https://schema.org',
240
+ '@type': 'BreadcrumbList',
241
+ '@id': pageUrl + '#breadcrumb',
242
+ itemListElement: itemListElement
243
+ })
244
+ }
245
+
246
+ var ogTitle = buildTitle(window.location.pathname)
247
+ var ogDescription = buildDescription(window.location.pathname)
248
+ var ogImage = 'https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/api-doc-share-global.593144c83f836151.png'
249
+ setMeta('meta[property="og:type"]', { property: 'og:type' }, 'website')
250
+ setMeta('meta[property="og:title"]', { property: 'og:title' }, ogTitle)
251
+ setMeta('meta[property="og:description"]', { property: 'og:description' }, ogDescription)
252
+ setMeta('meta[property="og:image"]', { property: 'og:image' }, ogImage)
253
+ setMeta('meta[property="og:url"]', { property: 'og:url' }, canonicalUrl)
254
+ setMeta('meta[name="twitter:card"]', { name: 'twitter:card' }, 'summary_large_image')
255
+ setMeta('meta[name="twitter:title"]', { name: 'twitter:title' }, ogTitle)
256
+ setMeta('meta[name="twitter:description"]', { name: 'twitter:description' }, ogDescription)
257
+ setMeta('meta[name="twitter:image"]', { name: 'twitter:image' }, ogImage)
258
+ setBreadcrumbJsonLd(normalizedPath, ogTitle)
259
+ })()
260
+ </script>
261
+ <script type="module" crossorigin="" src="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/index-BUk-9oHK.js"></script>
262
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/_virtual___federation_fn_import-D5NhmJMM.js">
263
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/shared.esm-bundler-DyIL8o4h.js">
264
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/base-BjuJHDsa.js">
265
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/engine-BKNGw4Jt.js">
266
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/index-CZ4BIwcX.js">
267
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/meta-DhIF0LNa.js">
268
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/cdn-prefix-C6SQkIps.js">
269
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/_plugin-vue_export-helper-BCo6x5W8.js">
270
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/Loading-6SSUPM4h.js">
271
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/runtime-core.esm-bundler-BCOsEVSG.js">
272
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/index-CgWjbxT8.js">
273
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/translate-BQzjg4II.js">
274
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/use-global-config-6duuvAIo.js">
275
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/toast-DuMUtY9E.js">
276
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/request-BntdBmd5.js">
277
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/user-store-uMoNLzqU.js">
278
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/refs-B4hMQ3I3.js">
279
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/event-BwRzfsZt.js">
280
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/el-dialog-MLQ6V80y.js">
281
+ <link rel="modulepreload" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/use-open-lead-capture-zmLNmk1A.js">
282
+ <link rel="stylesheet" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/base-BhyKBIh7.css">
283
+ <link rel="stylesheet" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/Loading-B9kb9SLG.css">
284
+ <link rel="stylesheet" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/toast-Bar0QGgD.css">
285
+ <link rel="stylesheet" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/el-dialog-TSZfE1b8.css">
286
+ <link rel="stylesheet" crossorigin="" href="https://s15-kling.klingai.com/kos/s101/nlav112918/api-doc/assets/index-tiHoJ-QD.css">
287
+ <script>window["__KLING_I18N_KCONF_SLOT__"]="test";window["__KLING_I18N_JSON_HASH__"]="bd0033b75779b425";</script>
288
+ <script crossorigin="anonymous" async="" src="https://www.googletagmanager.com/gtag/js?id=GT-M6PJCH2S"></script>
289
+ <script>window.dataLayer = window.dataLayer || [];
290
+ window.__GA4_ANALYTICS_INSTALLED_IDS__ = window.__GA4_ANALYTICS_INSTALLED_IDS__ || {};
291
+ window.__GA4_ANALYTICS_INSTALLED_IDS__['GT-M6PJCH2S'] = true;
292
+ window.gtag = window.gtag || function(){window.dataLayer.push(arguments);};
293
+ window.gtag('js', new Date());
294
+ window.gtag('config', 'GT-M6PJCH2S', {
295
+ send_page_view: true,
296
+ region: 'global',
297
+ domain_type: 'global'
298
+ });</script>
299
+ <script>;window.__TERRITORY__ = "global";window.cdn_public_path = "https://s15-kling.klingai.com"; window.cdn_public_path_video = "https://v15-kling.klingai.com";</script>
300
+ </head>
301
+
302
+ <body class="light"><script>!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).ksBlankScreenDetector={})}(this,(function(e){"use strict";var t,n,r="blank_screen",o="one_second_".concat(r),i="two_second_".concat(r),a="three_second_".concat(r),c=["HTML","BODY"],s="0.0.24",d="".concat(r,"_other"),l=["IFRAME"],m="data-ignore-blank-detect",u=["visibilitychange","pagehide","beforeunload","unload"],p=function(e){return!!e&&(e.hasAttribute(m)&&"false"!=e.getAttribute(m))},f=function(e){if(!e)return"";return-1!==l.indexOf(e.nodeName)?e.nodeName:e.id?"#".concat(e.id):e.className&&"string"==typeof e.className?"."+e.className.split(" ").filter((function(e){return!!e})).join("."):e.nodeName||""},g=function(e){for(var t=0,n=[],r=[],o=e.singleDirectionSamplePoints||9,i=o+1,a=o,c=window.innerWidth,s=window.innerHeight,d=function(o){var d=function(){performance.now();var d=c*o/i,l=s*o/i,m=document.elementsFromPoint(d,s/2),u=[];if(u.push(m),o!==i/2){var g=document.elementsFromPoint(c/2,l),v=document.elementsFromPoint(d,l),T=document.elementsFromPoint(d,s-l);u.push(g,v,T)}u.forEach((function(o){var i=function(e){var t=e.element,n=e.containers,r=e.ignoreContainers,o=f(t),i=!1;return n.indexOf(o)>=0&&-1===(r||[]).indexOf(o)&&!p(t)&&(i=!0),{checkRes:i,serializeElement:o}}({element:o[0],containers:e.containers,ignoreContainers:e.ignoreContainers}),a=i.checkRes,c=i.serializeElement;a&&t++,n.push(o),r.push(c)})),--a||e.getSamplePointsCb({emptyPoints:t,samplePoints:n,sampleSerializePoints:r})};if(e.sync)d();else{var l=0+16.6*(o-1);window.setTimeout(d,l)}},l=1;l<=o;l++)d(l)},v=function(e){var t=performance.now(),n=(e.ignoreContainers||[]).concat(l);g({containers:c.concat(e.containers||[]),singleDirectionSamplePoints:e.singleDirectionSamplePoints,getSamplePointsCb:function(r){var o=r.emptyPoints,i=r.samplePoints,a=r.sampleSerializePoints,c=!e.closeSameElesCheck&&function(e){for(var t,n,r,o,i=e.elements,a=e.paramPercentThreshold,c=e.ignoreContainers,s={},d=0,l=void 0,m=function(e){s[e].length>d&&(d=s[e].length,l=e)},u=0;u<i.length;u++){var g=i[u],v=!1;if(g&&g.length)for(var T in s){for(var _=!0,S=0;S<5;S++)if(s[T][0][S]!==g[S]){_=!1;break}if(_){s[T].push(g),v=!0,m(T);break}}v||(s[String(u)]=[g],m(String(u)))}var b=0;if(l){var h=f(null===(n=null===(t=s[l])||void 0===t?void 0:t[0])||void 0===n?void 0:n[0]);-1!==(c||[]).indexOf(h)||p(null===(o=null===(r=s[l])||void 0===r?void 0:r[0])||void 0===o?void 0:o[0])||(b=d)}return b&&b/i.length>(a||.8)}({elements:i,paramPercentThreshold:e.sameElementsPercent,ignoreContainers:n}),s=o/i.length>(e.emptyElementsPercent||.8),d=c||s;e.detectCb({blank:d,detectCostTime:performance.now()-t,sampleSerializePoints:a})},sync:e.sync,ignoreContainers:n})},T=(t=!1,n=0,window.addEventListener("load",(function(){n=performance.now(),t=!0}),!0),function(){return{isOnload:t,onloadTime:n}}),_=function(){return!!window.__radarSeedFunc__},S=function(){for(var e=arguments,t=e[0],n=1;n<e.length;n++){var r=e[n];if(r)for(var o in r)t[o]=r[o]}return t},b=function(e,t,n){return void 0===n&&(n={}),(Object.assign||S)({},e,t,n)},h="__yodaBridge__",y="tool",k="__ks_blank_detector_canuse_cb__",w=window,C=!1,D=function(){return C};function E(e){if(D()){var t=e.detectTriggerType;w[h]&&w[h].invoke&&"function"==typeof w[h].invoke&&function(e,t){w[k]=function(e){t(e),w[k]=null};try{w[h].invokeCallback(y,"canIUse",JSON.stringify(e),k)}catch(e){w[k]()}}({namespace:"tool",name:"whiteScreenCheck"},(function(n){n&&1===n.result&&n.canUse&&w[h].invoke("tool","whiteScreenCheck",JSON.stringify({delayMs:0,reportMsg:{url:location.href,detectTriggerType:t,invokeId:e.invokeId||""},needImgUpload:!0,checkTime:"bridge"}),"")}))}}var O=function(){return"visible"===document.visibilityState},P=!1,N=function(e){var t=T(),n=t.isOnload,o=t.onloadTime,i={name:e.radarEventName||r,result_type:e.result_type,message:n?"isOnload":"",extra_info:{url:location.href,isOnload:n,onloadTime:o,sdk_version:s,page_load_duration:performance.now(),detect_trigger_type:e.detectTriggerType,detect_cost_time:e.detectCostTime,sample_serialize_points:e.sampleSerializePoints,invokeId:e.invokeId}};return 1===e.result_type&&(i.extra_info.blank_screen_time=e.blankScreenTime,i.extra_info.error_extra=e.errorGroup),i},G=function(e){e.logImmediate&&window.__radarSeedStore__&&!window.__radarSeedStore__.immediate&&window.__radarSeedStore__.flush()},I=function(e){if(_()){var t=N(b(e,{result_type:1}));window.__radarSeedFunc__.event(t),G({logImmediate:e.logImmediate})}},x=function(e){if(_()){var t=N(b(e,{result_type:0}));window.__radarSeedFunc__.event(t),G({logImmediate:e.logImmediate})}},z=function(e){_()&&window.__radarSeedFunc__.event({name:d,result_type:"info",extra_info:{url:location.href,sdk_version:s,message:e.message}})};P=function(){try{var e=window.__yodaCommonDataObject__.sampleData,t="string"==typeof e?JSON.parse(e):e;if(t){if(t.extra&&void 0!==t.extra.blank){var n=Math.random();return!!t.isHit&&n<=t.extra.blank}return!!t.isHit}return!0}catch(e){return!0}}();var H={debounceDuration:1500,errorGroup:[],apiErrorGroup:[],blankScreen:!0,blankScreenTime:0,detectOptions:{close123SDetect:!0,close1SDetect:!0,close2SDetect:!0,close3SDetect:!0}},F=function(){H.errorGroup=[],H.apiErrorGroup=[]},L=function(e){H[e]&&clearTimeout(H[e]),H[e]=0},M=function(e){void 0===e&&(e={});var t,n=e.options||H.detectOptions||{};return!O()||!P||(t=!0,window.MutationObserver||(t=!1,z({message:"不支持MutationObserver"})),document.elementsFromPoint||(t=!1,z({message:"不支持elementsFromPoint"})),!t)||n.doNotDetect},R=function(e){var t=e.blank,n=e.detectCostTime,r=e.sampleSerializePoints,o=e.pageUnloadTrigger;if(t){var i=H.errorGroup,a=H.apiErrorGroup;if(!H.blankScreen||(o||function(e){var t=e.errorGroup,n=void 0===t?[]:t,r=e.apiErrorGroup,o=void 0===r?[]:r;return!!n.length||!!o.length}({errorGroup:i,apiErrorGroup:a})||T().isOnload)&&!H.hasLogBlankScreen){var c=Date.now();I({blankScreenTime:H.blankScreenTime,detectTriggerType:H.detectTriggerType,errorGroup:H.errorGroup,detectCostTime:n,apiErrorGroup:H.apiErrorGroup,sampleSerializePoints:r,logImmediate:!0,invokeId:c}),-1===u.indexOf(H.detectTriggerType)&&E({detectTriggerType:H.detectTriggerType,invokeId:c}),H.hasLogBlankScreen=!0,F()}H.blankScreen=!0}else H.blankScreen&&(H.pageHasRenderContent||H.hasLogBlankScreen)&&x({detectCostTime:n,detectTriggerType:H.detectTriggerType,sampleSerializePoints:r,logImmediate:!0}),H.blankScreen=!1,H.pageHasRenderContent=!0},B=function(e){H.detecting||(L("detectTimer"),H.blankScreenTime=Date.now(),H.detectTimer=window.setTimeout((function(){if(O()){!function(){H.detecting=!0;v(b(e,{detectCb:function(e){R(e),H.detectTimer=0,H.detecting=!1}}))}()}}),H.debounceDuration))};e.blankStore=H,e.clearDetectTimer=L,e.createDetectTimer=B,e.detectForApiHook=function(e){M()||(H.apiErrorGroup.push({url:e?e.url:"",code:e?e.code:""}),B(H.detectOptions))},e.resetCollectData=F,e.startBlankScreenDetect=function(e){if(void 0===e&&(e={}),!M({options:e})&&!H.hasStartDetecting){var t;t=e.yodaBridgeSampleRate||1,C=Math.random()<=t,H.debounceDuration=e.debounceDuration||1500,H.detectOptions=b(H.detectOptions,e||{}),["error","unhandledrejection"].forEach((function(e){window.addEventListener(e,(function(e){!function(e){if(O()){try{var t=e.event,n=t.reason,r=t.error||(n&&n.message?n:void 0),o=r&&r.message||t.message||t.reason;H.errorGroup.push({name:r&&r.name||t.name,message:o})}catch(e){}B(H.detectOptions)}}({event:e})}),!0)}));var n=function(e){if(!H.pageUnloadHasHandled){H.pageUnloadHasHandled=!0,H.detectTriggerType=e.detectTriggerType,H.blankScreenTime=Date.now();(H.detectTimer||H.blankScreen)&&(H.detectTimer&&L("detectTimer"),v(b(H.detectOptions,{detectCb:function(e){R(b(e,{pageUnloadTrigger:!0}))},sync:!0}))),L(o),L(i),L(a)}};window.addEventListener(u[0],(function(){"visible"===document.visibilityState?(H.pageUnloadHasHandled=!1,H.detectTriggerType="".concat(u[0],"-visible"),B(H.detectOptions)):n({detectTriggerType:u[0]})}),!0),[u[1],u[2],u[3]].forEach((function(e){window.addEventListener(e,(function(){n({detectTriggerType:e})}),!0)})),new MutationObserver((function(t){!O()||e.ignoreElesWhenDomChange&&e.ignoreElesWhenDomChange.length&&!t.some((function(t){return-1===e.ignoreElesWhenDomChange.indexOf(f(t.target))}))||(H.detectTriggerType="mutationObserver",B(H.detectOptions))})).observe(document.body,{childList:!0,subtree:!0}),H.detectOptions.close123SDetect||function(e){var t=function(e){var t=e.detectRes,n=e.detectTriggerType,r=e.blankScreenTime,o=e.radarEventName,i=t.blank,a=t.detectCostTime,c=t.sampleSerializePoints;i?I({radarEventName:o,blankScreenTime:r,detectTriggerType:n,errorGroup:H.errorGroup,detectCostTime:a,apiErrorGroup:H.apiErrorGroup,sampleSerializePoints:c,logImmediate:!0}):x({radarEventName:o,detectCostTime:a,detectTriggerType:n,sampleSerializePoints:c,logImmediate:!0})},n=performance.now();[{timerName:o,close:e.close1SDetect,second:1e3},{timerName:i,close:e.close2SDetect,second:2e3},{timerName:a,close:e.close3SDetect,second:3e3,detectCb:"threeSecondCb"}].concat(e.customSecondsDetect||[]).forEach((function(r,o){if(!r.close&&O()){var i=function(t){r.detectCb&&("function"==typeof r.detectCb?r.detectCb(t):"function"==typeof e[r.detectCb]&&e[r.detectCb](t))},c=r.second-n;if(c>=0)H[r.timerName]=window.setTimeout((function(){if(O()){var e=Date.now();v(b(H.detectOptions,{detectCb:function(n){t({detectRes:n,detectTriggerType:r.timerName,blankScreenTime:e,radarEventName:r.timerName}),H[r.timerName]=0,i(n)}})),r.timerName===a&&E({detectTriggerType:a})}}),c);else if("htmlEnd"!==e.insertHTMLPos){var s={blank:!0,detectCostTime:0,sampleSerializePoints:[]};t({detectRes:s,detectTriggerType:r.timerName,blankScreenTime:Date.now(),radarEventName:r.timerName}),i(s)}}}))}(H.detectOptions),H.hasStartDetecting=!0}}})); window.ksBlankScreenDetector.startBlankScreenDetect({"containers":["#app"],"emptyElementsPercent":0.9,"sameElementsPercent":0.9,"ignoreContainers":["CANVAS","VIDEO"]});</script>
303
+ <h1 id="kling-seo-h1" class="kling-seo-h1">KlingAI Open Platform</h1>
304
+ <script>
305
+ ; (function () {
306
+ function toTitleText(segment) {
307
+ return segment
308
+ .split(/[-_]+/)
309
+ .filter(Boolean)
310
+ .map(function (word) {
311
+ if (word.toLowerCase() === 'api' || word.toLowerCase() === 'ai') {
312
+ return word.toUpperCase()
313
+ }
314
+ return word.charAt(0).toUpperCase() + word.slice(1)
315
+ })
316
+ .join(' ')
317
+ }
318
+
319
+ function buildSeoH1(pathname) {
320
+ var normalizedPath = (pathname || '/document-api').split('?')[0].split('#')[0]
321
+ if (normalizedPath !== '/' && normalizedPath.endsWith('/')) {
322
+ normalizedPath = normalizedPath.slice(0, -1)
323
+ }
324
+
325
+ var parts = normalizedPath
326
+ .replace(/^\/+/, '')
327
+ .split('/')
328
+ .filter(function (part) {
329
+ return part && part !== 'document-api' && part !== 'new' && part !== 'edit'
330
+ })
331
+ .map(toTitleText)
332
+
333
+ return parts.length ? 'Kling AI API ' + parts.join(' ') : 'Kling AI API Documentation'
334
+ }
335
+
336
+ function updateSeoH1() {
337
+ var heading = document.getElementById('kling-seo-h1')
338
+ if (heading) {
339
+ heading.textContent = buildSeoH1(window.location.pathname)
340
+ }
341
+ }
342
+
343
+ updateSeoH1()
344
+
345
+ var rawPushState = window.history.pushState
346
+ var rawReplaceState = window.history.replaceState
347
+ window.history.pushState = function () {
348
+ rawPushState.apply(this, arguments)
349
+ updateSeoH1()
350
+ }
351
+ window.history.replaceState = function () {
352
+ rawReplaceState.apply(this, arguments)
353
+ updateSeoH1()
354
+ }
355
+ window.addEventListener('popstate', updateSeoH1)
356
+ })()
357
+ </script>
358
+ <div id="app"></div>
359
+ <script>
360
+ // :::[gundam index-html-script]:::
361
+ </script>
362
+
363
+
364
+ </body></html>
pipeline/provider_docs/kling__rendered_text.txt ADDED
@@ -0,0 +1 @@
 
 
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 <<<object_1>>> 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 <<<image_1>>>\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 <<element_1>> based on the style of the reference image <<image_1>>\",\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"
pipeline/provider_docs/luma__docs.agents.lumalabs.ai_api_resources_generations_methods_create_index.md ADDED
@@ -0,0 +1,677 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ## Create a generation
2
+
3
+ **post** `/generations`
4
+
5
+ Submit an image or video generation job. Returns immediately with an opaque job ID to poll via GET /generations/{id}.
6
+
7
+ ### Body Parameters
8
+
9
+ - `prompt: string`
10
+
11
+ Text prompt
12
+
13
+ - `aspect_ratio: optional "3:1" or "2:1" or "21:9" or 10 more`
14
+
15
+ Output aspect ratio. Valid values depend on the selected model and generation type; the server validates the final model-specific set.
16
+
17
+ - `"3:1"`
18
+
19
+ - `"2:1"`
20
+
21
+ - `"21:9"`
22
+
23
+ - `"16:9"`
24
+
25
+ - `"4:3"`
26
+
27
+ - `"3:2"`
28
+
29
+ - `"1:1"`
30
+
31
+ - `"4:5"`
32
+
33
+ - `"3:4"`
34
+
35
+ - `"2:3"`
36
+
37
+ - `"9:16"`
38
+
39
+ - `"1:2"`
40
+
41
+ - `"1:3"`
42
+
43
+ - `image_ref: optional array of ImageRef`
44
+
45
+ Reference images for style/content guidance. Up to 9 for type 'image', up to 8 for type 'image_edit'.
46
+
47
+ - `data: optional string`
48
+
49
+ Base64-encoded image or video data
50
+
51
+ - `file_id: optional string`
52
+
53
+ 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.
54
+
55
+ - `generation_id: optional string`
56
+
57
+ 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.
58
+
59
+ - `media_type: optional string`
60
+
61
+ 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.
62
+
63
+ - `url: optional string`
64
+
65
+ Publicly accessible image URL, or a video URL when used as source for video_edit/video_reframe with media_type=video/*.
66
+
67
+ - `layering: optional object { resolution }`
68
+
69
+ 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.
70
+
71
+ - `resolution: optional "1k" or "2k"`
72
+
73
+ 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.
74
+
75
+ - `"1k"`
76
+
77
+ - `"2k"`
78
+
79
+ - `model: optional Model`
80
+
81
+ 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.
82
+
83
+ - `"uni-1"`
84
+
85
+ - `"uni-1-max"`
86
+
87
+ - `"ray-3.2"`
88
+
89
+ - `output_format: optional "png" or "jpeg"`
90
+
91
+ Output image format
92
+
93
+ - `"png"`
94
+
95
+ - `"jpeg"`
96
+
97
+ - `source: optional ImageRef`
98
+
99
+ 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.
100
+
101
+ - `data: optional string`
102
+
103
+ Base64-encoded image or video data
104
+
105
+ - `file_id: optional string`
106
+
107
+ 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.
108
+
109
+ - `generation_id: optional string`
110
+
111
+ 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.
112
+
113
+ - `media_type: optional string`
114
+
115
+ 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.
116
+
117
+ - `url: optional string`
118
+
119
+ Publicly accessible image URL, or a video URL when used as source for video_edit/video_reframe with media_type=video/*.
120
+
121
+ - `style: optional "auto" or "manga"`
122
+
123
+ Style preset (auto, manga)
124
+
125
+ - `"auto"`
126
+
127
+ - `"manga"`
128
+
129
+ - `type: optional "image" or "image_edit" or "video" or 3 more`
130
+
131
+ The kind of generation to perform
132
+
133
+ - `"image"`
134
+
135
+ - `"image_edit"`
136
+
137
+ - `"video"`
138
+
139
+ - `"video_edit"`
140
+
141
+ - `"video_reframe"`
142
+
143
+ - `"layering"`
144
+
145
+ - `user_id: optional string`
146
+
147
+ 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.
148
+
149
+ - `video: optional VideoOptions`
150
+
151
+ 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`.
152
+
153
+ - `duration: optional VideoDuration`
154
+
155
+ Video duration
156
+
157
+ - `"5s"`
158
+
159
+ - `"10s"`
160
+
161
+ - `edit: optional VideoEditOptions`
162
+
163
+ 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.
164
+
165
+ - `auto_controls: optional boolean`
166
+
167
+ When true, the model derives the control schedule from the source video. When omitted, supplying strength or controls implies manual mode.
168
+
169
+ - `controls: optional AdvancedControls`
170
+
171
+ Per-signal manual conditioning controls for video edits
172
+
173
+ - `depth: optional DepthControl`
174
+
175
+ Depth / scene-geometry conditioning control
176
+
177
+ - `blur: optional number`
178
+
179
+ Depth-map blur amount from 0 to 1. Higher values allow more geometric freedom.
180
+
181
+ - `enabled: optional boolean`
182
+
183
+ Enable or disable depth conditioning. Omit to use the model default.
184
+
185
+ - `face: optional FaceControl`
186
+
187
+ Face-identity conditioning control
188
+
189
+ - `enabled: optional boolean`
190
+
191
+ Enable or disable face conditioning. Omit to use the model default.
192
+
193
+ - `normals: optional NormalsControl`
194
+
195
+ Surface-normals conditioning control
196
+
197
+ - `augmentation: optional number`
198
+
199
+ Surface-normals augmentation from 0 to 1. Higher values allow more reinterpretation of surface geometry.
200
+
201
+ - `enabled: optional boolean`
202
+
203
+ Enable or disable normals conditioning. Omit to use the model default.
204
+
205
+ - `pose: optional PoseControl`
206
+
207
+ Pose / skeleton conditioning control
208
+
209
+ - `enabled: optional boolean`
210
+
211
+ Enable or disable pose conditioning. Omit to use the model default.
212
+
213
+ - `strength: optional PoseControlStrength`
214
+
215
+ Pose-conditioning strength
216
+
217
+ - `"precise"`
218
+
219
+ - `"coarse"`
220
+
221
+ - `trajectory: optional TrajectoryControl`
222
+
223
+ Motion-trajectory conditioning control
224
+
225
+ - `enabled: optional boolean`
226
+
227
+ Enable or disable trajectory conditioning. Omit to use the model default.
228
+
229
+ - `sparsity: optional number`
230
+
231
+ Point-trajectory sparsity from 0 to 1. Higher values use fewer motion anchors.
232
+
233
+ - `keyframe_indexes: optional array of number`
234
+
235
+ 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.
236
+
237
+ - `keyframes: optional array of ImageRef`
238
+
239
+ 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[].
240
+
241
+ - `data: optional string`
242
+
243
+ Base64-encoded image or video data
244
+
245
+ - `file_id: optional string`
246
+
247
+ 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.
248
+
249
+ - `generation_id: optional string`
250
+
251
+ 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.
252
+
253
+ - `media_type: optional string`
254
+
255
+ 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.
256
+
257
+ - `url: optional string`
258
+
259
+ Publicly accessible image URL, or a video URL when used as source for video_edit/video_reframe with media_type=video/*.
260
+
261
+ - `strength: optional VideoEditStrength`
262
+
263
+ How much a video edit preserves or reimagines the source
264
+
265
+ - `"adhere_1"`
266
+
267
+ - `"adhere_2"`
268
+
269
+ - `"adhere_3"`
270
+
271
+ - `"flex_1"`
272
+
273
+ - `"flex_2"`
274
+
275
+ - `"flex_3"`
276
+
277
+ - `"reimagine_1"`
278
+
279
+ - `"reimagine_2"`
280
+
281
+ - `"reimagine_3"`
282
+
283
+ - `end_frame: optional ImageRef`
284
+
285
+ 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.
286
+
287
+ - `exr_export: optional boolean`
288
+
289
+ Export EXR alongside the MP4. Requires hdr=true.
290
+
291
+ - `guide_frame: optional ImageRef`
292
+
293
+ 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.
294
+
295
+ - `hdr: optional boolean`
296
+
297
+ Generate HDR video. Requires HDR access. Not supported for video_reframe.
298
+
299
+ - `keyframe_indexes: optional array of number`
300
+
301
+ 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.
302
+
303
+ - `keyframes: optional array of ImageRef`
304
+
305
+ 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.
306
+
307
+ - `data: optional string`
308
+
309
+ Base64-encoded image or video data
310
+
311
+ - `file_id: optional string`
312
+
313
+ 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.
314
+
315
+ - `generation_id: optional string`
316
+
317
+ 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.
318
+
319
+ - `media_type: optional string`
320
+
321
+ 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.
322
+
323
+ - `url: optional string`
324
+
325
+ Publicly accessible image URL, or a video URL when used as source for video_edit/video_reframe with media_type=video/*.
326
+
327
+ - `loop: optional boolean`
328
+
329
+ Generate a seamlessly looping video. Only valid for type=video; not supported with duration=10s or hdr=true.
330
+
331
+ - `resolution: optional VideoResolution`
332
+
333
+ 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.
334
+
335
+ - `"360p"`
336
+
337
+ - `"540p"`
338
+
339
+ - `"720p"`
340
+
341
+ - `"1080p"`
342
+
343
+ - `source_position: optional SourcePosition`
344
+
345
+ Normalized source rectangle inside the output canvas for video_reframe. Omit to let the model choose the default centered-fit crop.
346
+
347
+ - `h_norm: number`
348
+
349
+ Source rectangle height, as a fraction of canvas height. Up to 2.0 so the source can bleed off-canvas.
350
+
351
+ - `w_norm: number`
352
+
353
+ Source rectangle width, as a fraction of canvas width. Up to 2.0 so the source can bleed off-canvas.
354
+
355
+ - `x_norm: number`
356
+
357
+ Left edge of the source rectangle, as a fraction of canvas width. May be negative when the source extends off-canvas.
358
+
359
+ - `y_norm: number`
360
+
361
+ Top edge of the source rectangle, as a fraction of canvas height. May be negative when the source extends off-canvas.
362
+
363
+ - `start_frame: optional ImageRef`
364
+
365
+ 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.
366
+
367
+ - `web_search: optional boolean`
368
+
369
+ Enable web search grounding — the agent can search the web and download reference images before generating.
370
+
371
+ ### Returns
372
+
373
+ - `Generation = object { id, created_at, model, 5 more }`
374
+
375
+ Generation status and output
376
+
377
+ - `id: string`
378
+
379
+ Generation identifier
380
+
381
+ - `created_at: string`
382
+
383
+ Creation timestamp
384
+
385
+ - `model: Model`
386
+
387
+ Model used
388
+
389
+ - `"uni-1"`
390
+
391
+ - `"uni-1-max"`
392
+
393
+ - `"ray-3.2"`
394
+
395
+ - `state: "queued" or "processing" or "completed" or "failed"`
396
+
397
+ Current state of the generation
398
+
399
+ - `"queued"`
400
+
401
+ - `"processing"`
402
+
403
+ - `"completed"`
404
+
405
+ - `"failed"`
406
+
407
+ - `type: "image" or "image_edit" or "video" or 3 more`
408
+
409
+ The kind of generation to perform
410
+
411
+ - `"image"`
412
+
413
+ - `"image_edit"`
414
+
415
+ - `"video"`
416
+
417
+ - `"video_edit"`
418
+
419
+ - `"video_reframe"`
420
+
421
+ - `"layering"`
422
+
423
+ - `failure_code: optional GenerationFailureCode`
424
+
425
+ Machine-readable failure code for programmatic handling
426
+
427
+ - `"content_moderated"`
428
+
429
+ - `"generation_failed"`
430
+
431
+ - `"budget_exhausted"`
432
+
433
+ - `"output_not_found"`
434
+
435
+ - `"image_too_large"`
436
+
437
+ - `"unsupported_format"`
438
+
439
+ - `"corrupt_input"`
440
+
441
+ - `"invalid_request"`
442
+
443
+ - `"rate_limited"`
444
+
445
+ - `failure_reason: optional string`
446
+
447
+ Human-readable failure description
448
+
449
+ - `output: optional array of GenerationOutput`
450
+
451
+ Generated outputs (populated on completion)
452
+
453
+ - `type: string`
454
+
455
+ Media type (e.g. image, video)
456
+
457
+ - `url: string`
458
+
459
+ Presigned URL (1hr expiry)
460
+
461
+ - `layer: optional object { alpha_hint, description, index, 4 more }`
462
+
463
+ Per-layer semantics for a type=layering output
464
+
465
+ - `alpha_hint: string`
466
+
467
+ Edge treatment of the layer's transparency — soft (hair/fur/glass), hard (solid edges), or none (the opaque background)
468
+
469
+ - `description: string`
470
+
471
+ Complete-element caption for the layer's content
472
+
473
+ - `index: number`
474
+
475
+ Layer position, front-to-back; the last layer is the background
476
+
477
+ - `label: string`
478
+
479
+ Short (1-2 word) layer name
480
+
481
+ - `bounds: optional object { canvas_height, canvas_width, height, 3 more }`
482
+
483
+ 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.
484
+
485
+ - `canvas_height: number`
486
+
487
+ Height of the full composite canvas the layers reassemble into
488
+
489
+ - `canvas_width: number`
490
+
491
+ Width of the full composite canvas the layers reassemble into
492
+
493
+ - `height: number`
494
+
495
+ Pixel height of the returned layer image
496
+
497
+ - `width: number`
498
+
499
+ Pixel width of the returned layer image
500
+
501
+ - `x: number`
502
+
503
+ Left offset of this layer's pixels within the composite canvas
504
+
505
+ - `y: number`
506
+
507
+ Top offset of this layer's pixels within the composite canvas
508
+
509
+ - `contains_text: optional boolean`
510
+
511
+ 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.
512
+
513
+ - `text: optional object { content, decorated, font }`
514
+
515
+ 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.
516
+
517
+ - `content: string`
518
+
519
+ The text as shown, preserving capitalization; one line per line (newline-separated)
520
+
521
+ - `decorated: optional boolean`
522
+
523
+ True when the lettering is ornamental (outlines, patterned fills, bevels, drop shadows), so plain typeset text will not reproduce its look.
524
+
525
+ - `font: optional object { category, families, italic, 3 more }`
526
+
527
+ Described letterform traits of a text layer — enough to pick a matching font.
528
+
529
+ - `category: "sans serif" or "serif" or "slab serif" or 6 more`
530
+
531
+ Letterform style
532
+
533
+ - `"sans serif"`
534
+
535
+ - `"serif"`
536
+
537
+ - `"slab serif"`
538
+
539
+ - `"display sans"`
540
+
541
+ - `"display serif"`
542
+
543
+ - `"display slab"`
544
+
545
+ - `"display decorative"`
546
+
547
+ - `"handwriting"`
548
+
549
+ - `"monospace"`
550
+
551
+ - `families: array of string`
552
+
553
+ Up to three Google Fonts family names that resemble the lettering, closest first. Empty when none of the offered families fit.
554
+
555
+ - `italic: boolean`
556
+
557
+ Whether the letters are slanted or cursive
558
+
559
+ - `weight: "thin" or "light" or "regular" or 3 more`
560
+
561
+ Stroke weight
562
+
563
+ - `"thin"`
564
+
565
+ - `"light"`
566
+
567
+ - `"regular"`
568
+
569
+ - `"medium"`
570
+
571
+ - `"bold"`
572
+
573
+ - `"black"`
574
+
575
+ - `width: "condensed" or "normal" or "wide"`
576
+
577
+ Letter width for its height
578
+
579
+ - `"condensed"`
580
+
581
+ - `"normal"`
582
+
583
+ - `"wide"`
584
+
585
+ - `match: optional object { face_id, family_id, family_name, 2 more }`
586
+
587
+ 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.
588
+
589
+ - `face_id: string`
590
+
591
+ Typed ref of the matched face (one weight and style), font_face:<id>
592
+
593
+ - `family_id: string`
594
+
595
+ Typed ref of the matched font family, font_family:<id>
596
+
597
+ - `family_name: string`
598
+
599
+ Name of the matched font family
600
+
601
+ - `style: "normal" or "italic"`
602
+
603
+ Style of the matched face
604
+
605
+ - `"normal"`
606
+
607
+ - `"italic"`
608
+
609
+ - `weight: number`
610
+
611
+ CSS font weight of the matched face, e.g. 400 or 700
612
+
613
+ ### Example
614
+
615
+ ```http
616
+ curl https://agents.lumalabs.ai/v1/generations \
617
+ -H 'Content-Type: application/json' \
618
+ -H "Authorization: Bearer $LUMA_AGENTS_API_KEY" \
619
+ -d '{
620
+ "prompt": "A glass of iced coffee on a marble countertop, morning light streaming through a window"
621
+ }'
622
+ ```
623
+
624
+ #### Response
625
+
626
+ ```json
627
+ {
628
+ "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
629
+ "created_at": "created_at",
630
+ "model": "uni-1",
631
+ "state": "queued",
632
+ "type": "image",
633
+ "failure_code": "content_moderated",
634
+ "failure_reason": "failure_reason",
635
+ "output": [
636
+ {
637
+ "type": "type",
638
+ "url": "https://example.com",
639
+ "layer": {
640
+ "alpha_hint": "alpha_hint",
641
+ "description": "description",
642
+ "index": 0,
643
+ "label": "label",
644
+ "bounds": {
645
+ "canvas_height": 0,
646
+ "canvas_width": 0,
647
+ "height": 0,
648
+ "width": 0,
649
+ "x": 0,
650
+ "y": 0
651
+ },
652
+ "contains_text": true,
653
+ "text": {
654
+ "content": "content",
655
+ "decorated": true,
656
+ "font": {
657
+ "category": "sans serif",
658
+ "families": [
659
+ "string"
660
+ ],
661
+ "italic": true,
662
+ "weight": "thin",
663
+ "width": "condensed",
664
+ "match": {
665
+ "face_id": "face_id",
666
+ "family_id": "family_id",
667
+ "family_name": "family_name",
668
+ "style": "normal",
669
+ "weight": 0
670
+ }
671
+ }
672
+ }
673
+ }
674
+ }
675
+ ]
676
+ }
677
+ ```
pipeline/provider_docs/luma__docs.agents.lumalabs.ai_guides_faq_index.md ADDED
@@ -0,0 +1,728 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: FAQ | Luma Agents
3
+ 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.
4
+ ---
5
+
6
+ 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.
7
+
8
+ Can’t find your question? Email <support+luma-agents-api@lumalabs.ai>. Include the `X-Request-Id` from the affected response — see [Request tracing](/guides/rate-limits/index.md#using-x-request-id-for-tracing).
9
+
10
+ ## Getting started
11
+
12
+ What is the Luma Agents API?
13
+
14
+ 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.
15
+
16
+ What is uni-1?
17
+
18
+ `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.
19
+
20
+ What is uni-1-max?
21
+
22
+ `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`.
23
+
24
+ When should I use uni-1-max vs uni-1?
25
+
26
+ 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.
27
+
28
+ What is Ray 3.2?
29
+
30
+ 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).
31
+
32
+ What is `source.generation_id`?
33
+
34
+ `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).
35
+
36
+ How do I get an API key?
37
+
38
+ 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`:
39
+
40
+ ```bash
41
+ export LUMA_AGENTS_API_KEY="luma-api-..."
42
+ ```
43
+
44
+ Keys start with the prefix `luma-api-`. Treat them like passwords; never commit them to source control or ship them to client-side code.
45
+
46
+ I lost my API key. Can I retrieve it?
47
+
48
+ 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.
49
+
50
+ Can I have multiple API keys?
51
+
52
+ Yes. Create as many keys as you need and name each one (e.g. `production`, `staging`) for tracking and selective revocation.
53
+
54
+ 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.
55
+
56
+ What is the base URL?
57
+
58
+ ```plaintext
59
+ https://agents.lumalabs.ai/v1
60
+ ```
61
+
62
+ There is no staging or sandbox environment. Use a test key and small generations to experiment.
63
+
64
+ How do I authenticate requests?
65
+
66
+ Pass your API key as a Bearer token in the `Authorization` header. Both endpoints require authentication; missing or malformed auth is rejected.
67
+
68
+ ```bash
69
+ curl -X POST https://agents.lumalabs.ai/v1/generations \
70
+ -H "Authorization: Bearer $LUMA_AGENTS_API_KEY" \
71
+ -H "Content-Type: application/json" \
72
+ -d '{"prompt": "A sunset over the ocean"}'
73
+ ```
74
+
75
+ Which SDKs are available?
76
+
77
+ 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.
78
+
79
+ Is the API synchronous or asynchronous?
80
+
81
+ 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.
82
+
83
+ ---
84
+
85
+ ## Prompts
86
+
87
+ What is the maximum prompt length?
88
+
89
+ 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.
90
+
91
+ What is the minimum prompt length?
92
+
93
+ 1 character. Empty strings are rejected. A few words is usually enough; longer, more specific prompts produce better results.
94
+
95
+ Does uni-1 support non-English prompts?
96
+
97
+ `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.
98
+
99
+ Does the API support negative prompts?
100
+
101
+ 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”.
102
+
103
+ How do I render text inside an image?
104
+
105
+ Put the exact text in quotes inside your prompt so the model knows to render it literally:
106
+
107
+ ```json
108
+ {
109
+ "prompt": "A coffee shop storefront with a wooden sign that reads \"MORNING BREW\" in hand-painted serif letters"
110
+ }
111
+ ```
112
+
113
+ Shorter strings (under roughly 20 characters) render most reliably. Long passages of text may be partially garbled.
114
+
115
+ Can I reproduce the same image from the same prompt?
116
+
117
+ 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).
118
+
119
+ How should I structure my prompts?
120
+
121
+ 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.
122
+
123
+ ---
124
+
125
+ ## Aspect ratios and output
126
+
127
+ Which aspect ratios are supported?
128
+
129
+ 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).
130
+
131
+ What is the default aspect ratio?
132
+
133
+ 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).
134
+
135
+ What output formats does uni-1 support?
136
+
137
+ 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.
138
+
139
+ What is the output resolution?
140
+
141
+ 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`).
142
+
143
+ What colour space are EXR video outputs in?
144
+
145
+ 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).
146
+
147
+ Can I generate multiple images in a single request?
148
+
149
+ 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)).
150
+
151
+ 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.
152
+
153
+ How long do output URLs remain valid?
154
+
155
+ 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.
156
+
157
+ ---
158
+
159
+ ## Image editing and reference images
160
+
161
+ Can I edit existing images, or is this text-to-image only?
162
+
163
+ `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.
164
+
165
+ What is the difference between `source` and `image_ref`?
166
+
167
+ `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).
168
+
169
+ How many reference images can I pass?
170
+
171
+ 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.
172
+
173
+ What is the maximum image size for `source` and `image_ref`?
174
+
175
+ 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`:
176
+
177
+ ```json
178
+ { "detail": "source: image exceeds 50 MB limit" }
179
+ { "detail": "image_ref[2]: image exceeds 50 MB limit" }
180
+ ```
181
+
182
+ 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.
183
+
184
+ There’s also a dimension cap: each side must be **8000 px or less**. Larger images are rejected before any generation runs:
185
+
186
+ ```json
187
+ {
188
+ "detail": "source: image is 12000x8000px but each side must be <= 8000px. Resize and try again."
189
+ }
190
+ ```
191
+
192
+ What image formats can I upload for reference or source?
193
+
194
+ 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"`.
195
+
196
+ URL or base64: which should I use?
197
+
198
+ Each `source` and `image_ref` entry must provide exactly one of `url` or `data`. Never both, never neither:
199
+
200
+ | Entry shape | Result |
201
+ | --------------------------------------------- | ----------------------------------------------------------------------- |
202
+ | `{"url": "https://..."}` | Valid |
203
+ | `{"data": "...", "media_type": "image/jpeg"}` | Valid |
204
+ | `{"url": "...", "data": "..."}` | Rejected: `"image_ref[0]: provide either 'url' or 'data', not both"` |
205
+ | `{}` | Rejected: `"image_ref[0]: provide either 'url' or 'data', not neither"` |
206
+ | `{"data": "..."}` without `media_type` | Rejected: `"image_ref[0]: 'media_type' is required with 'data'"` |
207
+
208
+ 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.
209
+
210
+ What requirements does a reference URL need to meet?
211
+
212
+ URLs are fetched server-side through a Cloudflare edge proxy with strict SSRF protection. The URL must:
213
+
214
+ - Use `https://` (plain `http://` is rejected).
215
+ - Resolve to a public IP. RFC1918, loopback, and link-local addresses are rejected.
216
+ - Not redirect from HTTPS to HTTP at any point in the chain.
217
+ - Resolve via public DNS (the proxy cannot reach VPNs or internal hostnames).
218
+ - Return a successful response with an `image/*` content-type.
219
+ - Be under 50 MB and respond within roughly 18 seconds.
220
+
221
+ 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`.
222
+
223
+ Does uni-1 support inpainting or outpainting with masks?
224
+
225
+ 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”.
226
+
227
+ Can I control how closely the output follows a reference image?
228
+
229
+ 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.
230
+
231
+ Does an edit preserve the source image’s dimensions?
232
+
233
+ 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.
234
+
235
+ ---
236
+
237
+ ## Advanced generation features
238
+
239
+ What styles are supported?
240
+
241
+ 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.
242
+
243
+ Which aspect ratios work with `style: "manga"`?
244
+
245
+ 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:
246
+
247
+ ```json
248
+ {
249
+ "detail": "aspect_ratio='1:1' is not allowed when style='manga'. Valid aspect_ratio: 1:2, 1:3, 2:3, 9:16"
250
+ }
251
+ ```
252
+
253
+ 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).
254
+
255
+ Which aspect ratios work with `style: "auto"`?
256
+
257
+ 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.
258
+
259
+ Does `aspect_ratio` apply to image edits?
260
+
261
+ 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.
262
+
263
+ What does `web_search: true` do?
264
+
265
+ 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.
266
+
267
+ ```json
268
+ {
269
+ "prompt": "The Eiffel Tower at golden hour with cherry blossoms in the foreground",
270
+ "web_search": true
271
+ }
272
+ ```
273
+
274
+ Can I generate a video with this API?
275
+
276
+ 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.
277
+
278
+ Can I cancel a running generation?
279
+
280
+ 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.
281
+
282
+ ---
283
+
284
+ ## Video editing and reframing (Ray 3.2)
285
+
286
+ How do I supply the source video for an edit or reframe?
287
+
288
+ Both `type: "video_edit"` and `type: "video_reframe"` require exactly one source video, supplied in one of three ways:
289
+
290
+ - **`source.generation_id`** — the top-level `id` of a prior completed video generation owned by the same client.
291
+ - **`source.url`** — a publicly reachable video URL, with `source.media_type` set to a `video/*` MIME (e.g. `"video/mp4"`).
292
+ - **`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`.
293
+
294
+ `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.
295
+
296
+ ```json
297
+ {
298
+ "detail": "source.media_type must be a video/* type (e.g. 'video/mp4') when providing source.url / source.data on type='video_edit'"
299
+ }
300
+ ```
301
+
302
+ See [Video editing — source video](/guides/videos/editing/index.md#referencing-the-source-video).
303
+
304
+ Is there a length limit on source videos?
305
+
306
+ 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`).
307
+
308
+ | Operation | Source video limit |
309
+ | -------------------------------------------------------- | ------------------ |
310
+ | `video_reframe` | ≤10s |
311
+ | `video_edit` | ≤18s |
312
+ | Extend (`type: "video"` with a `generation_id` keyframe) | ≤30s |
313
+
314
+ Longer clips are rejected at submit time, with the applicable limit in the error:
315
+
316
+ ```json
317
+ {
318
+ "detail": "source: source video is 42.0s but must be ≤10s. Trim the clip and retry."
319
+ }
320
+ ```
321
+
322
+ Trim the clip and resubmit. For a clip longer than the cap, split it into segments within the limit and submit each one.
323
+
324
+ Is there a file-size limit on source videos?
325
+
326
+ Yes — the source video must be **200 MB or smaller**, applied to both `url` fetches and base64 `data`. Oversized payloads are rejected:
327
+
328
+ ```json
329
+ { "detail": "source: video exceeds 200 MB limit" }
330
+ ```
331
+
332
+ 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.
333
+
334
+ What’s the difference between `video_edit` and `video_reframe`?
335
+
336
+ Both take a source video, but they do different things:
337
+
338
+ - **`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.
339
+ - **`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.
340
+
341
+ See [Video editing](/guides/videos/editing/index.md) and [Video reframing](/guides/videos/reframing/index.md).
342
+
343
+ How do I control how much a video edit changes the source?
344
+
345
+ 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:
346
+
347
+ - **`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).
348
+ - **`video.edit.controls`** — per-signal conditioning (`pose`, `depth`, `normals`, `trajectory`, `face`), each with an `enabled` flag and its own tuning parameter.
349
+
350
+ `controls` cannot be combined with `auto_controls: true` — auto mode derives the schedule and would ignore manual controls, so the API rejects the combination:
351
+
352
+ ```json
353
+ {
354
+ "detail": "video.edit.auto_controls=true cannot be combined with video.edit.controls (auto mode derives the schedule and ignores manual per-signal controls)"
355
+ }
356
+ ```
357
+
358
+ See [Video editing — edit controls](/guides/videos/editing/index.md).
359
+
360
+ Can I anchor a video edit to specific frames?
361
+
362
+ Yes — in two mutually exclusive ways:
363
+
364
+ - **Single guide frame** — `video.start_frame`, an `ImageRef` used as one anchor for the edit.
365
+ - **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.
366
+
367
+ `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).
368
+
369
+ Can I pass reference images (`image_ref`) on a video edit?
370
+
371
+ No. `image_ref` is rejected on `type: "video_edit"`:
372
+
373
+ ```json
374
+ { "detail": "image_ref is not supported for type 'video_edit'" }
375
+ ```
376
+
377
+ Guide the edit through the prompt, the `video.edit` conditioning controls, and guide frames (`video.start_frame` or `video.edit.keyframes`).
378
+
379
+ Can I control where the source sits inside a reframed video?
380
+
381
+ 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:
382
+
383
+ | Field | Range | Meaning |
384
+ | -------- | ------------ | ------------------------------------------------------ |
385
+ | `x_norm` | `-2.0`–`2.0` | Left edge of the source, as a fraction of canvas width |
386
+ | `y_norm` | `-2.0`–`2.0` | Top edge of the source, as a fraction of canvas height |
387
+ | `w_norm` | `>0`–`2.0` | Source width, as a fraction of canvas width |
388
+ | `h_norm` | `>0`–`2.0` | Source height, as a fraction of canvas height |
389
+
390
+ 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).
391
+
392
+ Do HDR and looping work on edits and reframes?
393
+
394
+ - **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.
395
+ - **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'"`.
396
+
397
+ Does an edit or reframe keep the source’s aspect ratio?
398
+
399
+ 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`).
400
+
401
+ ---
402
+
403
+ ## Polling, states, and timing
404
+
405
+ What are the generation states?
406
+
407
+ 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.
408
+
409
+ How often should I poll?
410
+
411
+ 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.
412
+
413
+ Is the GET endpoint rate limited?
414
+
415
+ 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.
416
+
417
+ 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.
418
+
419
+ How long does a generation typically take?
420
+
421
+ 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.
422
+
423
+ My generation has been queued for a long time. What should I do?
424
+
425
+ Check three things:
426
+
427
+ 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.
428
+ 2. Wait an additional 30–60 seconds and poll again — short queue spikes are normal.
429
+ 3. If still stuck after a few minutes, contact support and include the `X-Request-Id` from the submit response.
430
+
431
+ ---
432
+
433
+ ## Rate limits and concurrency
434
+
435
+ What are the default rate limits?
436
+
437
+ Two limits, both per client:
438
+
439
+ | Limit | Applies to |
440
+ | ------------------------- | ------------------------------------------------ |
441
+ | Requests per minute (RPM) | `POST /v1/generations`, rolling 60-second window |
442
+ | Concurrent jobs | Active (non-terminal) generations at any time |
443
+
444
+ 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.
445
+
446
+ How does the RPM sliding window work?
447
+
448
+ 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.
449
+
450
+ What do the rate-limit headers mean?
451
+
452
+ Successful `POST /v1/generations` responses include three headers describing your current quota:
453
+
454
+ | Header | Description |
455
+ | ----------------------- | -------------------------------------------------- |
456
+ | `X-RateLimit-Limit` | Your maximum RPM |
457
+ | `X-RateLimit-Remaining` | Requests remaining in the current 60-second window |
458
+ | `X-RateLimit-Reset` | Unix timestamp when the current window ends |
459
+
460
+ When you’re rate-limited, `Retry-After` reports the minimum seconds to wait before retrying.
461
+
462
+ How do I tell RPM from concurrent-job rate limiting?
463
+
464
+ Both surface as the same rate-limit error. Read the `detail` field to distinguish them:
465
+
466
+ | `detail` | Cause | What to do |
467
+ | ---------------------------- | ---------- | ----------------------------------------------- |
468
+ | `"Rate limit exceeded"` | RPM | Wait `Retry-After` seconds, then retry |
469
+ | `"Too many concurrent jobs"` | Concurrent | Wait for an active job to terminate, then retry |
470
+
471
+ Concurrent-job rejections use a fixed `Retry-After: 60` and do not include `X-RateLimit-*` headers.
472
+
473
+ How can I increase my rate limits?
474
+
475
+ 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.
476
+
477
+ ---
478
+
479
+ ## Errors
480
+
481
+ Where can I find the full list of error responses?
482
+
483
+ 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.
484
+
485
+ What is the difference between synchronous and asynchronous failures?
486
+
487
+ 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.
488
+
489
+ What are the asynchronous `failure_code` values?
490
+
491
+ | `failure_code` | Description | Action |
492
+ | -------------------- | ---------------------------------------------------------------- | --------------------------------------------- |
493
+ | `content_moderated` | Input or output flagged by content moderation | Modify the prompt, do not retry |
494
+ | `generation_failed` | Internal model error | Retry the same request |
495
+ | `budget_exhausted` | Ran out of funds mid-generation | Add funds, then retry |
496
+ | `output_not_found` | Generated output could not be retrieved | Retry the same request |
497
+ | `image_too_large` | Input image exceeded the size limit (detected during processing) | Resize/compress the input, do not retry as-is |
498
+ | `unsupported_format` | Input media was in an unsupported format | Convert to a supported format, then resubmit |
499
+ | `corrupt_input` | Input media could not be decoded | Re-encode or replace the input |
500
+ | `invalid_request` | Request rejected as invalid during generation | Fix the request parameters |
501
+ | `rate_limited` | Upstream provider rate-limited the generation | Retry with backoff |
502
+
503
+ See [Error handling — Asynchronous failures](/guides/error-handling/index.md#asynchronous-failures).
504
+
505
+ What does `content_moderated` mean? Can I retry?
506
+
507
+ 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.
508
+
509
+ My output URL stopped working. What’s wrong?
510
+
511
+ 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.
512
+
513
+ My reference image was rejected as unprocessable. Now what?
514
+
515
+ The reference was syntactically valid but couldn’t be processed. The `detail` field tells you exactly what to fix:
516
+
517
+ | `detail` | Fix |
518
+ | ---------------------------------------------- | ------------------------------------------------------------------------------------- |
519
+ | `"image_ref[0]: invalid base64 data"` | Re-encode the image (e.g. `base64.b64encode(bytes).decode("utf-8")`) |
520
+ | `"image_ref[0]: failed to fetch URL"` | Confirm the URL is publicly reachable |
521
+ | `"source: failed to fetch URL"` | The origin did not return the image successfully — confirm it serves a valid response |
522
+ | `"image_ref[0]: content-type is not an image"` | The URL is not serving an image — check for HTML or PDF redirects |
523
+
524
+ What should I do with the `X-Request-Id` header?
525
+
526
+ 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).
527
+
528
+ ---
529
+
530
+ ## Content moderation and safety
531
+
532
+ What content is not allowed?
533
+
534
+ The full policy lives in the [Terms of Service](https://lumalabs.ai/legal/tos) and acceptable-use policy. The model blocks:
535
+
536
+ - Child sexual abuse material (zero tolerance)
537
+ - Sexually explicit content
538
+ - Non-consensual intimate imagery and deepfakes of real people
539
+ - Graphic violence and gore
540
+ - Content promoting self-harm or dangerous acts
541
+ - Hateful content targeting protected groups
542
+ - Infringing or trademarked imagery in misleading contexts
543
+
544
+ Moderation runs on inputs (`prompt`, `source`, `image_ref`) and outputs.
545
+
546
+ Can I disable content moderation?
547
+
548
+ No. Moderation is enforced on every input and output and cannot be disabled.
549
+
550
+ My prompt was moderated but feels benign. What happened?
551
+
552
+ 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.
553
+
554
+ ---
555
+
556
+ ## Billing
557
+
558
+ 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.
559
+
560
+ How is pricing calculated?
561
+
562
+ Two options:
563
+
564
+ - **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.
565
+ - **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.
566
+
567
+ See the [Pricing](/guides/pricing/index.md) page for current rates.
568
+
569
+ Does video pricing differ from image pricing?
570
+
571
+ 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.
572
+
573
+ Do I pay for failed generations?
574
+
575
+ 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`:
576
+
577
+ | `failure_code` | Charge |
578
+ | ------------------- | ----------------------- |
579
+ | `content_moderated` | Refunded |
580
+ | `generation_failed` | Refunded |
581
+ | `output_not_found` | Refunded |
582
+ | `budget_exhausted` | Partial charge possible |
583
+
584
+ If you believe you were charged for a failure that should have been refunded, contact support with the generation ID and `X-Request-Id`.
585
+
586
+ How do I check my balance?
587
+
588
+ 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).
589
+
590
+ What happens if I run out of funds at submit time?
591
+
592
+ `POST /v1/generations` rejects the request immediately. The request is not queued and nothing is charged. Add funds and resubmit.
593
+
594
+ ```json
595
+ { "detail": "Insufficient balance. Please add funds to continue." }
596
+ ```
597
+
598
+ What happens if I run out of funds mid-generation?
599
+
600
+ 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.
601
+
602
+ ```json
603
+ {
604
+ "state": "failed",
605
+ "failure_code": "budget_exhausted",
606
+ "failure_reason": "Insufficient balance to complete this generation."
607
+ }
608
+ ```
609
+
610
+ Can I set up auto-reload?
611
+
612
+ 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.
613
+
614
+ Is there a free tier?
615
+
616
+ 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.
617
+
618
+ ---
619
+
620
+ ## Data handling and privacy
621
+
622
+ Does Luma train on my API inputs or outputs?
623
+
624
+ 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.
625
+
626
+ How long are my generations stored?
627
+
628
+ 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 <support+luma-agents-api@lumalabs.ai>.
629
+
630
+ Who owns the generated images?
631
+
632
+ 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.
633
+
634
+ ---
635
+
636
+ ## Troubleshooting
637
+
638
+ My API key is rejected, but it works elsewhere.
639
+
640
+ The `detail` field on the auth error tells you exactly which case you’re in — branch on it to debug:
641
+
642
+ | `detail` | Likely fix |
643
+ | ------------------------------ | ------------------------------------------------------------------------------------ |
644
+ | `"Missing or invalid API key"` | Add `Authorization: Bearer <key>` and confirm the key starts with `luma-api-` |
645
+ | `"Invalid API key"` | Key value doesn’t match any active key — re-copy the full key, or generate a new one |
646
+ | `"API key has been revoked"` | Generate a new key — revoked keys cannot be restored |
647
+ | `"API key has expired"` | Generate a new key — keys can have an `expires_at` |
648
+
649
+ Other things to check:
650
+
651
+ 1. **Environment variable not expanded** — verify `LUMA_AGENTS_API_KEY` is set in the shell running your code.
652
+ 2. **Whitespace or newline** — common when copy-pasting from a dashboard. Trim before use.
653
+ 3. **Bearer scheme is case-sensitive** — `bearer` (lowercase) is not accepted.
654
+
655
+ I just created a generation but GET says it doesn’t exist.
656
+
657
+ Three possible causes, all returning the same `"Generation not found"` to prevent enumeration:
658
+
659
+ 1. **Wrong account or client.** Generations are scoped per client. A key from a different client cannot see it even with a correct ID.
660
+ 2. **Typo in the ID.** Copy it directly from the `id` field of the submit response.
661
+ 3. **Invalid UUID format.** The path parameter must parse as a UUID.
662
+
663
+ My reference URL works in a browser but the API rejects it.
664
+
665
+ The fetch proxy is stricter than a browser. Common causes:
666
+
667
+ 1. The URL redirects to HTML (e.g. a login wall); the proxy sees HTML, not an image.
668
+ 2. The URL is `http://` (proxy is HTTPS-only) or resolves to a private IP.
669
+ 3. A short-lived signed URL expired between copy and fetch.
670
+ 4. The origin returns a non-200 status, or a content-type that is not `image/*`.
671
+
672
+ When in doubt, download the image yourself and send it as base64 `data`.
673
+
674
+ Reference URLs are failing with a service-unavailable error.
675
+
676
+ The URL ingestion subsystem is temporarily unavailable. Send the image as base64 `data` instead:
677
+
678
+ ```python
679
+ import base64, httpx
680
+
681
+ resp = httpx.get("https://example.com/reference.jpg")
682
+ b64 = base64.b64encode(resp.content).decode("utf-8")
683
+
684
+ generation = client.generations.create(
685
+ prompt="A similar scene but at sunset",
686
+ image_ref=[{"data": b64, "media_type": "image/jpeg"}],
687
+ )
688
+ ```
689
+
690
+ If you don’t need reference images, retry the request without them.
691
+
692
+ How do I report a bug or get support?
693
+
694
+ Email <support+luma-agents-api@lumalabs.ai>. Include:
695
+
696
+ 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.
697
+ 2. The `X-Request-Id` from the affected response (submit and/or poll).
698
+ 3. Request parameters, with API keys redacted.
699
+ 4. Expected versus actual behavior.
700
+
701
+ **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.
702
+
703
+ ---
704
+
705
+ ## Versioning
706
+
707
+ What API version am I using?
708
+
709
+ 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.
710
+
711
+ How are breaking changes communicated?
712
+
713
+ 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.
714
+
715
+ ---
716
+
717
+ ## Next steps
718
+
719
+ - [**Quickstart**](/index.md) — Submit your first generation
720
+ - [**Models**](/guides/model/index.md) — Capabilities for `uni-1`, `uni-1-max`, `ray-3.2`
721
+ - [**Image generation**](/guides/images/generation/index.md) — Every parameter with examples
722
+ - [**Image editing**](/guides/images/editing/index.md) — Edit existing images with natural language
723
+ - [**Video generation**](/guides/videos/generation/index.md) — Ray 3.2 text-to-video and image-to-video
724
+ - [**Video editing**](/guides/videos/editing/index.md) — Ray 3.2 video editing
725
+ - [**Pricing**](/guides/pricing/index.md) — Pay-as-you-go and Provisioned Throughput
726
+ - [**Rate limits and headers**](/guides/rate-limits/index.md) — Rate limiting and retry strategies
727
+ - [**Error handling**](/guides/error-handling/index.md) — Every error code with troubleshooting
728
+ - [**API Reference**](/api/index.md) — Complete endpoint specifications
pipeline/provider_docs/meta__dev.meta.ai_docs_api-reference_images_schemas ADDED
The diff for this file is too large to render. See raw diff
 
pipeline/provider_docs/microsoft__learn.microsoft.com_en-us_azure_foundry_foundry-models_how-to_use-foundry-models-mai ADDED
@@ -0,0 +1,2073 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html
3
+ class="layout layout-holy-grail show-table-of-contents conceptual show-breadcrumb default-focus"
4
+ lang="en-us"
5
+ dir="ltr"
6
+ data-authenticated="false"
7
+ data-auth-status-determined="false"
8
+ data-target="docs"
9
+ x-ms-format-detection="none"
10
+ >
11
+
12
+ <head>
13
+ <title>Deploy and use MAI image models in Microsoft Foundry - Microsoft Foundry | Microsoft Learn</title>
14
+ <meta charset="utf-8" />
15
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
16
+ <meta name="color-scheme" content="light dark" />
17
+
18
+ <meta name="description" content="Deploy MAI image models in Microsoft Foundry, to generate high-quality images from natural language prompts and perform image-to-image editing." />
19
+ <link rel="canonical" href="https://learn.microsoft.com/en-us/azure/foundry/foundry-models/how-to/use-foundry-models-mai-image" />
20
+
21
+ <!-- Non-customizable open graph and sharing-related metadata -->
22
+ <meta name="twitter:card" content="summary_large_image" />
23
+ <meta name="twitter:site" content="@MicrosoftLearn" />
24
+ <meta property="og:type" content="website" />
25
+ <meta property="og:image:alt" content="Microsoft Learn" />
26
+ <meta property="og:image" content="https://learn.microsoft.com/en-us/media/open-graph-image.png" />
27
+ <!-- Page specific open graph and sharing-related metadata -->
28
+ <meta property="og:title" content="Deploy and use MAI image models in Microsoft Foundry - Microsoft Foundry" />
29
+ <meta property="og:url" content="https://learn.microsoft.com/en-us/azure/foundry/foundry-models/how-to/use-foundry-models-mai-image" />
30
+ <meta property="og:description" content="Deploy MAI image models in Microsoft Foundry, to generate high-quality images from natural language prompts and perform image-to-image editing." />
31
+ <meta name="platform_id" content="e2776713-34f3-4cb2-7463-28ae13961cac" /> <meta name="scope" content="Azure" />
32
+ <meta name="locale" content="en-us" />
33
+
34
+ <meta name="uhfHeaderId" content="azure-ai-foundry" />
35
+
36
+ <meta name="page_type" content="conceptual" />
37
+
38
+ <!--page specific meta tags-->
39
+
40
+
41
+ <!-- custom meta tags -->
42
+
43
+ <meta name="breadcrumb_path" content="../../../breadcrumb/azure-ai/toc.json" />
44
+
45
+ <meta name="feedback_help_link_url" content="https://learn.microsoft.com/answers/tags/133/azure" />
46
+
47
+ <meta name="feedback_help_link_type" content="get-help-at-qna" />
48
+
49
+ <meta name="feedback_product_url" content="https://feedback.azure.com/d365community/forum/79b1327d-d925-ec11-b6e6-000d3a4f06a4" />
50
+
51
+ <meta name="feedback_system" content="Standard" />
52
+
53
+ <meta name="permissioned-type" content="public" />
54
+
55
+ <meta name="recommendations" content="true" />
56
+
57
+ <meta name="recommendation_types" content="Training" />
58
+
59
+ <meta name="recommendation_types" content="Certification" />
60
+
61
+ <meta name="ms.suite" content="office" />
62
+
63
+ <meta name="author" content="msakande" />
64
+
65
+ <meta name="learn_banner_products" content="azure" />
66
+
67
+ <meta name="manager" content="mcleans" />
68
+
69
+ <meta name="ms.author" content="mopeakande" />
70
+
71
+ <meta name="ms.collection" content="ce-skilling-ai-copilot" />
72
+
73
+ <meta name="ms.update-cycle" content="90-days" />
74
+
75
+ <meta name="ms.service" content="microsoft-foundry" />
76
+
77
+ <meta name="ms.subservice" content="foundry-models" />
78
+
79
+ <meta name="ms.topic" content="how-to" />
80
+
81
+ <meta name="ms.date" content="2026-09-21T00:00:00Z" />
82
+
83
+ <meta name="ms.custom" content="doc-kit-assisted" />
84
+
85
+ <meta name="ms.custom" content="classic-and-new" />
86
+
87
+ <meta name="ms.reviewer" content="rasavage" />
88
+
89
+ <meta name="reviewer" content="RSavage2" />
90
+
91
+ <meta name="ai-usage" content="ai-assisted" />
92
+
93
+ <meta name="document_id" content="2f906dad-c094-128f-9474-35d70cf5f652" />
94
+
95
+ <meta name="document_version_independent_id" content="bf9bfcff-6001-777a-5ee0-02f9c634a4a9" />
96
+
97
+ <meta name="updated_at" content="2026-09-21T22:12:00Z" />
98
+
99
+ <meta name="original_content_git_url" content="https://github.com/MicrosoftDocs/azure-ai-docs-pr/blob/live/articles/foundry/foundry-models/how-to/use-foundry-models-mai-image.md" />
100
+
101
+ <meta name="gitcommit" content="https://github.com/MicrosoftDocs/azure-ai-docs-pr/blob/7928acff484d117f43e4a6d23924e6495de6cabb/articles/foundry/foundry-models/how-to/use-foundry-models-mai-image.md" />
102
+
103
+ <meta name="git_commit_id" content="7928acff484d117f43e4a6d23924e6495de6cabb" />
104
+
105
+ <meta name="site_name" content="Docs" />
106
+
107
+ <meta name="depot_name" content="Learn.azure-ai" />
108
+
109
+ <meta name="schema" content="Conceptual" />
110
+
111
+ <meta name="toc_rel" content="../../toc.json" />
112
+
113
+ <meta name="word_count" content="2726" />
114
+
115
+ <meta name="asset_id" content="foundry/foundry-models/how-to/use-foundry-models-mai-image" />
116
+
117
+ <meta name="moniker_range_name" content="" />
118
+
119
+ <meta name="item_type" content="Content" />
120
+
121
+ <meta name="source_path" content="articles/foundry/foundry-models/how-to/use-foundry-models-mai-image.md" />
122
+
123
+ <meta name="previous_tlsh_hash" content="BDA29672B40C9D10BED56E2A2D17BB085EF881C9CA70A9845831B1A1958E2DA383A25AEBEB23AB5A3737C2D342937B1F45C1BFFD956D6319C72250BC418C9391B79C377391" />
124
+
125
+ <meta name="github_feedback_content_git_url" content="https://github.com/MicrosoftDocs/azure-ai-docs/blob/main/articles/foundry/foundry-models/how-to/use-foundry-models-mai-image.md" />
126
+
127
+ <meta name="markdown_url" content="https://learn.microsoft.com/en-us/azure/foundry/foundry-models/how-to/use-foundry-models-mai-image?accept=text/markdown" />
128
+
129
+ <meta name="cmProducts" content="https://authoring-docs-microsoft.poolparty.biz/devrel/68ec7f3a-2bc6-459f-b959-19beb729907d" data-source="generated" />
130
+
131
+ <meta name="cmProducts" content="https://microsoft-devrel.poolparty.biz/DevRelOfferingOntology/de19c5b8-e208-412e-9238-db3f631dea5b" data-source="generated" />
132
+
133
+ <meta name="cmProducts" content="https://microsoft-devrel.poolparty.biz/DevRelOfferingOntology/cbd33d8f-e9af-440e-8f1e-fc69e07b902b" data-source="generated" />
134
+
135
+ <meta name="spProducts" content="https://authoring-docs-microsoft.poolparty.biz/devrel/90370425-aca4-4a39-9533-d52e5e002a5d" data-source="generated" />
136
+
137
+ <meta name="spProducts" content="https://microsoft-devrel.poolparty.biz/DevRelOfferingOntology/ea7bf5d6-7154-4ba9-8ebc-59117ccacd49" data-source="generated" />
138
+
139
+ <meta name="spProducts" content="https://microsoft-devrel.poolparty.biz/DevRelOfferingOntology/3820371b-086e-47fb-9d1f-b215f569127a" data-source="generated" />
140
+
141
+
142
+ <!-- Apply persisted/system theme before first paint to prevent wrong-theme flash when scripts are deferred. -->
143
+ <script id="theme-preference">
144
+ (function () {
145
+ try {
146
+ var stored = localStorage.getItem('theme');
147
+ var theme = /^(light|dark|high-contrast)$/.test(stored)
148
+ ? stored
149
+ : matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
150
+ document.documentElement.classList.add('theme-' + theme);
151
+ } catch (e) {}
152
+ })();;
153
+ </script>
154
+
155
+ <script id="atlas-layout-preferences">
156
+ (function () {
157
+ try {
158
+ var state = JSON.parse(localStorage.getItem('atlas-layout-preferences') || '{}');
159
+ var view = state["docs-layout-persistence"] || {};
160
+ var excludesKey = "";
161
+ var blocked = {};
162
+ if (excludesKey) {
163
+ var exclusions = JSON.parse(localStorage.getItem('atlas-layout-exclusions') || '{}');
164
+ if (Object.prototype.hasOwnProperty.call(exclusions, excludesKey)) {
165
+ var scoped = exclusions[excludesKey];
166
+ if (scoped) {
167
+ if (typeof scoped === 'object') blocked = scoped;
168
+ }
169
+ }
170
+ }
171
+ var html = document.documentElement;
172
+ for (var c in view) {
173
+ if (Object.prototype.hasOwnProperty.call(blocked, c)) continue;
174
+ if (view[c]) html.classList.add(c);
175
+ else html.classList.remove(c);
176
+ }
177
+ } catch (e) {}
178
+ })();;
179
+ </script>
180
+
181
+ <!-- assets and js globals -->
182
+
183
+ <link rel="stylesheet" href="/static/assets/0.4.03585.8329-a252cb59/styles/site.css" />
184
+
185
+ <script src="https://wcpstatic.microsoft.com/mscc/lib/v2/wcp-consent.js"></script>
186
+ <!-- Keep this URL in sync with oneDSScriptSelector in instrumentation/one-ds.ts. -->
187
+ <script async src="https://js.monitor.azure.com/scripts/c/ms.jsll-4.min.js"></script>
188
+
189
+
190
+ <!-- msdocs global object -->
191
+ <script id="msdocs-script">
192
+ var msDocs = {
193
+ "environment": {
194
+ "accessLevel": "online",
195
+ "azurePortalHostname": "portal.azure.com",
196
+ "reviewFeatures": false,
197
+ "supportLevel": "production",
198
+ "systemContent": true,
199
+ "siteName": "learn",
200
+ "legacyHosting": false
201
+ },
202
+ "data": {
203
+ "contentLocale": "en-us",
204
+ "contentDir": "ltr",
205
+ "userLocale": "en-us",
206
+ "userDir": "ltr",
207
+ "pageTemplate": "Conceptual",
208
+ "layoutStateStorageKey": "docs-layout-persistence",
209
+ "brand": "azure",
210
+ "context": {},
211
+ "standardFeedback": true,
212
+ "showFeedbackReport": false,
213
+ "feedbackHelpLinkType": "get-help-at-qna",
214
+ "feedbackHelpLinkUrl": "https://learn.microsoft.com/answers/tags/133/azure",
215
+ "feedbackSystem": "Standard",
216
+ "feedbackGitHubRepo": "MicrosoftDocs/azure-docs",
217
+ "feedbackProductUrl": "https://feedback.azure.com/d365community/forum/79b1327d-d925-ec11-b6e6-000d3a4f06a4",
218
+ "extendBreadcrumb": false,
219
+ "isEditDisplayable": false,
220
+ "isPrivateUnauthorized": false,
221
+ "hideViewSource": false,
222
+ "isPermissioned": false,
223
+ "hasRecommendations": true
224
+ },
225
+ "functions": {}
226
+ };;
227
+ </script>
228
+
229
+ <!-- base scripts, msdocs global should be before this -->
230
+ <script
231
+ src="/static/assets/0.4.03585.8329-a252cb59/scripts/en-us/index-docs.js"
232
+ async
233
+ ></script>
234
+
235
+
236
+ <!-- json-ld -->
237
+
238
+ <script >bazadebezolkohpepadr="943053816"</script><script type="text/javascript" src="https://learn.microsoft.com/akam/13/3835d9c4" defer></script></head>
239
+
240
+ <body
241
+ id="body"
242
+ data-bi-name="body"
243
+ class="layout-body "
244
+ lang="en-us"
245
+ dir="ltr"
246
+ >
247
+ <header class="layout-body-header background-color-body-medium">
248
+ <div class="header-holder has-default-focus">
249
+
250
+ <a
251
+ href="#main"
252
+
253
+ style="z-index: 1070"
254
+ class="outline-color-text visually-hidden-until-focused position-fixed inner-focus focus-visible top-0 left-0 right-0 padding-xs text-align-center background-color-body"
255
+
256
+ >
257
+ Skip to main content
258
+ </a>
259
+
260
+ <a
261
+ href="#"
262
+ data-skip-to-ask-learn
263
+ style="z-index: 1070"
264
+ class="outline-color-text visually-hidden-until-focused position-fixed inner-focus focus-visible top-0 left-0 right-0 padding-xs text-align-center background-color-body"
265
+ hidden
266
+ >
267
+ Skip to Ask Learn chat experience
268
+ </a>
269
+
270
+
271
+ <div hidden id="cookie-consent-holder" data-test-id="cookie-consent-container"></div>
272
+ <!-- Unsupported browser warning -->
273
+ <div
274
+ id="unsupported-browser"
275
+ style="background-color: white; color: black; padding: 16px; border-bottom: 1px solid grey;"
276
+ hidden
277
+ >
278
+ <div style="max-width: 800px; margin: 0 auto;">
279
+ <p style="font-size: 24px">This browser is no longer supported.</p>
280
+ <p style="font-size: 16px; margin-top: 16px;">
281
+ Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
282
+ </p>
283
+ <div style="margin-top: 12px;">
284
+ <a
285
+ href="https://go.microsoft.com/fwlink/p/?LinkID=2092881 "
286
+ style="background-color: #0078d4; border: 1px solid #0078d4; color: white; padding: 6px 12px; border-radius: 2px; display: inline-block;"
287
+ >
288
+ Download Microsoft Edge
289
+ </a>
290
+ <a
291
+ href="https://learn.microsoft.com/en-us/lifecycle/faq/internet-explorer-microsoft-edge"
292
+ style="background-color: white; padding: 6px 12px; border: 1px solid #505050; color: #171717; border-radius: 2px; display: inline-block;"
293
+ >
294
+ More info about Internet Explorer and Microsoft Edge
295
+ </a>
296
+ </div>
297
+ </div>
298
+ </div>
299
+ <!-- site header -->
300
+ <div
301
+ id="ms--site-header"
302
+ data-test-id="site-header-wrapper"
303
+ itemscope="itemscope"
304
+ itemtype="http://schema.org/Organization"
305
+ >
306
+ <div
307
+ id="ms--mobile-nav"
308
+ class="site-header display-none-tablet padding-inline-none gap-none"
309
+ data-bi-name="mobile-header"
310
+ data-test-id="mobile-header"
311
+ ></div>
312
+ <div
313
+ id="ms--primary-nav"
314
+ class="site-header display-none display-flex-tablet"
315
+ data-bi-name="L1-header"
316
+ data-test-id="primary-header"
317
+ ></div>
318
+ <div
319
+ id="ms--secondary-nav"
320
+ class="site-header display-none display-flex-tablet"
321
+ data-bi-name="L2-header"
322
+ data-test-id="secondary-header"
323
+
324
+ ></div>
325
+ </div>
326
+
327
+ <!-- banner -->
328
+ <div data-banner>
329
+ <div id="disclaimer-holder"></div>
330
+
331
+ </div>
332
+ <!-- banner end -->
333
+
334
+ </div>
335
+ </header>
336
+ <section
337
+ id="layout-body-menu"
338
+ class="layout-body-menu border-right display-flex background-color-body-medium"
339
+ data-bi-name="menu"
340
+ >
341
+
342
+ <div
343
+ id="left-container"
344
+ class="left-container display-none padding-none display-block-tablet width-full display-none-until-layout-restored"
345
+ data-toc-container="true"
346
+ >
347
+ <div
348
+ id="ms--toc-content"
349
+ class="padding-left-sm padding-right-none padding-bottom-sm height-full"
350
+ >
351
+ <nav
352
+ id="affixed-left-container"
353
+ class="margin-top-xxs-tablet position-sticky display-flex flex-direction-column width-full"
354
+ aria-label="Primary"
355
+ data-bi-name="left-toc"
356
+ role="navigation"
357
+ >
358
+ <div
359
+ id="ms--collapsible-toc-header"
360
+ class="display-flex flex-direction-row-reverse justify-content-center align-items-center margin-bottom-xxs margin-right-xxs"
361
+ >
362
+ <button
363
+ type="button"
364
+ class="button button-clear button-sm inner-focus"
365
+ data-collapsible-toc-toggle
366
+ aria-expanded="true"
367
+ hidden
368
+ aria-controls="ms--toc-content"
369
+ aria-label="Table of contents"
370
+ >
371
+ <span class="icon icon-mirrored-rtl" aria-hidden="true">
372
+ <span
373
+ class="docon docon-panel-left-contract display-none-layout-menu-collapsed"
374
+ ></span>
375
+ <span
376
+ class="docon docon-panel-left-expand display-none display-inline-layout-menu-collapsed"
377
+ ></span>
378
+ </span>
379
+ </button>
380
+ <div
381
+ id="ms--collapsible-toc-moniker-slot"
382
+ class="flex-grow-1 display-none-layout-menu-collapsed"
383
+ ></div>
384
+ </div>
385
+ </nav>
386
+ </div>
387
+ </div>
388
+
389
+ </section>
390
+
391
+ <main
392
+ id="main"
393
+ role="main"
394
+ class="layout-body-main "
395
+ data-bi-name="content"
396
+ lang="en-us"
397
+ dir="ltr"
398
+ >
399
+
400
+ <div
401
+ id="ms--content-header"
402
+ class="content-header default-focus border-bottom-none"
403
+ data-bi-name="content-header"
404
+ >
405
+ <div class="content-header-controls margin-xxs margin-inline-sm-tablet">
406
+ <button
407
+ type="button"
408
+ class="contents-button button button-sm margin-right-xxs"
409
+ data-bi-name="contents-expand"
410
+ aria-haspopup="true"
411
+ data-contents-button
412
+ >
413
+ <span class="icon" aria-hidden="true"><span class="docon docon-menu"></span></span>
414
+ <span class="contents-expand-title"> Table of contents </span>
415
+ </button>
416
+ <button
417
+ type="button"
418
+ class="ap-collapse-behavior ap-expanded button button-sm"
419
+ data-bi-name="ap-collapse"
420
+ aria-controls="action-panel"
421
+ >
422
+ <span class="icon" aria-hidden="true"><span class="docon docon-exit-mode"></span></span>
423
+ <span>Exit editor mode</span>
424
+ </button>
425
+ </div>
426
+ </div>
427
+ <div
428
+ id="action-panel"
429
+ role="region"
430
+ aria-label="Action Panel"
431
+ class="action-panel"
432
+ tabindex="-1"
433
+ ></div>
434
+
435
+ <div
436
+ data-main-column
437
+ class="reading-width margin-inline-auto layout-padding padding-top-none padding-top-sm-tablet padding-bottom-sm"
438
+ >
439
+ <div>
440
+
441
+ <div id="article-header" class="background-color-body margin-bottom-xs display-none-print">
442
+ <div class="display-flex align-items-center justify-content-space-between">
443
+
444
+ <details
445
+ id="article-header-breadcrumbs-overflow-popover"
446
+ class="popover popover-left"
447
+ data-for="article-header-breadcrumbs"
448
+ >
449
+ <summary
450
+ class="button button-clear button-primary button-sm inner-focus"
451
+ aria-label="All breadcrumbs"
452
+ >
453
+ <span class="icon" aria-hidden="true">
454
+ <span class="docon docon-more"></span>
455
+ </span>
456
+ </summary>
457
+ <div id="article-header-breadcrumbs-overflow" class="popover-content"></div>
458
+ </details>
459
+
460
+ <bread-crumbs
461
+ id="article-header-breadcrumbs"
462
+ role="group"
463
+ aria-label="Breadcrumbs"
464
+ data-test-id="article-header-breadcrumbs"
465
+ class="overflow-hidden flex-grow-1 margin-right-sm margin-right-md-tablet margin-right-lg-desktop margin-left-negative-xxs padding-left-xxs"
466
+ ></bread-crumbs>
467
+
468
+ <div
469
+ id="article-header-page-actions"
470
+ class="opacity-none margin-left-auto display-flex flex-wrap-no-wrap align-items-stretch"
471
+ >
472
+
473
+ <button
474
+ class="button button-sm border-none inner-focus display-none-tablet flex-shrink-0 "
475
+ data-bi-name="ask-learn-assistant-entry"
476
+ data-test-id="ask-learn-assistant-modal-entry-mobile"
477
+ data-ask-learn-modal-entry
478
+
479
+ type="button"
480
+ style="min-width: max-content;"
481
+ aria-expanded="false"
482
+ aria-label="Ask Learn"
483
+ hidden
484
+ >
485
+ <span class="icon" aria-hidden="true">
486
+ <span class="docon docon-chat-sparkle-fill gradient-ask-learn-logo"></span>
487
+ </span>
488
+ </button>
489
+ <button
490
+ class="button button-sm display-none display-inline-flex-tablet display-none-desktop flex-shrink-0 margin-right-xxs border-color-ask-learn "
491
+ data-bi-name="ask-learn-assistant-entry"
492
+
493
+ data-test-id="ask-learn-assistant-modal-entry-tablet"
494
+ data-ask-learn-modal-entry
495
+ type="button"
496
+ style="min-width: max-content;"
497
+ aria-expanded="false"
498
+ hidden
499
+ >
500
+ <span class="icon font-size-lg" aria-hidden="true">
501
+ <span class="docon docon-chat-sparkle-fill gradient-ask-learn-logo"></span>
502
+ </span>
503
+ <span>Ask Learn</span>
504
+ </button>
505
+ <button
506
+ class="button button-sm display-none flex-shrink-0 display-inline-flex-desktop margin-right-xxs border-color-ask-learn "
507
+ data-bi-name="ask-learn-assistant-entry"
508
+
509
+ data-test-id="ask-learn-assistant-flyout-entry"
510
+ data-ask-learn-flyout-entry
511
+ data-flyout-button="toggle"
512
+ type="button"
513
+ style="min-width: max-content;"
514
+ aria-expanded="false"
515
+ aria-controls="ask-learn-flyout"
516
+ hidden
517
+ >
518
+ <span class="icon font-size-lg" aria-hidden="true">
519
+ <span class="docon docon-chat-sparkle-fill gradient-ask-learn-logo"></span>
520
+ </span>
521
+ <span>Ask Learn</span>
522
+ </button>
523
+
524
+
525
+ <details class="popover popover-right" id="article-header-page-actions-overflow">
526
+ <summary
527
+ class="justify-content-flex-start button button-clear button-sm button-primary inner-focus"
528
+ aria-label="More actions"
529
+ aria-expanded="false"
530
+ title="More actions"
531
+ >
532
+ <span class="icon" aria-hidden="true">
533
+ <span class="docon docon-more-vertical"></span>
534
+ </span>
535
+ </summary>
536
+ <div class="popover-content">
537
+
538
+ <button
539
+ type="button"
540
+ id="ms--focus-mode-button"
541
+ data-focus-mode
542
+ data-bi-name="focus-mode-entry"
543
+ data-page-action-item="overflow-all"
544
+ data-popover-close
545
+ class="button button-clear button-sm button-block justify-content-flex-start text-align-left inner-focus display-none display-inline-flex-tablet"
546
+ >
547
+ <span class="icon" aria-hidden="true">
548
+ <span class="docon docon-glasses"></span>
549
+ </span>
550
+ <span>Reading mode</span>
551
+ </button>
552
+
553
+ <button
554
+ data-page-action-item="overflow-mobile"
555
+ type="button"
556
+ class="display-block-layout-menu-collapsed button-block button-sm inner-focus button button-clear display-none-tablet justify-content-flex-start text-align-left"
557
+ data-bi-name="contents-expand"
558
+ data-contents-button
559
+ data-popover-close
560
+ >
561
+ <span class="icon" aria-hidden="true"
562
+ ><span class="docon docon-editor-list-bullet"></span
563
+ ></span>
564
+ <span class="contents-expand-title">Table of contents</span>
565
+ </button>
566
+
567
+ <a
568
+ id="lang-link-overflow"
569
+ class="button-sm inner-focus button button-clear button-block justify-content-flex-start text-align-left"
570
+ data-bi-name="language-toggle"
571
+ data-page-action-item="overflow-all"
572
+ data-check-hidden="true"
573
+ data-read-in-link
574
+ href="#"
575
+ hidden
576
+ >
577
+ <span class="icon" aria-hidden="true" data-read-in-link-icon>
578
+ <span class="docon docon-locale-globe"></span>
579
+ </span>
580
+ <span data-read-in-link-text>Read in English</span>
581
+ </a>
582
+
583
+
584
+ <button
585
+ type="button"
586
+ class="collection button button-clear button-sm button-block justify-content-flex-start text-align-left inner-focus"
587
+ data-list-type="collection"
588
+ data-bi-name="collection"
589
+ data-page-action-item="overflow-all"
590
+ data-check-hidden="true"
591
+ data-popover-close
592
+ >
593
+ <span class="icon" aria-hidden="true">
594
+ <span class="docon docon-circle-addition"></span>
595
+ </span>
596
+ <span class="collection-status">Add</span>
597
+ </button>
598
+
599
+ <button
600
+ type="button"
601
+ class="collection button button-block button-clear button-sm justify-content-flex-start text-align-left inner-focus"
602
+ data-list-type="plan"
603
+ data-bi-name="plan"
604
+ data-page-action-item="overflow-all"
605
+ data-check-hidden="true"
606
+ data-popover-close
607
+ hidden
608
+ >
609
+ <span class="icon" aria-hidden="true">
610
+ <span class="docon docon-circle-addition"></span>
611
+ </span>
612
+ <span class="plan-status">Add to Plans</span>
613
+ </button>
614
+
615
+
616
+ <a
617
+ data-contenteditbtn
618
+ class="button button-clear button-block button-sm inner-focus justify-content-flex-start text-align-left text-decoration-none"
619
+ data-bi-name="edit"
620
+ data-page-action-item="overflow-all"
621
+ data-check-hidden="true"
622
+ hidden
623
+ href="https://github.com/MicrosoftDocs/azure-ai-docs/blob/main/articles/foundry/foundry-models/how-to/use-foundry-models-mai-image.md"
624
+ data-original_content_git_url="https://github.com/MicrosoftDocs/azure-ai-docs-pr/blob/live/articles/foundry/foundry-models/how-to/use-foundry-models-mai-image.md"
625
+ data-original_content_git_url_template="{repo}/blob/{branch}/articles/foundry/foundry-models/how-to/use-foundry-models-mai-image.md"
626
+ data-pr_repo=""
627
+ data-pr_branch=""
628
+ >
629
+ <span class="icon" aria-hidden="true">
630
+ <span class="docon docon-edit-outline"></span>
631
+ </span>
632
+ <span>Edit</span>
633
+ </a>
634
+
635
+ <hr class="margin-block-xxs" />
636
+
637
+ <button
638
+ class="button button-block button-clear button-sm justify-content-flex-start text-align-left inner-focus"
639
+ type="button"
640
+ data-bi-name="copy-markdown"
641
+ data-page-action-item="overflow-all"
642
+ data-copy-markdown
643
+ data-copy-state="idle"
644
+ data-check-hidden="true"
645
+ >
646
+ <span class="icon color-primary" aria-hidden="true">
647
+ <span data-show-when="idle" class="docon docon-code-lang"></span>
648
+ <span data-show-when="loading" class="loader" hidden></span>
649
+ <span data-show-when="success" class="docon docon-check-mark" hidden></span>
650
+ </span>
651
+ <span>Copy Markdown</span>
652
+ </button>
653
+
654
+ <button
655
+ class="button button-block button-clear button-sm justify-content-flex-start text-align-left inner-focus"
656
+ type="button"
657
+ data-bi-name="print"
658
+ data-page-action-item="overflow-all"
659
+ data-popover-close
660
+ data-print-page
661
+ data-check-hidden="true"
662
+ >
663
+ <span class="icon color-primary" aria-hidden="true">
664
+ <span class="docon docon-print"></span>
665
+ </span>
666
+ <span>Print</span>
667
+ </button>
668
+
669
+
670
+ </div>
671
+ </details>
672
+ </div>
673
+
674
+ </div>
675
+ </div>
676
+
677
+ <!-- privateUnauthorizedTemplate is hidden by default -->
678
+ <div unauthorized-private-section data-bi-name="permission-content-unauthorized-private" hidden>
679
+ <hr class="hr margin-top-xs margin-bottom-sm" />
680
+ <div class="notification notification-info">
681
+ <div class="notification-content">
682
+ <p class="margin-top-none notification-title">
683
+ <span class="icon" aria-hidden="true"
684
+ ><span class="docon docon-exclamation-circle-solid"></span
685
+ ></span>
686
+ <span>Note</span>
687
+ </p>
688
+ <p class="margin-top-none authentication-determined not-authenticated">
689
+ Access to this page requires authorization. You can try <a class="docs-sign-in" href="#" data-bi-name="permission-content-sign-in">signing in</a> or <a class="docs-change-directory" data-bi-name="permisson-content-change-directory">changing directories</a>.
690
+ </p>
691
+ <p class="margin-top-none authentication-determined authenticated">
692
+ Access to this page requires authorization. You can try <a class="docs-change-directory" data-bi-name="permisson-content-change-directory">changing directories</a>.
693
+ </p>
694
+ </div>
695
+ </div>
696
+ </div>
697
+
698
+ <div class="content"><h1 id="deploy-and-use-mai-image-models-in-microsoft-foundry-preview">Deploy and use MAI image models in Microsoft Foundry (preview)</h1></div>
699
+
700
+ <div
701
+ id="article-metadata"
702
+ data-bi-name="article-metadata"
703
+ data-test-id="article-metadata"
704
+ class="page-metadata-container display-flex gap-xxs justify-content-space-between align-items-center flex-wrap-wrap"
705
+ >
706
+
707
+ <div
708
+ id="user-feedback"
709
+ class="margin-block-xxs display-none display-none-print"
710
+ hidden
711
+ data-hide-on-archived
712
+ >
713
+
714
+ <button
715
+ id="user-feedback-button"
716
+ data-test-id="conceptual-feedback-button"
717
+ class="button button-sm button-clear button-primary display-none"
718
+ type="button"
719
+ data-bi-name="user-feedback-button"
720
+ data-user-feedback-button
721
+ hidden
722
+ >
723
+ <span class="icon" aria-hidden="true">
724
+ <span class="docon docon-like"></span>
725
+ </span>
726
+ <span>Feedback</span>
727
+ </button>
728
+
729
+ </div>
730
+
731
+ </div>
732
+
733
+ <div data-id="ai-summary" class="display-none-print">
734
+ <div id="ms--ai-summary-cta" class="margin-top-xs display-flex align-items-center">
735
+ <span class="icon" aria-hidden="true">
736
+ <span class="docon docon-sparkle-fill gradient-text-vivid"></span>
737
+ </span>
738
+ <button
739
+ id="ms--ai-summary"
740
+ type="button"
741
+ class="tag tag-sm tag-suggestion margin-left-xxs"
742
+ data-test-id="ai-summary-cta"
743
+ data-bi-name="ai-summary-cta"
744
+ data-an="ai-summary"
745
+ >
746
+ <span class="ai-summary-cta-text">
747
+ Summarize this article for me
748
+ </span>
749
+ </button>
750
+ </div>
751
+ <!-- Slot where the client will render the summary card after the user clicks the CTA -->
752
+ <div id="ms--ai-summary-header" class="margin-top-xs"></div>
753
+ </div>
754
+
755
+ <nav
756
+ id="center-doc-outline"
757
+ class="doc-outline display-none-desktop display-none-print margin-bottom-sm"
758
+ data-bi-name="intopic toc"
759
+ aria-label="In this article"
760
+ >
761
+ <h2 id="ms--in-this-article" class="title is-6 margin-block-xs">
762
+ In this article
763
+ </h2>
764
+ </nav>
765
+ <div class="content"><div class="IMPORTANT">
766
+ <p>Important</p>
767
+ <p>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 <a href="https://azure.microsoft.com/support/legal/preview-supplemental-terms/" data-linktype="external">Supplemental Terms of Use for Microsoft Azure Previews</a>.</p>
768
+ </div>
769
+ <p>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.</p>
770
+ <p>In this article, you learn how to:</p>
771
+ <ul>
772
+ <li>Deploy MAI image models in Microsoft Foundry</li>
773
+ <li>Authenticate by using Microsoft Entra ID or API keys</li>
774
+ <li>Generate images by using the MAI image generations API</li>
775
+ <li>Run an image edit by using the MAI image edits API</li>
776
+ </ul>
777
+ <h2 id="prerequisites">Prerequisites</h2>
778
+ <ul>
779
+ <li>An Azure subscription with a valid payment method. If you don't have an Azure subscription, create a <a href="https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn" data-linktype="external">paid Azure account</a>.</li>
780
+ <li>Access to Microsoft Foundry with appropriate permissions to create and manage resources.</li>
781
+ <li>A <a href="../../how-to/create-projects" data-linktype="relative-path">Microsoft Foundry project</a> in a region supported for the MAI image model you want to deploy. For each model's supported deployment regions, see <a href="../concepts/models-sold-directly-by-azure-region-availability" data-linktype="relative-path">Region availability for Foundry Models sold by Azure</a>.</li>
782
+ <li><strong>Cognitive Services Contributor</strong> role on the Azure AI Foundry resource to deploy models. For more information, see <a href="/en-us/azure/role-based-access-control/built-in-roles" data-linktype="absolute-path">Azure RBAC roles</a>.</li>
783
+ </ul>
784
+ <h2 id="mai-image-models-at-a-glance">MAI image models at a glance</h2>
785
+ <p>MAI image models in Microsoft Foundry include:</p>
786
+ <table>
787
+ <thead>
788
+ <tr>
789
+ <th>Model name</th>
790
+ <th>Model version</th>
791
+ <th>Deployment type</th>
792
+ <th>API type</th>
793
+ </tr>
794
+ </thead>
795
+ <tbody>
796
+ <tr>
797
+ <td><code>MAI-Image-2.6-Flash</code> (Preview)</td>
798
+ <td><code>2026-07-31</code></td>
799
+ <td>Global Standard</td>
800
+ <td>Text-to-image generation<br> Image-to-image edits</td>
801
+ </tr>
802
+ <tr>
803
+ <td><code>MAI-Image-2.6</code> (Preview)</td>
804
+ <td><code>2026-07-31</code></td>
805
+ <td>Global Standard</td>
806
+ <td>Text-to-image generation<br> Image-to-image edits</td>
807
+ </tr>
808
+ <tr>
809
+ <td><code>MAI-Image-2.5-Pro</code> (Preview)</td>
810
+ <td><code>2026-06-19</code></td>
811
+ <td>Global Standard</td>
812
+ <td>Text-to-image generation<br> Image-to-image edits</td>
813
+ </tr>
814
+ <tr>
815
+ <td><code>MAI-Image-2.5-Flash</code> (Preview)</td>
816
+ <td><code>2026-06-02</code></td>
817
+ <td>Global Standard</td>
818
+ <td>Text-to-image generation<br> Image-to-image edits</td>
819
+ </tr>
820
+ <tr>
821
+ <td><code>MAI-Image-2.5</code> (Preview)</td>
822
+ <td><code>2026-06-02</code></td>
823
+ <td>Global Standard</td>
824
+ <td>Text-to-image generation<br> Image-to-image edits</td>
825
+ </tr>
826
+ </tbody>
827
+ </table>
828
+ <p>For each model's supported deployment regions, see <a href="../concepts/models-sold-directly-by-azure-region-availability" data-linktype="relative-path">Region availability for Foundry Models sold by Azure</a>.</p>
829
+ <p>To learn more about the individual models, see <a href="#mai-image-model-capabilities" data-linktype="self-bookmark">MAI image model capabilities</a>.</p>
830
+ <h2 id="deploy-mai-image-models">Deploy MAI image models</h2>
831
+ <p>To deploy an MAI image model, follow the instructions in <a href="deploy-foundry-models" data-linktype="relative-path">Deploy Microsoft Foundry Models in the Foundry portal</a>.</p>
832
+ <p>Alternatively, you can deploy the model by using the Azure CLI. The following code shows deployment of <code>MAI-Image-2.5</code>. To deploy a different model, replace the model name and version in the lines <code>--model-name MAI-Image-2.5</code> and <code>--model-version 2026-06-02</code> with the values for your desired model.</p>
833
+ <p>Replace <code>&lt;ACCOUNT_NAME&gt;</code>, <code>&lt;RESOURCE_GROUP&gt;</code>, <code>&lt;DEPLOYMENT_NAME&gt;</code> with your values.</p>
834
+ <pre><code class="lang-bash">az cognitiveservices account deployment create \
835
+ --name &lt;ACCOUNT_NAME&gt; \
836
+ --resource-group &lt;RESOURCE_GROUP&gt; \
837
+ --deployment-name &lt;DEPLOYMENT_NAME&gt; \
838
+ --model-name "MAI-Image-2.5" \
839
+ --model-format Microsoft \
840
+ --model-version 2026-06-02 \
841
+ --sku-name GlobalStandard \
842
+ --sku-capacity 1
843
+ </code></pre>
844
+ <p><strong>Reference:</strong> <a href="/en-us/cli/azure/cognitiveservices/account/deployment#az-cognitiveservices-account-deployment-create" data-linktype="absolute-path">az cognitiveservices account deployment create</a></p>
845
+ <p>To list all available deployments on your resource:</p>
846
+ <pre><code class="lang-bash">az cognitiveservices account deployment list \
847
+ --resource-group &lt;RESOURCE_GROUP&gt; \
848
+ --name &lt;ACCOUNT_NAME&gt; \
849
+ -o table
850
+ </code></pre>
851
+ <p><strong>Reference:</strong> <a href="/en-us/cli/azure/cognitiveservices/account/deployment#az-cognitiveservices-account-deployment-list" data-linktype="absolute-path">az cognitiveservices account deployment list</a></p>
852
+ <p>After deployment, use the <a href="../../concepts/concept-playgrounds" data-linktype="relative-path">Foundry playground</a> to interactively test the model.</p>
853
+ <h2 id="run-text-to-image-generation">Run text-to-image generation</h2>
854
+ <p>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.</p>
855
+ <p>The following example shows how to generate an image from a text prompt using an MAI image model with the <a href="#api-endpoints" data-linktype="self-bookmark">MAI image generations API</a>.</p>
856
+ <div class="tabGroup" id="tabgroup_1">
857
+ <ul role="tablist">
858
+ <li role="presentation">
859
+ <a href="#tabpanel_1_python" role="tab" aria-controls="tabpanel_1_python" data-tab="python" tabindex="0" aria-selected="true" data-linktype="self-bookmark">Python</a>
860
+ </li>
861
+ <li role="presentation">
862
+ <a href="#tabpanel_1_rest-api" role="tab" aria-controls="tabpanel_1_rest-api" data-tab="rest-api" tabindex="-1" data-linktype="self-bookmark">REST API</a>
863
+ </li>
864
+ </ul>
865
+ <section id="tabpanel_1_python" role="tabpanel" data-tab="python">
866
+ <h4 id="use-api-key-authentication">Use API key authentication</h4>
867
+ <ol>
868
+ <li><p><strong>Install the <code>requests</code> library:</strong></p>
869
+ <pre><code class="lang-bash">pip install requests
870
+ </code></pre>
871
+ </li>
872
+ <li><p><strong>Set environment variables:</strong></p>
873
+ <pre><code class="lang-bash">export AZURE_ENDPOINT="https://&lt;resource-name&gt;.services.ai.azure.com"
874
+ export AZURE_API_KEY="&lt;your-api-key&gt;"
875
+ export DEPLOYMENT_NAME="&lt;your-deployment-name&gt;"
876
+ </code></pre>
877
+ </li>
878
+ <li><p><strong>Run the following code:</strong></p>
879
+ <pre><code class="lang-python">import os
880
+ import base64
881
+ import requests
882
+
883
+ endpoint = os.environ["AZURE_ENDPOINT"]
884
+ api_key = os.environ["AZURE_API_KEY"]
885
+ deployment_name = os.environ["DEPLOYMENT_NAME"]
886
+
887
+ width = 1024
888
+ height = 1024
889
+
890
+ url = f"{endpoint}/mai/v1/images/generations"
891
+
892
+ payload = {
893
+ "model": deployment_name,
894
+ "prompt": "A photorealistic concept art poster of a university at sunset, cinematic lighting",
895
+ "width": width,
896
+ "height": height
897
+ }
898
+
899
+ response = requests.post(
900
+ url,
901
+ headers={
902
+ "Content-Type": "application/json",
903
+ "api-key": api_key,
904
+ },
905
+ json=payload,
906
+ )
907
+ response.raise_for_status()
908
+
909
+ result = response.json()
910
+ print(result)
911
+
912
+ image_data = [
913
+ output
914
+ for output in result.get("data", [])
915
+ if "b64_json" in output
916
+ ]
917
+
918
+ if image_data:
919
+ image_base64 = image_data[0]["b64_json"]
920
+ output_path = "output.png"
921
+ with open(output_path, "wb") as f:
922
+ f.write(base64.b64decode(image_base64))
923
+ print(f"Image saved to {output_path}")
924
+ else:
925
+ print("Unexpected response format:", result)
926
+ </code></pre>
927
+ <p><strong>Expected output:</strong> A JSON response containing the generated image data in base64 format. The response includes the image data, which you decode and save as <code>output.png</code> in the current directory. For more information, see <a href="#response-format" data-linktype="self-bookmark">Response format</a>.</p>
928
+ </li>
929
+ </ol>
930
+ <h4 id="use-microsoft-entra-id-authentication">Use Microsoft Entra ID authentication</h4>
931
+ <p>To use Microsoft Entra ID instead of an API key, replace the <code>api-key</code> header with a bearer token obtained using the <code>DefaultAzureCredential</code>:</p>
932
+ <ol>
933
+ <li><p><strong>Install the Azure Identity library:</strong></p>
934
+ <pre><code class="lang-bash">pip install azure-identity
935
+ </code></pre>
936
+ </li>
937
+ <li><p><strong>Update the request headers in the API key authentication code:</strong></p>
938
+ <pre><code class="lang-python">from azure.identity import DefaultAzureCredential, get_bearer_token_provider
939
+
940
+ token_provider = get_bearer_token_provider(
941
+ DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"
942
+ )
943
+ token = token_provider()
944
+
945
+ headers = {
946
+ "Content-Type": "application/json",
947
+ "Authorization": f"Bearer {token}",
948
+ }
949
+ </code></pre>
950
+ <p><strong>Reference:</strong> <a href="/en-us/python/api/azure-identity/azure.identity.defaultazurecredential" data-linktype="absolute-path">DefaultAzureCredential</a></p>
951
+ </li>
952
+ </ol>
953
+ </section>
954
+ <section id="tabpanel_1_rest-api" role="tabpanel" data-tab="rest-api" aria-hidden="true" hidden="hidden">
955
+ <h4 id="use-api-key-authentication-1">Use API key authentication</h4>
956
+ <p>Export your endpoint and API key, then run the following cURL command:</p>
957
+ <pre><code class="lang-bash">export AZURE_API_KEY="&lt;your-api-key&gt;"
958
+ export DEPLOYMENT_NAME="&lt;your-deployment-name&gt;"
959
+ </code></pre>
960
+ <pre><code class="lang-sh">curl -X POST "https://&lt;resource-name&gt;.services.ai.azure.com/mai/v1/images/generations" \
961
+ -H "Content-Type: application/json" \
962
+ -H "api-key: $AZURE_API_KEY" \
963
+ -d '{
964
+ "model": "'"$DEPLOYMENT_NAME"'",
965
+ "prompt": "A photorealistic concept art poster of a university at sunset, cinematic lighting",
966
+ "width": 1024,
967
+ "height": 1024
968
+ }' \
969
+ | jq -r '.data[0].b64_json' \
970
+ | base64 --decode &gt; output.png
971
+ </code></pre>
972
+ <p><strong>Expected output:</strong> A JSON response containing the generated image data in base64 format. The response includes the image data, which you decode and save as <code>output.png</code> in the current directory. For more information, see <a href="#response-format" data-linktype="self-bookmark">Response format</a>.</p>
973
+ <h4 id="use-microsoft-entra-id-authentication-1">Use Microsoft Entra ID authentication</h4>
974
+ <p>Replace the <code>api-key</code> header with an <code>Authorization</code> header:</p>
975
+ <pre><code class="lang-sh">-H "Authorization: Bearer $AZURE_AUTH_TOKEN"
976
+ </code></pre>
977
+ <p>Where <code>AZURE_AUTH_TOKEN</code> is a valid Microsoft Entra ID token scoped to <code>https://cognitiveservices.azure.com/.default</code>.</p>
978
+ </section>
979
+ </div>
980
+ <h2 id="run-an-image-to-image-edit">Run an image-to-image edit</h2>
981
+ <p>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.
982
+ For the list of models that support image-to-image edits, see <a href="#mai-image-models-at-a-glance" data-linktype="self-bookmark">MAI image models at a glance</a>.</p>
983
+ <p>The following example shows how to perform an image-to-image edit by using an MAI image model with the <a href="#api-endpoints" data-linktype="self-bookmark">MAI image edits API</a>.</p>
984
+ <div class="NOTE">
985
+ <p>Note</p>
986
+ <p>Requests for image-to-image edits use <strong>multipart form data</strong> and accept up to five reference images. Repeat the <code>image</code> field for each file.</p>
987
+ </div>
988
+ <div class="tabGroup" id="tabgroup_2">
989
+ <ul role="tablist">
990
+ <li role="presentation">
991
+ <a href="#tabpanel_2_python" role="tab" aria-controls="tabpanel_2_python" data-tab="python" tabindex="0" aria-selected="true" data-linktype="self-bookmark">Python</a>
992
+ </li>
993
+ <li role="presentation">
994
+ <a href="#tabpanel_2_rest-api" role="tab" aria-controls="tabpanel_2_rest-api" data-tab="rest-api" tabindex="-1" data-linktype="self-bookmark">REST API</a>
995
+ </li>
996
+ </ul>
997
+ <section id="tabpanel_2_python" role="tabpanel" data-tab="python">
998
+ <h4 id="use-api-key-authentication-2">Use API key authentication</h4>
999
+ <ol>
1000
+ <li><p><strong>Install the <code>requests</code> library:</strong></p>
1001
+ <pre><code class="lang-bash">pip install requests
1002
+ </code></pre>
1003
+ </li>
1004
+ <li><p><strong>Set environment variables:</strong></p>
1005
+ <pre><code class="lang-bash">export AZURE_ENDPOINT="https://&lt;resource-name&gt;.services.ai.azure.com"
1006
+ export AZURE_API_KEY="&lt;your-api-key&gt;"
1007
+ export DEPLOYMENT_NAME="&lt;your-deployment-name&gt;"
1008
+ </code></pre>
1009
+ </li>
1010
+ <li><p><strong>Run the following code:</strong></p>
1011
+ <pre><code class="lang-python">import os
1012
+ import base64
1013
+ import requests
1014
+
1015
+ endpoint = os.environ["AZURE_ENDPOINT"]
1016
+ api_key = os.environ["AZURE_API_KEY"]
1017
+ deployment_name = os.environ["DEPLOYMENT_NAME"]
1018
+
1019
+ width = 1024
1020
+ height = 1024
1021
+
1022
+ url = f"{endpoint}/mai/v1/images/edits"
1023
+
1024
+ files = [
1025
+ ("image", ("first.png", open("first.png", "rb"), "image/png")),
1026
+ ("image", ("second.png", open("second.png", "rb"), "image/png")),
1027
+ ]
1028
+
1029
+ payload={
1030
+ "model": deployment_name,
1031
+ "prompt": "Combine both source images into a clean futuristic product shot",
1032
+ }
1033
+
1034
+ response = requests.post(
1035
+ url,
1036
+ headers={
1037
+ "api-key": api_key,
1038
+ },
1039
+ data=payload,
1040
+ files=files
1041
+ )
1042
+
1043
+ response.raise_for_status()
1044
+
1045
+ result = response.json()
1046
+ print(result)
1047
+
1048
+
1049
+ image_data = [
1050
+ output
1051
+ for output in result.get("data", [])
1052
+ if "b64_json" in output
1053
+ ]
1054
+
1055
+ if image_data:
1056
+ image_base64 = image_data[0]["b64_json"]
1057
+ output_path = "output.png"
1058
+ with open(output_path, "wb") as f:
1059
+ f.write(base64.b64decode(image_base64))
1060
+ print(f"Image saved to {output_path}")
1061
+ else:
1062
+ print("Unexpected response format:", result)
1063
+ </code></pre>
1064
+ <p><strong>Expected output:</strong> A JSON response containing the edited image data in base64 format. The response includes the image data, which you decode and save as <code>output.png</code> in the current directory. For more information, see <a href="#response-format" data-linktype="self-bookmark">Response format</a>.</p>
1065
+ </li>
1066
+ </ol>
1067
+ <p>To use Microsoft Entra ID instead of an API key, modify this code as described in the earlier section: <a href="#use-microsoft-entra-id-authentication" data-linktype="self-bookmark">Use Microsoft Entra ID authentication</a>.</p>
1068
+ </section>
1069
+ <section id="tabpanel_2_rest-api" role="tabpanel" data-tab="rest-api" aria-hidden="true" hidden="hidden">
1070
+ <h4 id="use-api-key-authentication-3">Use API key authentication</h4>
1071
+ <p>Export your endpoint and API key, then run the following cURL command:</p>
1072
+ <pre><code class="lang-bash">export AZURE_API_KEY="&lt;your-api-key&gt;"
1073
+ export DEPLOYMENT_NAME="&lt;your-deployment-name&gt;"
1074
+ </code></pre>
1075
+ <pre><code class="lang-sh">curl -X POST "https://&lt;resource-name&gt;.services.ai.azure.com/mai/v1/images/edits" \
1076
+ -H "api-key: $AZURE_API_KEY" \
1077
+ -F "model=$DEPLOYMENT_NAME" \
1078
+ -F "prompt=Combine both source images into a clean futuristic product shot" \
1079
+ -F "image=@first.png;type=image/png" \
1080
+ -F "image=@second.png;type=image/png" \
1081
+ | jq -r '.data[0].b64_json' \
1082
+ | base64 --decode &gt; output.png
1083
+ </code></pre>
1084
+ <p><strong>Expected output:</strong> A JSON response containing the edited image data in base64 format. The response includes the image data, which you decode and save as <code>output.png</code> in the current directory. For more information, see <a href="#response-format" data-linktype="self-bookmark">Response format</a>.</p>
1085
+ <p>To use Microsoft Entra ID authentication instead of an API key, modify this code as described in the earlier section: <a href="#use-microsoft-entra-id-authentication-1" data-linktype="self-bookmark">Use Microsoft Entra ID authentication</a></p>
1086
+ </section>
1087
+ </div>
1088
+ <h2 id="mai-image-model-capabilities">MAI image model capabilities</h2>
1089
+ <p>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.</p>
1090
+ <h3 id="core-capabilities">Core capabilities</h3>
1091
+ <p>All MAI image models in this article share these core capabilities:</p>
1092
+ <ul>
1093
+ <li><strong>Text-to-image generation:</strong> 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.</li>
1094
+ <li><strong>Image-to-image editing:</strong> Supports precise, controllable edits to existing images, including object removal, replacement, attribute changes, inpainting, text updates, and artifact cleanup while preserving composition and layout.</li>
1095
+ <li><strong>Photorealistic image synthesis:</strong> Generates realistic imagery with consistent visual structure, making it suitable for concept visualization and content creation scenarios.</li>
1096
+ <li><strong>High-fidelity portraits:</strong> Generates expressive, natural-looking portraits with accurate facial structure, lighting, and texture.</li>
1097
+ <li><strong>Product, branding, and commercial design:</strong> Well suited for product imagery, marketing visuals, brand assets, and commercial creative workflows.</li>
1098
+ <li><strong>Accurate text rendering:</strong> Improved rendering of text within generated images, including labels, posters, packaging, and signage.</li>
1099
+ <li><strong>Visual reasoning:</strong> Reasons across objects, scene structure, lighting, scale, and spatial positioning to produce consistent outputs, even from ambiguous prompts.</li>
1100
+ </ul>
1101
+ <p>The following table highlights what distinguishes each model and the scenarios it best fits.</p>
1102
+ <table>
1103
+ <thead>
1104
+ <tr>
1105
+ <th>Model</th>
1106
+ <th>Key capabilities</th>
1107
+ <th>Best for</th>
1108
+ </tr>
1109
+ </thead>
1110
+ <tbody>
1111
+ <tr>
1112
+ <td><code>MAI-Image-2.6-Flash</code> (Preview)</td>
1113
+ <td>Same generation and editing capabilities as <code>MAI-Image-2.6</code>, offered as a faster, lower-cost variant.</td>
1114
+ <td>The same scenarios as <code>MAI-Image-2.6</code> when you need lower cost and faster generation.</td>
1115
+ </tr>
1116
+ <tr>
1117
+ <td><code>MAI-Image-2.6</code> (Preview)</td>
1118
+ <td><a href="#core-capabilities" data-linktype="self-bookmark">Core capabilities</a>, with stronger text rendering, improved portraits and 3D imagery, and more polished commercial and photorealistic output.</td>
1119
+ <td>Projects that need the latest quality gains in text rendering, portraits, and commercial or photorealistic imagery.</td>
1120
+ </tr>
1121
+ <tr>
1122
+ <td><code>MAI-Image-2.5-Pro</code> (Preview)</td>
1123
+ <td>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.</td>
1124
+ <td>Visually dense compositions that require consistent object identity, materials, and spatial relationships.</td>
1125
+ </tr>
1126
+ <tr>
1127
+ <td><code>MAI-Image-2.5-Flash</code> (Preview)</td>
1128
+ <td>Same generation and editing capabilities as <code>MAI-Image-2.5</code>, offered as a faster, lower-cost variant.</td>
1129
+ <td>Concept visualization, creative content generation, image editing workflows, and production design when you need lower cost and faster generation.</td>
1130
+ </tr>
1131
+ <tr>
1132
+ <td><code>MAI-Image-2.5</code> (Preview)</td>
1133
+ <td><a href="#core-capabilities" data-linktype="self-bookmark">Core capabilities</a>.</td>
1134
+ <td>Concept visualization, creative content generation, image editing workflows, and production design.</td>
1135
+ </tr>
1136
+ </tbody>
1137
+ </table>
1138
+ <p>For more details, see the individual <a href="https://ai.azure.com/catalog/models/?publisher=microsoft" data-linktype="external">model cards in the Foundry model catalog</a> and the capabilities comparison table in <a href="../concepts/models-sold-directly-by-azure" data-linktype="relative-path">Foundry Models sold by Azure</a>.</p>
1139
+ <h2 id="api-endpoints">API endpoints</h2>
1140
+ <p>After you deploy an MAI image model, use the <strong>MAI image generations API</strong> to generate images and the <strong>MAI image edits API</strong> for image-to-image edits.</p>
1141
+ <ul>
1142
+ <li><p><strong>Image generations API endpoint</strong>: A Microsoft-managed endpoint that accepts a text prompt and returns a PNG image. The API endpoint has the following form:</p>
1143
+ <pre><code>https://&lt;resource-name&gt;.services.ai.azure.com/mai/v1/images/generations
1144
+ </code></pre>
1145
+ </li>
1146
+ <li><p><strong>Image edits API endpoint</strong>: 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:</p>
1147
+ <pre><code>https://&lt;resource-name&gt;.services.ai.azure.com/mai/v1/images/edits
1148
+ </code></pre>
1149
+ </li>
1150
+ </ul>
1151
+ <p>To authenticate, you need your <strong>resource endpoint</strong> and either a <strong>Microsoft Entra ID token</strong> or an <strong>API key</strong>. You can find these values in the <strong>Keys and Endpoint</strong> section of your resource in the Azure portal, or on the deployment details page in the <a href="https://ai.azure.com" data-linktype="external">Foundry portal</a>.</p>
1152
+ <h4 id="request-parameters">Request parameters</h4>
1153
+ <p>The following table lists the request parameters for the image APIs:</p>
1154
+ <table>
1155
+ <thead>
1156
+ <tr>
1157
+ <th>Parameter</th>
1158
+ <th>API</th>
1159
+ <th>Type</th>
1160
+ <th>Required</th>
1161
+ <th>Description</th>
1162
+ </tr>
1163
+ </thead>
1164
+ <tbody>
1165
+ <tr>
1166
+ <td><code>model</code></td>
1167
+ <td>Both</td>
1168
+ <td>string</td>
1169
+ <td>Yes</td>
1170
+ <td>The deployment name you assigned when you deployed the model.</td>
1171
+ </tr>
1172
+ <tr>
1173
+ <td><code>prompt</code></td>
1174
+ <td>Both</td>
1175
+ <td>string</td>
1176
+ <td>Yes</td>
1177
+ <td>The text prompt that describes the image to generate or edits to make. <br>Maximum context length: 32,000 tokens.</td>
1178
+ </tr>
1179
+ <tr>
1180
+ <td><code>image</code></td>
1181
+ <td>Image edits</td>
1182
+ <td>file</td>
1183
+ <td>Yes</td>
1184
+ <td>A JPEG or PNG reference image passed as multipart form data. Provide up to five images by repeating the <code>image</code> field for each file.</td>
1185
+ </tr>
1186
+ <tr>
1187
+ <td><code>width</code></td>
1188
+ <td>Image generations</td>
1189
+ <td>integer</td>
1190
+ <td>No</td>
1191
+ <td>Width of the output image in pixels. <br>Minimum: 768. For MAI-Image-2.6 models, the product of <code>width</code> × <code>height</code> must not exceed 2,359,296. For MAI-Image-2.5 models, it must not exceed 1,048,576.</td>
1192
+ </tr>
1193
+ <tr>
1194
+ <td><code>height</code></td>
1195
+ <td>Image generations</td>
1196
+ <td>integer</td>
1197
+ <td>No</td>
1198
+ <td>Height of the output image in pixels. <br>Minimum: 768. For MAI-Image-2.6 models, the product of <code>width</code> × <code>height</code> must not exceed 2,359,296. For MAI-Image-2.5 models, it must not exceed 1,048,576.</td>
1199
+ </tr>
1200
+ <tr>
1201
+ <td><code>auto_aspect_ratio</code></td>
1202
+ <td>Both</td>
1203
+ <td>boolean</td>
1204
+ <td>No</td>
1205
+ <td>Applies only to <code>MAI-Image-2.6</code> (Preview) and <code>MAI-Image-2.6-Flash</code> (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.</td>
1206
+ </tr>
1207
+ <tr>
1208
+ <td><code>web_grounding</code></td>
1209
+ <td>Both</td>
1210
+ <td>boolean</td>
1211
+ <td>No</td>
1212
+ <td>Applies only to <code>MAI-Image-2.6</code> (Preview) and <code>MAI-Image-2.6-Flash</code> (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.</td>
1213
+ </tr>
1214
+ </tbody>
1215
+ </table>
1216
+ <h4 id="response-format">Response format</h4>
1217
+ <p>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 <code>b64_json</code> value to save the image as a PNG file.</p>
1218
+ <div class="NOTE">
1219
+ <p>Note</p>
1220
+ <p>The output format is always PNG. The maximum total pixel count is 2,359,296 (equivalent to 1536×1536) for <code>MAI-Image-2.6</code> and <code>MAI-Image-2.6-Flash</code>, and 1,048,576 (equivalent to 1024×1024) for MAI-Image-2.5 models. Both <code>width</code> and <code>height</code> 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.</p>
1221
+ </div>
1222
+ <table>
1223
+ <thead>
1224
+ <tr>
1225
+ <th>Field</th>
1226
+ <th>Type</th>
1227
+ <th>Description</th>
1228
+ </tr>
1229
+ </thead>
1230
+ <tbody>
1231
+ <tr>
1232
+ <td><code>data</code></td>
1233
+ <td>array</td>
1234
+ <td>Collection of generated image results.</td>
1235
+ </tr>
1236
+ <tr>
1237
+ <td><code>data[].b64_json</code></td>
1238
+ <td>string</td>
1239
+ <td>Base64-encoded PNG image data. Decode this value to create an image file.</td>
1240
+ </tr>
1241
+ </tbody>
1242
+ </table>
1243
+ <p>The following example shows a successful response:</p>
1244
+ <pre><code class="lang-json">{
1245
+ "data": [
1246
+ {
1247
+ "b64_json": "&lt;base64-encoded PNG image data&gt;"
1248
+ }
1249
+ ]
1250
+ }
1251
+ </code></pre>
1252
+ <h2 id="api-quotas-and-limits">API quotas and limits</h2>
1253
+ <p>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.</p>
1254
+ <table>
1255
+ <thead>
1256
+ <tr>
1257
+ <th>Deployment Type</th>
1258
+ <th>Tier</th>
1259
+ <th>MAI-Image-2.6-Flash <br> (RPM)</th>
1260
+ <th>MAI-Image-2.6 <br> (RPM)</th>
1261
+ <th>MAI-Image-2.5-Pro <br> (RPM)</th>
1262
+ <th>MAI-Image-2.5-Flash <br> (RPM)</th>
1263
+ <th>MAI-Image-2.5 <br> (RPM)</th>
1264
+ </tr>
1265
+ </thead>
1266
+ <tbody>
1267
+ <tr>
1268
+ <td>Global Standard</td>
1269
+ <td>0 <br> (Free)</td>
1270
+ <td>0</td>
1271
+ <td>0</td>
1272
+ <td>0</td>
1273
+ <td>0</td>
1274
+ <td>0</td>
1275
+ </tr>
1276
+ <tr>
1277
+ <td>Global Standard</td>
1278
+ <td>1</td>
1279
+ <td>6</td>
1280
+ <td>6</td>
1281
+ <td>2</td>
1282
+ <td>2</td>
1283
+ <td>2</td>
1284
+ </tr>
1285
+ <tr>
1286
+ <td>Global Standard</td>
1287
+ <td>2</td>
1288
+ <td>12</td>
1289
+ <td>12</td>
1290
+ <td>4</td>
1291
+ <td>4</td>
1292
+ <td>4</td>
1293
+ </tr>
1294
+ <tr>
1295
+ <td>Global Standard</td>
1296
+ <td>3</td>
1297
+ <td>18</td>
1298
+ <td>18</td>
1299
+ <td>6</td>
1300
+ <td>6</td>
1301
+ <td>6</td>
1302
+ </tr>
1303
+ <tr>
1304
+ <td>Global Standard</td>
1305
+ <td>4</td>
1306
+ <td>24</td>
1307
+ <td>24</td>
1308
+ <td>8</td>
1309
+ <td>8</td>
1310
+ <td>8</td>
1311
+ </tr>
1312
+ <tr>
1313
+ <td>Global Standard</td>
1314
+ <td>5</td>
1315
+ <td>30</td>
1316
+ <td>30</td>
1317
+ <td>10</td>
1318
+ <td>10</td>
1319
+ <td>10</td>
1320
+ </tr>
1321
+ <tr>
1322
+ <td>Global Standard</td>
1323
+ <td>6</td>
1324
+ <td>36</td>
1325
+ <td>36</td>
1326
+ <td>12</td>
1327
+ <td>12</td>
1328
+ <td>12</td>
1329
+ </tr>
1330
+ </tbody>
1331
+ </table>
1332
+ <p>To request a quota increase, submit the <a href="https://aka.ms/oai/stuquotarequest" data-linktype="external">quota increase request form</a>. Requests are processed in the order they're received, and priority goes to customers who actively use their existing quota allocation.</p>
1333
+ <h2 id="troubleshoot">Troubleshoot</h2>
1334
+ <p>Use the following table to resolve common errors when working with MAI image models:</p>
1335
+ <table>
1336
+ <thead>
1337
+ <tr>
1338
+ <th>Error</th>
1339
+ <th>Cause</th>
1340
+ <th>Fix</th>
1341
+ </tr>
1342
+ </thead>
1343
+ <tbody>
1344
+ <tr>
1345
+ <td><code>401 Unauthorized</code></td>
1346
+ <td>Invalid API key or expired token</td>
1347
+ <td>Regenerate the key in the Azure portal. For Entra ID authentication, ensure the token scope is <code>https://cognitiveservices.azure.com/.default</code>.</td>
1348
+ </tr>
1349
+ <tr>
1350
+ <td><code>404 Not Found</code></td>
1351
+ <td>Incorrect deployment name or endpoint URL</td>
1352
+ <td>Verify the deployment name and endpoint in the Foundry portal under <strong>Deployments</strong>.</td>
1353
+ </tr>
1354
+ <tr>
1355
+ <td><code>400 Bad Request</code></td>
1356
+ <td>A required field is missing, a reference image uses an unsupported format, image dimensions are invalid, or a parameter isn't supported by the deployed model</td>
1357
+ <td>Include the required <code>model</code> and <code>prompt</code> fields and, for edits, at least one <code>image</code> field containing a JPEG or PNG file. Use <code>auto_aspect_ratio</code> and <code>web_grounding</code> only with MAI-Image-2.6 models. Ensure <code>width</code> and <code>height</code> are each at least 768. Keep <code>width</code> × <code>height</code> at or below 2,359,296 for MAI-Image-2.6 models or 1,048,576 for MAI-Image-2.5 models.</td>
1358
+ </tr>
1359
+ <tr>
1360
+ <td><code>429 Too Many Requests</code></td>
1361
+ <td>Rate limit exceeded</td>
1362
+ <td>Wait and retry, or <a href="https://aka.ms/oai/stuquotarequest" data-linktype="external">request a quota increase</a>.</td>
1363
+ </tr>
1364
+ </tbody>
1365
+ </table>
1366
+ <h2 id="responsible-ai-considerations">Responsible AI considerations</h2>
1367
+ <p>When using MAI image models in Foundry, consider these responsible AI practices:</p>
1368
+ <ul>
1369
+ <li><strong>Be aware of known limitations</strong>: 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.</li>
1370
+ <li><strong>Configure content safety</strong>: Apply additional mitigations appropriate to your use case, because no generative model is immune to adversarial prompts.</li>
1371
+ <li><strong>Comply with applicable terms</strong>: Ensure your use of generated images complies with <a href="https://www.microsoft.com/en-us/legal/terms-of-use" data-linktype="external">Microsoft's terms of service</a> and applicable copyright and intellectual property laws.</li>
1372
+ <li><strong>Be transparent</strong>: Disclose that content is AI-generated when sharing or publishing images.</li>
1373
+ <li><strong>Avoid harmful content</strong>: Don't generate content that could be harmful, misleading, or in violation of privacy.</li>
1374
+ </ul>
1375
+ <h3 id="special-considerations-for-editing-images-of-minors">Special considerations for editing images of minors</h3>
1376
+ <p>Photorealistic image edits involving minors are blocked by default. Customers can <a href="https://customervoice.microsoft.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR7en2Ais5pxKtso_Pz4b1_xUQVFQRDhQRjVPNllLMVZCSVNYVUs4MzhNMyQlQCN0PWcu" data-linktype="external">request access</a> to this model capability. Enterprise-tier customers are automatically approved.</p>
1377
+ <h2 id="related-content">Related content</h2>
1378
+ <ul>
1379
+ <li><a href="../concepts/models-sold-directly-by-azure" data-linktype="relative-path">Explore available models in Foundry</a></li>
1380
+ <li><a href="deploy-foundry-models" data-linktype="relative-path">Deploy Microsoft Foundry Models in the Foundry portal</a></li>
1381
+ <li><a href="configure-entra-id" data-linktype="relative-path">Configure Microsoft Entra ID authentication</a></li>
1382
+ </ul>
1383
+ </div>
1384
+
1385
+ <div
1386
+ id="ms--inline-notifications"
1387
+ class="margin-block-xs"
1388
+ data-bi-name="inline-notification"
1389
+ ></div>
1390
+
1391
+ <div
1392
+ id="assertive-live-region"
1393
+ role="alert"
1394
+ aria-live="assertive"
1395
+ class="visually-hidden"
1396
+ aria-relevant="additions"
1397
+ aria-atomic="true"
1398
+ ></div>
1399
+ <div
1400
+ id="polite-live-region"
1401
+ role="status"
1402
+ aria-live="polite"
1403
+ class="visually-hidden"
1404
+ aria-relevant="additions"
1405
+ aria-atomic="true"
1406
+ ></div>
1407
+
1408
+
1409
+ <!-- feedback section -->
1410
+ <section
1411
+ id="site-user-feedback-footer"
1412
+ class="font-size-sm margin-top-md display-none-print display-none-desktop"
1413
+ data-test-id="site-user-feedback-footer"
1414
+ data-bi-name="site-feedback-section"
1415
+ >
1416
+ <hr class="hr" />
1417
+ <h2 id="ms--feedback" class="title is-3">Feedback</h2>
1418
+ <div class="display-flex flex-wrap-wrap align-items-center">
1419
+ <p class="font-weight-semibold margin-xxs margin-left-none">
1420
+ Was this page helpful?
1421
+ </p>
1422
+ <div class="buttons">
1423
+ <button
1424
+ class="thumb-rating-button like button button-primary button-sm"
1425
+ data-test-id="footer-rating-yes"
1426
+ data-binary-rating-response="rating-yes"
1427
+ type="button"
1428
+ title="This article is helpful"
1429
+ data-bi-name="button-rating-yes"
1430
+ aria-pressed="false"
1431
+ >
1432
+ <span class="icon" aria-hidden="true">
1433
+ <span class="docon docon-like"></span>
1434
+ </span>
1435
+ <span>Yes</span>
1436
+ </button>
1437
+ <button
1438
+ class="thumb-rating-button dislike button button-primary button-sm"
1439
+ id="standard-rating-no-button"
1440
+ hidden
1441
+ data-test-id="footer-rating-no"
1442
+ data-binary-rating-response="rating-no"
1443
+ type="button"
1444
+ title="This article is not helpful"
1445
+ data-bi-name="button-rating-no"
1446
+ aria-pressed="false"
1447
+ >
1448
+ <span class="icon" aria-hidden="true">
1449
+ <span class="docon docon-dislike"></span>
1450
+ </span>
1451
+ <span>No</span>
1452
+ </button>
1453
+ <details
1454
+ class="popover popover-top"
1455
+ id="mobile-help-popover"
1456
+ data-test-id="footer-feedback-popover"
1457
+ >
1458
+ <summary
1459
+ class="thumb-rating-button dislike button button-primary button-sm"
1460
+ data-test-id="details-footer-rating-no"
1461
+ data-binary-rating-response="rating-no"
1462
+ title="This article is not helpful"
1463
+ data-bi-name="button-rating-no"
1464
+ aria-pressed="false"
1465
+ data-bi-an="feedback-unhelpful-popover"
1466
+ >
1467
+ <span class="icon" aria-hidden="true">
1468
+ <span class="docon docon-dislike"></span>
1469
+ </span>
1470
+ <span>No</span>
1471
+ </summary>
1472
+ <div
1473
+ class="popover-content width-200 width-300-tablet"
1474
+ role="dialog"
1475
+ aria-labelledby="popover-heading"
1476
+ aria-describedby="popover-description"
1477
+ >
1478
+ <p id="popover-heading" class="font-size-lg margin-bottom-xxs font-weight-semibold">
1479
+ Need help with this topic?
1480
+ </p>
1481
+ <p id="popover-description" class="font-size-sm margin-bottom-xs">
1482
+ Want to try using Ask Learn to clarify or guide you through this topic?
1483
+ </p>
1484
+
1485
+ <div class="buttons flex-direction-row flex-wrap justify-content-center gap-xxs">
1486
+ <div>
1487
+ <button
1488
+ class="button button-sm border inner-focus display-none margin-right-xxs"
1489
+ data-bi-name="ask-learn-assistant-entry-troubleshoot"
1490
+ data-test-id="ask-learn-assistant-modal-entry-mobile-feedback"
1491
+ data-ask-learn-modal-entry-feedback
1492
+ data-bi-an=feedback-unhelpful-popover
1493
+ type="button"
1494
+ style="min-width: max-content;"
1495
+ aria-expanded="false"
1496
+ aria-label="Ask Learn"
1497
+ hidden
1498
+ >
1499
+ <span class="icon" aria-hidden="true">
1500
+ <span class="docon docon-chat-sparkle-fill gradient-ask-learn-logo"></span>
1501
+ </span>
1502
+ </button>
1503
+ <button
1504
+ class="button button-sm display-inline-flex display-none-desktop flex-shrink-0 margin-right-xxs border-color-ask-learn margin-right-xxs"
1505
+ data-bi-name="ask-learn-assistant-entry-troubleshoot"
1506
+ data-bi-an=feedback-unhelpful-popover
1507
+ data-test-id="ask-learn-assistant-modal-entry-tablet-feedback"
1508
+ data-ask-learn-modal-entry-feedback
1509
+ type="button"
1510
+ style="min-width: max-content;"
1511
+ aria-expanded="false"
1512
+ hidden
1513
+ >
1514
+ <span class="icon font-size-lg" aria-hidden="true">
1515
+ <span class="docon docon-chat-sparkle-fill gradient-ask-learn-logo"></span>
1516
+ </span>
1517
+ <span>Ask Learn</span>
1518
+ </button>
1519
+ <button
1520
+ class="button button-sm display-none flex-shrink-0 display-inline-flex-desktop margin-right-xxs border-color-ask-learn margin-right-xxs"
1521
+ data-bi-name="ask-learn-assistant-entry-troubleshoot"
1522
+ data-bi-an=feedback-unhelpful-popover
1523
+ data-test-id="ask-learn-assistant-flyout-entry-feedback"
1524
+ data-ask-learn-flyout-entry-show-only
1525
+ data-flyout-button="toggle"
1526
+ type="button"
1527
+ style="min-width: max-content;"
1528
+ aria-expanded="false"
1529
+ aria-controls="ask-learn-flyout"
1530
+ hidden
1531
+ >
1532
+ <span class="icon font-size-lg" aria-hidden="true">
1533
+ <span class="docon docon-chat-sparkle-fill gradient-ask-learn-logo"></span>
1534
+ </span>
1535
+ <span>Ask Learn</span>
1536
+ </button>
1537
+ </div>
1538
+ <button
1539
+ type="button"
1540
+ class="button button-sm margin-right-xxs"
1541
+ data-help-option="suggest-fix"
1542
+ data-bi-name="feedback-suggest"
1543
+ data-bi-an="feedback-unhelpful-popover"
1544
+ data-test-id="suggest-fix"
1545
+ >
1546
+ <span class="icon" aria-hidden="true">
1547
+ <span class="docon docon-feedback"></span>
1548
+ </span>
1549
+ <span> Suggest a fix? </span>
1550
+ </button>
1551
+ </div>
1552
+
1553
+ </div>
1554
+ </details>
1555
+ </div>
1556
+ </div>
1557
+ </section>
1558
+ <!-- end feedback section -->
1559
+
1560
+ </div>
1561
+
1562
+ <div id="ms--additional-resources-mobile" class="display-none-print">
1563
+ <hr class="hr" hidden />
1564
+ <h2 id="ms--additional-resources-mobile-heading" class="title is-3" hidden>
1565
+ Additional resources
1566
+ </h2>
1567
+
1568
+ <section
1569
+ id="right-rail-recommendations-mobile"
1570
+ class=""
1571
+ data-bi-name="recommendations"
1572
+ hidden
1573
+ ></section>
1574
+
1575
+ <section
1576
+ id="right-rail-training-mobile"
1577
+ class=""
1578
+ data-bi-name="learning-resource-card"
1579
+ hidden
1580
+ ></section>
1581
+
1582
+ <section
1583
+ id="right-rail-events-mobile"
1584
+ class=""
1585
+ data-bi-name="events-card"
1586
+ hidden
1587
+ ></section>
1588
+
1589
+ </div>
1590
+
1591
+ <div
1592
+ id="article-metadata-footer"
1593
+ data-bi-name="article-metadata-footer"
1594
+ data-test-id="article-metadata-footer"
1595
+ class="page-metadata-container"
1596
+ >
1597
+ <hr class="hr" />
1598
+ <ul class="metadata page-metadata" data-bi-name="page info" lang="en-us" dir="ltr">
1599
+ <li class="visibility-hidden-visual-diff">
1600
+ <span class="badge badge-sm text-wrap-pretty">
1601
+ <span>Last updated on <local-time format="twoDigitNumeric"
1602
+ datetime="2026-09-21T22:12:00.000Z"
1603
+ data-article-date-source="calculated"
1604
+ class="is-invisible"
1605
+ >
1606
+ 2026-09-21
1607
+ </local-time></span>
1608
+ </span>
1609
+ </li>
1610
+ </ul>
1611
+ </div>
1612
+
1613
+ </div>
1614
+
1615
+ </main>
1616
+ <aside
1617
+ id="layout-body-aside"
1618
+ class="layout-body-aside "
1619
+ data-bi-name="aside"
1620
+ aria-label="Additional resources"
1621
+ >
1622
+
1623
+ <div
1624
+ id="ms--additional-resources"
1625
+ class="right-container padding-sm display-none display-block-desktop height-full"
1626
+ data-bi-name="pageactions"
1627
+ >
1628
+ <div id="affixed-right-container" data-bi-name="right-column">
1629
+
1630
+ <nav
1631
+ id="side-doc-outline"
1632
+ class="doc-outline border-bottom padding-bottom-xs margin-bottom-xs scrollbar-width-thin"
1633
+ data-bi-name="intopic toc"
1634
+ aria-label="In this article"
1635
+ >
1636
+ <h3>In this article</h3>
1637
+ </nav>
1638
+
1639
+ <!-- Feedback -->
1640
+
1641
+ <section
1642
+ id="ms--site-user-feedback-right-rail"
1643
+ class="font-size-sm display-none-print"
1644
+ data-test-id="site-user-feedback-right-rail"
1645
+ data-bi-name="site-feedback-right-rail"
1646
+ >
1647
+ <div class="display-flex flex-wrap-wrap align-items-center">
1648
+ <p class="font-weight-semibold margin-xxs margin-left-none">
1649
+ Was this page helpful?
1650
+ </p>
1651
+ <div class="display-flex flex-wrap-nowrap">
1652
+ <button
1653
+ class="thumb-rating-button like inner-focus"
1654
+ data-test-id="right-rail-rating-yes"
1655
+ data-binary-rating-response="rating-yes"
1656
+ type="button"
1657
+ title="This article is helpful"
1658
+ aria-label="This article is helpful"
1659
+ data-bi-name="button-rating-yes"
1660
+ aria-pressed="false"
1661
+ >
1662
+ <span class="icon" aria-hidden="true">
1663
+ <span class="docon docon-like"></span>
1664
+ </span>
1665
+ </button>
1666
+ <button
1667
+ class="thumb-rating-button dislike inner-focus"
1668
+ id="right-rail-no-button"
1669
+ hidden
1670
+ data-test-id="right-rail-rating-no"
1671
+ data-binary-rating-response="rating-no"
1672
+ type="button"
1673
+ title="This article is not helpful"
1674
+ aria-label="This article is not helpful"
1675
+ data-bi-name="button-rating-no"
1676
+ aria-pressed="false"
1677
+ >
1678
+ <span class="icon" aria-hidden="true">
1679
+ <span class="docon docon-dislike"></span>
1680
+ </span>
1681
+ </button>
1682
+ <details class="popover popover-right" id="help-popover" data-test-id="feedback-popover">
1683
+ <summary
1684
+ tabindex="0"
1685
+ class="thumb-rating-button dislike inner-focus"
1686
+ data-test-id="details-right-rail-rating-no"
1687
+ data-binary-rating-response="rating-no"
1688
+ title="This article is not helpful"
1689
+ aria-label="This article is not helpful"
1690
+ data-bi-name="button-rating-no"
1691
+ aria-pressed="false"
1692
+ data-bi-an="feedback-unhelpful-popover"
1693
+ >
1694
+ <span class="icon" aria-hidden="true">
1695
+ <span class="docon docon-dislike"></span>
1696
+ </span>
1697
+ </summary>
1698
+ <div
1699
+ class="popover-content width-200 width-300-tablet"
1700
+ role="dialog"
1701
+ aria-labelledby="popover-heading-right-rail"
1702
+ aria-describedby="popover-description-right-rail"
1703
+ >
1704
+ <p
1705
+ id="popover-heading-right-rail"
1706
+ class="font-size-lg margin-bottom-xxs font-weight-semibold"
1707
+ >
1708
+ Need help with this topic?
1709
+ </p>
1710
+ <p id="popover-description-right-rail" class="font-size-sm margin-bottom-xs">
1711
+ Want to try using Ask Learn to clarify or guide you through this topic?
1712
+ </p>
1713
+
1714
+ <div class="buttons flex-direction-row flex-wrap justify-content-center gap-xxs">
1715
+ <div>
1716
+ <button
1717
+ class="button button-sm border inner-focus display-none margin-right-xxs"
1718
+ data-bi-name="ask-learn-assistant-entry-troubleshoot"
1719
+ data-test-id="ask-learn-assistant-modal-entry-mobile-feedback"
1720
+ data-ask-learn-modal-entry-feedback
1721
+ data-bi-an=feedback-unhelpful-popover
1722
+ type="button"
1723
+ style="min-width: max-content;"
1724
+ aria-expanded="false"
1725
+ aria-label="Ask Learn"
1726
+ hidden
1727
+ >
1728
+ <span class="icon" aria-hidden="true">
1729
+ <span class="docon docon-chat-sparkle-fill gradient-ask-learn-logo"></span>
1730
+ </span>
1731
+ </button>
1732
+ <button
1733
+ class="button button-sm display-inline-flex display-none-desktop flex-shrink-0 margin-right-xxs border-color-ask-learn margin-right-xxs"
1734
+ data-bi-name="ask-learn-assistant-entry-troubleshoot"
1735
+ data-bi-an=feedback-unhelpful-popover
1736
+ data-test-id="ask-learn-assistant-modal-entry-tablet-feedback"
1737
+ data-ask-learn-modal-entry-feedback
1738
+ type="button"
1739
+ style="min-width: max-content;"
1740
+ aria-expanded="false"
1741
+ hidden
1742
+ >
1743
+ <span class="icon font-size-lg" aria-hidden="true">
1744
+ <span class="docon docon-chat-sparkle-fill gradient-ask-learn-logo"></span>
1745
+ </span>
1746
+ <span>Ask Learn</span>
1747
+ </button>
1748
+ <button
1749
+ class="button button-sm display-none flex-shrink-0 display-inline-flex-desktop margin-right-xxs border-color-ask-learn margin-right-xxs"
1750
+ data-bi-name="ask-learn-assistant-entry-troubleshoot"
1751
+ data-bi-an=feedback-unhelpful-popover
1752
+ data-test-id="ask-learn-assistant-flyout-entry-feedback"
1753
+ data-ask-learn-flyout-entry-show-only
1754
+ data-flyout-button="toggle"
1755
+ type="button"
1756
+ style="min-width: max-content;"
1757
+ aria-expanded="false"
1758
+ aria-controls="ask-learn-flyout"
1759
+ hidden
1760
+ >
1761
+ <span class="icon font-size-lg" aria-hidden="true">
1762
+ <span class="docon docon-chat-sparkle-fill gradient-ask-learn-logo"></span>
1763
+ </span>
1764
+ <span>Ask Learn</span>
1765
+ </button>
1766
+ </div>
1767
+ <button
1768
+ type="button"
1769
+ class="button button-sm margin-right-xxs"
1770
+ data-help-option="suggest-fix"
1771
+ data-bi-name="feedback-suggest"
1772
+ data-bi-an="feedback-unhelpful-popover"
1773
+ data-test-id="suggest-fix"
1774
+ >
1775
+ <span class="icon" aria-hidden="true">
1776
+ <span class="docon docon-feedback"></span>
1777
+ </span>
1778
+ <span> Suggest a fix? </span>
1779
+ </button>
1780
+ </div>
1781
+
1782
+ </div>
1783
+ </details>
1784
+ </div>
1785
+ </div>
1786
+ </section>
1787
+
1788
+ </div>
1789
+ </div>
1790
+
1791
+ </aside> <section
1792
+ id="layout-body-flyout"
1793
+ class="layout-body-flyout "
1794
+ data-bi-name="flyout"
1795
+ >
1796
+ <div
1797
+ class="height-full border-left background-color-body-medium"
1798
+ id="ask-learn-flyout"
1799
+ ></div>
1800
+ </section> <div class="layout-body-footer " data-bi-name="layout-footer">
1801
+ <footer
1802
+ id="footer"
1803
+ data-test-id="footer"
1804
+ data-bi-name="footer"
1805
+ class="footer-layout padding-xs padding-sm-desktop has-default-focus border-top"
1806
+ role="contentinfo"
1807
+ >
1808
+ <div class="display-flex gap-xs flex-wrap-wrap is-full-height padding-right-lg-desktop">
1809
+
1810
+ <a
1811
+ data-mscc-ic="false"
1812
+ href="#"
1813
+ data-bi-name="select-locale"
1814
+ class="locale-selector-link flex-shrink-0 button button-sm button-clear external-link-indicator"
1815
+ id=""
1816
+ title=""
1817
+ ><span class="icon" aria-hidden="true"
1818
+ ><span class="docon docon-world"></span></span
1819
+ ><span class="local-selector-link-text">en-us</span></a
1820
+ >
1821
+ <div class="ccpa-privacy-link" data-ccpa-privacy-link hidden>
1822
+
1823
+ <a
1824
+ data-mscc-ic="false"
1825
+ href="https://aka.ms/yourcaliforniaprivacychoices"
1826
+ data-bi-name="your-privacy-choices"
1827
+ class="button button-sm button-clear flex-shrink-0 external-link-indicator"
1828
+ id=""
1829
+ title=""
1830
+ >
1831
+ <svg
1832
+ xmlns="http://www.w3.org/2000/svg"
1833
+ viewBox="0 0 30 14"
1834
+ xml:space="preserve"
1835
+ height="16"
1836
+ width="43"
1837
+ aria-hidden="true"
1838
+ focusable="false"
1839
+ >
1840
+ <path
1841
+ d="M7.4 12.8h6.8l3.1-11.6H7.4C4.2 1.2 1.6 3.8 1.6 7s2.6 5.8 5.8 5.8z"
1842
+ style="fill-rule:evenodd;clip-rule:evenodd;fill:#fff"
1843
+ ></path>
1844
+ <path
1845
+ d="M22.6 0H7.4c-3.9 0-7 3.1-7 7s3.1 7 7 7h15.2c3.9 0 7-3.1 7-7s-3.2-7-7-7zm-21 7c0-3.2 2.6-5.8 5.8-5.8h9.9l-3.1 11.6H7.4c-3.2 0-5.8-2.6-5.8-5.8z"
1846
+ style="fill-rule:evenodd;clip-rule:evenodd;fill:#06f"
1847
+ ></path>
1848
+ <path
1849
+ d="M24.6 4c.2.2.2.6 0 .8L22.5 7l2.2 2.2c.2.2.2.6 0 .8-.2.2-.6.2-.8 0l-2.2-2.2-2.2 2.2c-.2.2-.6.2-.8 0-.2-.2-.2-.6 0-.8L20.8 7l-2.2-2.2c-.2-.2-.2-.6 0-.8.2-.2.6-.2.8 0l2.2 2.2L23.8 4c.2-.2.6-.2.8 0z"
1850
+ style="fill:#fff"
1851
+ ></path>
1852
+ <path
1853
+ d="M12.7 4.1c.2.2.3.6.1.8L8.6 9.8c-.1.1-.2.2-.3.2-.2.1-.5.1-.7-.1L5.4 7.7c-.2-.2-.2-.6 0-.8.2-.2.6-.2.8 0L8 8.6l3.8-4.5c.2-.2.6-.2.9 0z"
1854
+ style="fill:#06f"
1855
+ ></path>
1856
+ </svg>
1857
+
1858
+ <span>Your Privacy Choices</span></a
1859
+ >
1860
+
1861
+ </div>
1862
+ <div class="flex-shrink-0">
1863
+ <div class="dropdown has-caret-up">
1864
+ <button
1865
+ data-test-id="theme-selector-button"
1866
+ class="dropdown-trigger button button-clear button-sm inner-focus theme-dropdown-trigger"
1867
+ aria-controls="{{ themeMenuId }}"
1868
+ aria-haspopup="true"
1869
+ aria-expanded="false"
1870
+ data-bi-name="theme"
1871
+ >
1872
+ <span class="icon" aria-hidden="true"><span class="docon docon-sun"></span></span>
1873
+ <span>Theme</span>
1874
+ <span class="icon expanded-indicator" aria-hidden="true">
1875
+ <span class="docon docon-chevron-down-light"></span>
1876
+ </span>
1877
+ </button>
1878
+ <div class="dropdown-menu" id="{{ themeMenuId }}" role="menu">
1879
+ <ul class="theme-selector padding-xxs" data-test-id="theme-dropdown-menu" role="none">
1880
+ <li class="theme display-block" role="none">
1881
+ <button
1882
+ class="button button-clear button-sm theme-control button-block justify-content-flex-start text-align-left"
1883
+ role="menuitemradio"
1884
+ aria-checked="false"
1885
+ data-theme-to="light"
1886
+ tabindex="-1"
1887
+ >
1888
+ <span class="theme-light margin-right-xxs">
1889
+ <span
1890
+ class="theme-selector-icon border display-inline-block has-body-background"
1891
+ aria-hidden="true"
1892
+ >
1893
+ <svg class="svg" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 22 14">
1894
+ <rect width="22" height="14" class="has-fill-body-background" />
1895
+ <rect x="5" y="5" width="12" height="4" class="has-fill-secondary" />
1896
+ <rect x="5" y="2" width="2" height="1" class="has-fill-secondary" />
1897
+ <rect x="8" y="2" width="2" height="1" class="has-fill-secondary" />
1898
+ <rect x="11" y="2" width="3" height="1" class="has-fill-secondary" />
1899
+ <rect x="1" y="1" width="2" height="2" class="has-fill-secondary" />
1900
+ <rect x="5" y="10" width="7" height="2" rx="0.3" class="has-fill-primary" />
1901
+ <rect x="19" y="1" width="2" height="2" rx="1" class="has-fill-secondary" />
1902
+ </svg>
1903
+ </span>
1904
+ </span>
1905
+ <span> Light </span>
1906
+ </button>
1907
+ </li>
1908
+ <li class="theme display-block" role="none">
1909
+ <button
1910
+ class="button button-clear button-sm theme-control button-block justify-content-flex-start text-align-left"
1911
+ role="menuitemradio"
1912
+ aria-checked="false"
1913
+ data-theme-to="dark"
1914
+ tabindex="-1"
1915
+ >
1916
+ <span class="theme-dark margin-right-xxs">
1917
+ <span
1918
+ class="border theme-selector-icon display-inline-block has-body-background"
1919
+ aria-hidden="true"
1920
+ >
1921
+ <svg class="svg" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 22 14">
1922
+ <rect width="22" height="14" class="has-fill-body-background" />
1923
+ <rect x="5" y="5" width="12" height="4" class="has-fill-secondary" />
1924
+ <rect x="5" y="2" width="2" height="1" class="has-fill-secondary" />
1925
+ <rect x="8" y="2" width="2" height="1" class="has-fill-secondary" />
1926
+ <rect x="11" y="2" width="3" height="1" class="has-fill-secondary" />
1927
+ <rect x="1" y="1" width="2" height="2" class="has-fill-secondary" />
1928
+ <rect x="5" y="10" width="7" height="2" rx="0.3" class="has-fill-primary" />
1929
+ <rect x="19" y="1" width="2" height="2" rx="1" class="has-fill-secondary" />
1930
+ </svg>
1931
+ </span>
1932
+ </span>
1933
+ <span> Dark </span>
1934
+ </button>
1935
+ </li>
1936
+ <li class="theme display-block" role="none">
1937
+ <button
1938
+ class="button button-clear button-sm theme-control button-block justify-content-flex-start text-align-left"
1939
+ role="menuitemradio"
1940
+ aria-checked="false"
1941
+ data-theme-to="high-contrast"
1942
+ tabindex="-1"
1943
+ >
1944
+ <span class="theme-high-contrast margin-right-xxs">
1945
+ <span
1946
+ class="border theme-selector-icon display-inline-block has-body-background"
1947
+ aria-hidden="true"
1948
+ >
1949
+ <svg class="svg" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 22 14">
1950
+ <rect width="22" height="14" class="has-fill-body-background" />
1951
+ <rect x="5" y="5" width="12" height="4" class="has-fill-secondary" />
1952
+ <rect x="5" y="2" width="2" height="1" class="has-fill-secondary" />
1953
+ <rect x="8" y="2" width="2" height="1" class="has-fill-secondary" />
1954
+ <rect x="11" y="2" width="3" height="1" class="has-fill-secondary" />
1955
+ <rect x="1" y="1" width="2" height="2" class="has-fill-secondary" />
1956
+ <rect x="5" y="10" width="7" height="2" rx="0.3" class="has-fill-primary" />
1957
+ <rect x="19" y="1" width="2" height="2" rx="1" class="has-fill-secondary" />
1958
+ </svg>
1959
+ </span>
1960
+ </span>
1961
+ <span> High contrast </span>
1962
+ </button>
1963
+ </li>
1964
+ </ul>
1965
+ </div>
1966
+ </div>
1967
+ </div>
1968
+ </div>
1969
+ <ul class="links" data-bi-name="footerlinks">
1970
+ <li class="manage-cookies-holder" hidden=""></li>
1971
+ <li>
1972
+
1973
+ <a
1974
+ data-mscc-ic="false"
1975
+ href="https://learn.microsoft.com/en-us/principles-for-ai-generated-content"
1976
+ data-bi-name="aiDisclaimer"
1977
+ class=" external-link-indicator"
1978
+ id=""
1979
+ title=""
1980
+ >AI Disclaimer</a
1981
+ >
1982
+
1983
+ </li><li>
1984
+
1985
+ <a
1986
+ data-mscc-ic="false"
1987
+ href="https://learn.microsoft.com/en-us/previous-versions/"
1988
+ data-bi-name="archivelink"
1989
+ class=" external-link-indicator"
1990
+ id=""
1991
+ title=""
1992
+ >Previous Versions</a
1993
+ >
1994
+
1995
+ </li> <li>
1996
+
1997
+ <a
1998
+ data-mscc-ic="false"
1999
+ href="https://techcommunity.microsoft.com/t5/microsoft-learn-blog/bg-p/MicrosoftLearnBlog"
2000
+ data-bi-name="bloglink"
2001
+ class=" external-link-indicator"
2002
+ id=""
2003
+ title=""
2004
+ >Blog</a
2005
+ >
2006
+
2007
+ </li> <li>
2008
+
2009
+ <a
2010
+ data-mscc-ic="false"
2011
+ href="https://learn.microsoft.com/en-us/contribute"
2012
+ data-bi-name="contributorGuide"
2013
+ class=" external-link-indicator"
2014
+ id=""
2015
+ title=""
2016
+ >Contribute</a
2017
+ >
2018
+
2019
+ </li><li>
2020
+
2021
+ <a
2022
+ data-mscc-ic="false"
2023
+ href="https://go.microsoft.com/fwlink/?LinkId=521839"
2024
+ data-bi-name="privacy"
2025
+ class=" external-link-indicator"
2026
+ id=""
2027
+ title=""
2028
+ >Privacy</a
2029
+ >
2030
+
2031
+ </li><li>
2032
+
2033
+ <a
2034
+ data-mscc-ic="false"
2035
+ href="https://go.microsoft.com/fwlink/?linkid=2259814"
2036
+ data-bi-name="consumer-health-privacy"
2037
+ class=" external-link-indicator"
2038
+ id=""
2039
+ title=""
2040
+ >Consumer Health Privacy</a
2041
+ >
2042
+
2043
+ </li><li>
2044
+
2045
+ <a
2046
+ data-mscc-ic="false"
2047
+ href="https://learn.microsoft.com/en-us/legal/termsofuse"
2048
+ data-bi-name="termsofuse"
2049
+ class=" external-link-indicator"
2050
+ id=""
2051
+ title=""
2052
+ >Terms of Use</a
2053
+ >
2054
+
2055
+ </li><li>
2056
+
2057
+ <a
2058
+ data-mscc-ic="false"
2059
+ href="https://www.microsoft.com/legal/intellectualproperty/Trademarks/"
2060
+ data-bi-name="trademarks"
2061
+ class=" external-link-indicator"
2062
+ id=""
2063
+ title=""
2064
+ >Trademarks</a
2065
+ >
2066
+
2067
+ </li>
2068
+ <li>&copy; Microsoft 2026</li>
2069
+ </ul>
2070
+ </footer>
2071
+ </footer>
2072
+ <noscript><img src="https://learn.microsoft.com/akam/13/pixel_3835d9c4?a=dD1jMzk3NjhhNjFlZGUwOWQzMTdiY2ExMjI4ZTdkOWE2NWI0OTU0MTRmJmpzPW9mZg==" style="visibility: hidden; position: absolute; left: -999px; top: -999px;" /></noscript></body>
2073
+ </html>
pipeline/provider_docs/openai__developers.openai.com_api_reference_resources_images_methods_edit ADDED
The diff for this file is too large to render. See raw diff
 
pipeline/provider_docs/urls.txt ADDED
@@ -0,0 +1,17 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ openai https://developers.openai.com/api/reference/resources/images/methods/edit
2
+ google https://ai.google.dev/gemini-api/docs/image-generation
3
+ google https://ai.google.dev/api/generate-content
4
+ bytedance https://docs.byteplus.com/en/docs/modelark/image-generation-api
5
+ meta https://dev.meta.ai/docs/api-reference/images/schemas
6
+ bfl https://api.bfl.ai/openapi.json
7
+ bfl https://docs.bfl.ml/flux_3/flux3_image_layout.md
8
+ ideogram https://api.ideogram.ai/openapi.json
9
+ microsoft https://learn.microsoft.com/en-us/azure/foundry/foundry-models/how-to/use-foundry-models-mai
10
+ xai https://docs.x.ai/developers/rest-api-reference/inference/images.md
11
+ xai https://docs.x.ai/developers/model-capabilities/images/generation.md
12
+ kling https://kling.ai/document-api/api/image/3-0-omni/image-omni
13
+ alibaba https://www.alibabacloud.com/help/en/model-studio/wan-image-generation-and-editing-api-reference
14
+ alibaba https://www.alibabacloud.com/help/en/model-studio/wan-image-edit
15
+ alibaba https://www.alibabacloud.com/help/en/model-studio/qwen-image-generation-and-editing-api-reference
16
+ luma https://docs.agents.lumalabs.ai/guides/faq/index.md
17
+ luma https://docs.agents.lumalabs.ai/api/resources/generations/methods/create/index.md
pipeline/provider_docs/wayback_retry.tsv ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ 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
2
+ 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
3
+ 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
4
+ 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
5
+ 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
pipeline/provider_docs/xai__docs.x.ai_developers_model-capabilities_images_generation.md ADDED
@@ -0,0 +1,593 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #### Model Capabilities
2
+
3
+ # Image Generation
4
+
5
+ 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.
6
+
7
+ ## Quick Start
8
+
9
+ Generate an image with a single API call:
10
+
11
+ ```javascript customLanguage="javascriptAISDK"
12
+ import { xai } from "@ai-sdk/xai";
13
+ import { generateImage } from "ai";
14
+
15
+ const { image } = await generateImage({
16
+ model: xai.image("grok-imagine-image-2.0"),
17
+ prompt: "A collage of London landmarks in a stenciled street‑art style",
18
+ });
19
+
20
+ console.log(image.base64);
21
+ ```
22
+
23
+ ```python customLanguage="pythonOpenAISDK"
24
+ from openai import OpenAI
25
+
26
+ client = OpenAI(
27
+ base_url="https://api.x.ai/v1",
28
+ api_key="YOUR_API_KEY",
29
+ )
30
+
31
+ response = client.images.generate(
32
+ model="grok-imagine-image-2.0",
33
+ prompt="A collage of London landmarks in a stenciled street‑art style",
34
+ )
35
+
36
+ print(response.data[0].url)
37
+ ```
38
+
39
+ ```bash
40
+ curl -X POST https://api.x.ai/v1/images/generations \
41
+ -H "Content-Type: application/json" \
42
+ -H "Authorization: Bearer $XAI_API_KEY" \
43
+ -d '{
44
+ "model": "grok-imagine-image-2.0",
45
+ "prompt": "A collage of London landmarks in a stenciled street‑art style"
46
+ }'
47
+ ```
48
+
49
+ ```javascript customLanguage="javascriptOpenAISDK"
50
+ import OpenAI from "openai";
51
+
52
+ const client = new OpenAI({
53
+ apiKey: process.env.XAI_API_KEY,
54
+ baseURL: 'https://api.x.ai/v1',
55
+ });
56
+
57
+ const response = await client.images.generate({
58
+ model: "grok-imagine-image-2.0",
59
+ prompt: "A collage of London landmarks in a stenciled street‑art style",
60
+ });
61
+
62
+ console.log(response.data[0].url);
63
+ ```
64
+
65
+ ```python customLanguage="pythonXAI"
66
+ import xai_sdk
67
+
68
+ client = xai_sdk.Client()
69
+
70
+ response = client.image.sample(
71
+ prompt="A collage of London landmarks in a stenciled street‑art style",
72
+ model="grok-imagine-image-2.0",
73
+ )
74
+
75
+ print(response.url)
76
+ ```
77
+
78
+ 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.
79
+
80
+ ## Configuration
81
+
82
+ ### Multiple Images
83
+
84
+ 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()`.
85
+
86
+ ```javascript customLanguage="javascriptAISDK"
87
+ import { xai } from "@ai-sdk/xai";
88
+ import { generateImage } from "ai";
89
+
90
+ const { images } = await generateImage({
91
+ model: xai.image("grok-imagine-image-2.0"),
92
+ prompt: "A futuristic city skyline at night",
93
+ n: 4,
94
+ });
95
+
96
+ images.forEach((image, i) => {
97
+ console.log(`Variation ${i + 1}: ${image.base64.slice(0, 50)}...`);
98
+ });
99
+
100
+ ```
101
+
102
+ ```python customLanguage="pythonOpenAISDK"
103
+ from openai import OpenAI
104
+
105
+ client = OpenAI(
106
+ base_url="https://api.x.ai/v1",
107
+ api_key="YOUR_API_KEY",
108
+ )
109
+
110
+ response = client.images.generate(
111
+ model="grok-imagine-image-2.0",
112
+ prompt="A futuristic city skyline at night",
113
+ n=4,
114
+ )
115
+
116
+ for i, image in enumerate(response.data):
117
+ print(f"Variation {i + 1}: {image.url}")
118
+ ```
119
+
120
+ ```javascript customLanguage="javascriptOpenAISDK"
121
+ import OpenAI from "openai";
122
+
123
+ const client = new OpenAI({
124
+ apiKey: process.env.XAI_API_KEY,
125
+ baseURL: "https://api.x.ai/v1",
126
+ });
127
+
128
+ const response = await client.images.generate({
129
+ model: "grok-imagine-image-2.0",
130
+ prompt: "A futuristic city skyline at night",
131
+ n: 4,
132
+ });
133
+
134
+ response.data.forEach((image, i) => {
135
+ console.log(`Variation ${i + 1}: ${image.url}`);
136
+ });
137
+
138
+ ```
139
+
140
+ ```bash
141
+ curl -X POST https://api.x.ai/v1/images/generations \
142
+ -H "Content-Type: application/json" \
143
+ -H "Authorization: Bearer $XAI_API_KEY" \
144
+ -d '{
145
+ "model": "grok-imagine-image-2.0",
146
+ "prompt": "A futuristic city skyline at night",
147
+ "n": 4
148
+ }'
149
+ ```
150
+
151
+ ```python customLanguage="pythonXAI"
152
+ import xai_sdk
153
+
154
+ client = xai_sdk.Client()
155
+
156
+ responses = client.image.sample_batch(
157
+ prompt="A futuristic city skyline at night",
158
+ model="grok-imagine-image-2.0",
159
+ n=4,
160
+ )
161
+
162
+ for i, image in enumerate(responses):
163
+ print(f"Variation {i + 1}: {image.url}")
164
+ ```
165
+
166
+ ### Aspect Ratio
167
+
168
+ 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.
169
+
170
+ | Ratio | Use case |
171
+ |-------|----------|
172
+ | `1:1` | Social media, thumbnails |
173
+ | `16:9` / `9:16` | Widescreen, mobile, stories |
174
+ | `4:3` / `3:4` | Presentations, portraits |
175
+ | `3:2` / `2:3` | Photography |
176
+ | `2:1` / `1:2` | Banners, headers |
177
+ | `19.5:9` / `9:19.5` | Modern smartphone displays (iPhone) |
178
+ | `20:9` / `9:20` | Modern smartphone displays (Android) |
179
+ | `21:9` | Cinematic widescreen |
180
+ | `5:2` | Wide banners |
181
+ | `auto` | Model auto-selects the best ratio for the prompt |
182
+
183
+ ```javascript customLanguage="javascriptAISDK"
184
+ import { xai } from "@ai-sdk/xai";
185
+ import { generateImage } from "ai";
186
+
187
+ const { image } = await generateImage({
188
+ model: xai.image("grok-imagine-image-2.0"),
189
+ prompt: "Mountain landscape at sunrise",
190
+ aspectRatio: "16:9",
191
+ });
192
+
193
+ console.log(image.base64);
194
+ ```
195
+
196
+ ```python customLanguage="pythonOpenAISDK"
197
+ from openai import OpenAI
198
+
199
+ client = OpenAI(
200
+ base_url="https://api.x.ai/v1",
201
+ api_key="YOUR_API_KEY",
202
+ )
203
+
204
+ response = client.images.generate(
205
+ model="grok-imagine-image-2.0",
206
+ prompt="Mountain landscape at sunrise",
207
+ extra_body={"aspect_ratio": "16:9"},
208
+ )
209
+
210
+ print(response.data[0].url)
211
+ ```
212
+
213
+ ```javascript customLanguage="javascriptOpenAISDK"
214
+ import OpenAI from "openai";
215
+
216
+ const client = new OpenAI({
217
+ apiKey: process.env.XAI_API_KEY,
218
+ baseURL: "https://api.x.ai/v1",
219
+ });
220
+
221
+ const response = await client.images.generate({
222
+ model: "grok-imagine-image-2.0",
223
+ prompt: "Mountain landscape at sunrise",
224
+
225
+ aspect_ratio: "16:9",
226
+ });
227
+
228
+ console.log(response.data[0].url);
229
+ ```
230
+
231
+ ```bash
232
+ curl -X POST https://api.x.ai/v1/images/generations \
233
+ -H "Content-Type: application/json" \
234
+ -H "Authorization: Bearer $XAI_API_KEY" \
235
+ -d '{
236
+ "model": "grok-imagine-image-2.0",
237
+ "prompt": "Mountain landscape at sunrise",
238
+ "aspect_ratio": "16:9"
239
+ }'
240
+ ```
241
+
242
+ ```python customLanguage="pythonXAI"
243
+ import xai_sdk
244
+
245
+ client = xai_sdk.Client()
246
+
247
+ response = client.image.sample(
248
+ prompt="Mountain landscape at sunrise",
249
+ model="grok-imagine-image-2.0",
250
+ aspect_ratio="16:9",
251
+ )
252
+
253
+ print(response.url)
254
+ ```
255
+
256
+ ### Resolution
257
+
258
+ You can specify different resolutions of the output image with the `resolution` parameter. Currently supported image resolutions are:
259
+
260
+ * `1k` (default when omitted)
261
+ * `2k`
262
+
263
+ ```javascript customLanguage="javascriptAISDK"
264
+ import { xai } from "@ai-sdk/xai";
265
+ import { generateImage } from "ai";
266
+
267
+ const { image } = await generateImage({
268
+ model: xai.image("grok-imagine-image-2.0"),
269
+ prompt: "An astronaut performing EVA in LEO.",
270
+ providerOptions: {
271
+ xai: { resolution: "2k" },
272
+ },
273
+ });
274
+
275
+ console.log(image.base64);
276
+ ```
277
+
278
+ ```python customLanguage="pythonOpenAISDK"
279
+ from openai import OpenAI
280
+
281
+ client = OpenAI(
282
+ base_url="https://api.x.ai/v1",
283
+ api_key="YOUR_API_KEY",
284
+ )
285
+
286
+ response = client.images.generate(
287
+ model="grok-imagine-image-2.0",
288
+ prompt="An astronaut performing EVA in LEO.",
289
+ extra_body={"resolution": "2k"},
290
+ )
291
+
292
+ print(response.data[0].url)
293
+ ```
294
+
295
+ ```javascript customLanguage="javascriptOpenAISDK"
296
+ import OpenAI from "openai";
297
+
298
+ const client = new OpenAI({
299
+ apiKey: process.env.XAI_API_KEY,
300
+ baseURL: "https://api.x.ai/v1",
301
+ });
302
+
303
+ const response = await client.images.generate({
304
+ model: "grok-imagine-image-2.0",
305
+ prompt: "An astronaut performing EVA in LEO.",
306
+
307
+ resolution: "2k",
308
+ });
309
+
310
+ console.log(response.data[0].url);
311
+ ```
312
+
313
+ ```bash
314
+ curl -X POST https://api.x.ai/v1/images/generations \
315
+ -H "Content-Type: application/json" \
316
+ -H "Authorization: Bearer $XAI_API_KEY" \
317
+ -d '{
318
+ "model": "grok-imagine-image-2.0",
319
+ "prompt": "An astronaut performing EVA in LEO.",
320
+ "resolution": "2k"
321
+ }'
322
+ ```
323
+
324
+ ```python customLanguage="pythonXAI"
325
+ import xai_sdk
326
+
327
+ client = xai_sdk.Client()
328
+
329
+ response = client.image.sample(
330
+ prompt="An astronaut performing EVA in LEO.",
331
+ model="grok-imagine-image-2.0",
332
+ resolution="2k"
333
+ )
334
+
335
+ print(response.url)
336
+ ```
337
+
338
+ ### Quality
339
+
340
+ 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`.
341
+
342
+ ```bash
343
+ curl -X POST https://api.x.ai/v1/images/generations \
344
+ -H "Content-Type: application/json" \
345
+ -H "Authorization: Bearer $XAI_API_KEY" \
346
+ -d '{
347
+ "model": "grok-imagine-image-2.0",
348
+ "prompt": "A watercolor painting of a lighthouse at dawn",
349
+ "quality": "low"
350
+ }'
351
+ ```
352
+
353
+ ```python customLanguage="pythonXAI"
354
+ import xai_sdk
355
+
356
+ client = xai_sdk.Client()
357
+
358
+ response = client.image.sample(
359
+ prompt="A watercolor painting of a lighthouse at dawn",
360
+ model="grok-imagine-image-2.0",
361
+ quality="low",
362
+ )
363
+
364
+ print(response.url)
365
+ ```
366
+
367
+ ### Base64 Output
368
+
369
+ 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:
370
+
371
+ ```javascript customLanguage="javascriptAISDK"
372
+ import { xai } from "@ai-sdk/xai";
373
+ import { generateImage } from "ai";
374
+ import fs from "fs";
375
+
376
+ const { image } = await generateImage({
377
+ model: xai.image("grok-imagine-image-2.0"),
378
+ prompt: "A serene Japanese garden",
379
+ });
380
+
381
+ // Save to file (AI SDK returns base64 by default)
382
+ const imageBuffer = Buffer.from(image.base64, "base64");
383
+ fs.writeFileSync("garden.jpg", imageBuffer);
384
+ ```
385
+
386
+ ```python customLanguage="pythonOpenAISDK"
387
+ import base64
388
+ from openai import OpenAI
389
+
390
+ client = OpenAI(
391
+ base_url="https://api.x.ai/v1",
392
+ api_key="YOUR_API_KEY",
393
+ )
394
+
395
+ response = client.images.generate(
396
+ model="grok-imagine-image-2.0",
397
+ prompt="A serene Japanese garden",
398
+ response_format="b64_json",
399
+ )
400
+
401
+ # Save to file
402
+ image_bytes = base64.b64decode(response.data[0].b64_json)
403
+ with open("garden.jpg", "wb") as f:
404
+ f.write(image_bytes)
405
+ ```
406
+
407
+ ```javascript customLanguage="javascriptOpenAISDK"
408
+ import OpenAI from "openai";
409
+ import fs from "fs";
410
+
411
+ const client = new OpenAI({
412
+ apiKey: process.env.XAI_API_KEY,
413
+ baseURL: "https://api.x.ai/v1",
414
+ });
415
+
416
+ const response = await client.images.generate({
417
+ model: "grok-imagine-image-2.0",
418
+ prompt: "A serene Japanese garden",
419
+ response_format: "b64_json",
420
+ });
421
+
422
+ // Save to file
423
+ const imageBuffer = Buffer.from(response.data[0].b64_json, "base64");
424
+ fs.writeFileSync("garden.jpg", imageBuffer);
425
+ ```
426
+
427
+ ```bash
428
+ curl -X POST https://api.x.ai/v1/images/generations \
429
+ -H "Content-Type: application/json" \
430
+ -H "Authorization: Bearer $XAI_API_KEY" \
431
+ -d '{
432
+ "model": "grok-imagine-image-2.0",
433
+ "prompt": "A serene Japanese garden",
434
+ "response_format": "b64_json"
435
+ }'
436
+ ```
437
+
438
+ ```python customLanguage="pythonXAI"
439
+ import xai_sdk
440
+
441
+ client = xai_sdk.Client()
442
+
443
+ response = client.image.sample(
444
+ prompt="A serene Japanese garden",
445
+ model="grok-imagine-image-2.0",
446
+ image_format="base64",
447
+ )
448
+
449
+ # Save to file
450
+ with open("garden.jpg", "wb") as f:
451
+ f.write(response.image)
452
+ ```
453
+
454
+ ### Deferred Generation
455
+
456
+ 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.
457
+
458
+ The poll response carries a `status`:
459
+
460
+ * `pending` (HTTP `202`): still generating
461
+ * `done` (HTTP `200`): `data` and `usage` are populated, in the same shape as a synchronous response
462
+ * `failed` (HTTP `200`): `error` holds a `code` and `message`
463
+
464
+ ```python customLanguage="pythonRequests"
465
+ import os
466
+ import time
467
+ import requests
468
+
469
+ headers = {
470
+ "Authorization": f"Bearer {os.getenv('XAI_API_KEY')}",
471
+ "Content-Type": "application/json",
472
+ }
473
+
474
+ # Step 1: Start generation
475
+ response = requests.post(
476
+ "https://api.x.ai/v1/images/generations",
477
+ headers=headers,
478
+ json={
479
+ "model": "grok-imagine-image-2.0",
480
+ "prompt": "A serene Japanese garden",
481
+ "deferred": True,
482
+ },
483
+ )
484
+ request_id = response.json()["request_id"]
485
+
486
+ # Step 2: Poll for the result
487
+ while True:
488
+ result = requests.get(
489
+ f"https://api.x.ai/v1/images/{request_id}",
490
+ headers={"Authorization": headers["Authorization"]},
491
+ )
492
+ data = result.json()
493
+
494
+ if data["status"] == "done":
495
+ print(f"Image URL: {data['data'][0]['url']}")
496
+ break
497
+ elif data["status"] == "failed":
498
+ print(f"Generation failed: {data['error']['message']}")
499
+ break
500
+ else:
501
+ print("Still processing...")
502
+ time.sleep(5)
503
+ ```
504
+
505
+ ```bash
506
+ # Step 1: Start generation
507
+ curl -X POST https://api.x.ai/v1/images/generations \
508
+ -H "Content-Type: application/json" \
509
+ -H "Authorization: Bearer $XAI_API_KEY" \
510
+ -d '{
511
+ "model": "grok-imagine-image-2.0",
512
+ "prompt": "A serene Japanese garden",
513
+ "deferred": true
514
+ }'
515
+ # => {"request_id": "..."}
516
+
517
+ # Step 2: Poll for the result
518
+ curl https://api.x.ai/v1/images/<request_id> \
519
+ -H "Authorization: Bearer $XAI_API_KEY"
520
+ # => 202 {"request_id": "...", "status": "pending"}
521
+ # => 200 {"request_id": "...", "status": "done", "data": [{"url": "...", "mime_type": "image/jpeg"}], "usage": {...}}
522
+ ```
523
+
524
+ 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.
525
+
526
+ ### Response Details
527
+
528
+ The xAI SDK exposes additional metadata on the response object beyond the image URL or base64 data.
529
+
530
+ **Moderation** — Check whether the generated image passed content moderation:
531
+
532
+ ```python customLanguage="pythonXAI"
533
+ if response.respect_moderation:
534
+ print(response.url)
535
+ else:
536
+ print("Image filtered by moderation")
537
+ ```
538
+
539
+ **Model** — Get the actual model used (resolving any aliases):
540
+
541
+ ```python customLanguage="pythonXAI"
542
+ print(f"Model: {response.model}")
543
+ ```
544
+
545
+ ## Concurrent Requests
546
+
547
+ 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.
548
+
549
+ > [!TIP]
550
+ >
551
+ > 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.
552
+
553
+ ```python customLanguage="pythonXAI"
554
+ import asyncio
555
+ import xai_sdk
556
+
557
+ async def generate_concurrently():
558
+ client = xai_sdk.AsyncClient()
559
+
560
+ # Each request uses a different prompt
561
+ prompts = [
562
+ "A futuristic city skyline at sunset",
563
+ "A serene Japanese garden in winter",
564
+ "An astronaut floating above Earth",
565
+ "A medieval castle on a misty mountain",
566
+ ]
567
+
568
+ # Fire all requests concurrently
569
+ tasks = [
570
+ client.image.sample(
571
+ prompt=prompt,
572
+ model="grok-imagine-image-2.0",
573
+ )
574
+ for prompt in prompts
575
+ ]
576
+
577
+ results = await asyncio.gather(*tasks)
578
+
579
+ for prompt, result in zip(prompts, results):
580
+ print(f"{prompt}: {result.url}")
581
+
582
+ asyncio.run(generate_concurrently())
583
+ ```
584
+
585
+ ## Related
586
+
587
+ * [Models](/developers/models) — Available image models
588
+ * [Image Editing](/developers/model-capabilities/images/editing) — Edit images with natural language
589
+ * [Image Prompting Guide](/developers/model-capabilities/images/prompting-guide) — Write prompts that keep the subject recognizable
590
+ * [Image Generation Tool](/developers/tools/image-generation) — Let Grok generate and edit images inside a conversation
591
+ * [Video Generation](/developers/model-capabilities/video/generation) — Generate videos from text prompts
592
+ * [API Reference](/developers/rest-api-reference) — Full endpoint documentation
593
+ * [Imagine API Landing Page](https://x.ai/api/imagine) — Showcase of the Imagine API in action
pipeline/provider_docs/xai__docs.x.ai_developers_rest-api-reference_inference_images.md ADDED
@@ -0,0 +1,495 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #### Inference API
2
+
3
+ # Images
4
+
5
+ ## POST /v1/images/generations
6
+
7
+ Generate an image based on a prompt. This is the endpoint for making generation requests to image generation models.
8
+
9
+ ### Request Body
10
+
11
+ * `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")
12
+
13
+ * `deferred` (boolean | null) — If set, the request returns immediately with a \`request\_id\` and the
14
+ image is generated in the background. Poll \`GET /v1/images/\{request\_id}\`
15
+ for the result. Only \`response\_format: "url"\` is supported in this mode.
16
+
17
+ * `model` (string | null) — Model to be used.
18
+
19
+ * `n` (integer | null) — Number of images to be generated
20
+
21
+ * `output` (object)
22
+
23
+ * `upload_urls` (array\<string>, required) — Signed URLs to upload the generated images via HTTP PUT, one per
24
+ image: the list length must equal \`n\` (default 1). Each PUT sends a
25
+ \`Content-Type\` equal to the image's \`mime\_type\` in the response
26
+ (\`image/jpeg\` unless the requested quality produces PNG), so sign the
27
+ URL for that type or without a Content-Type constraint. Azure Blob SAS
28
+ URLs also get \`x-ms-blob-type: BlockBlob\`.
29
+
30
+ * `prompt` (string) — Prompt for image generation.
31
+
32
+ * `resolution` ("1k" | "2k" | "1.5k")
33
+
34
+ * `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.
35
+
36
+ * `storage_options` (object)
37
+
38
+ * `expires_after` (integer | null) — Seconds from now until the file auto-expires. Maximum 2592000 (30 days).
39
+ If omitted, the file does not expire.
40
+
41
+ * `filename` (string, required) — Filename for the stored file.
42
+
43
+ * `public_url` (boolean | object)
44
+
45
+ * `user` (string | null) — A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.
46
+
47
+ ### Response Body
48
+
49
+ * `data` (array\<object>, required) — A list of generated image objects.
50
+
51
+ * `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.
52
+
53
+ * `file_output` (object)
54
+
55
+ * `expires_at` (integer | null) — Unix timestamp (seconds) when the stored file expires and will be
56
+ automatically deleted. Only present when the file has an expiration.
57
+
58
+ * `file_id` (string, required) — Files API file\_id of the stored file.
59
+
60
+ * `filename` (string, required) — Filename of the stored file.
61
+
62
+ * `public_url` (string | null) — Public URL for the stored file. Only present when the request included
63
+ \`storage\_options.public\_url\` and creation succeeded.
64
+
65
+ * `public_url_error` (string | null) — Human-readable error when \`storage\_options.public\_url\` was set but
66
+ public URL creation failed. The file was stored successfully.
67
+
68
+ * `public_url_expires_at` (integer | null) — Unix timestamp (seconds) when the public URL expires. Present when
69
+ the public URL has an expiry, either from an explicit \`expires\_after\`
70
+ in the request or inherited from the file's TTL.
71
+
72
+ * `mime_type` (string | null) — The MIME type of the generated image (e.g. \`image/png\`, \`image/jpeg\`, \`image/webp\`).
73
+
74
+ * `storage_error` (string | null) — Human-readable error when \`storage\_options\` was set but the upload
75
+ failed. Absent on success or when storage was not requested.
76
+
77
+ * `url` (string | null) — A url to the generated image, if \`response\_format\` is not specified or with \`url\` in the request.
78
+
79
+ * `usage` (object)
80
+
81
+ * `cost_in_usd_ticks` (integer, required) — The cost of this request expressed in USD ticks.
82
+ One USD cent equals 100,000,000 ticks, so one US dollar equals
83
+ 10,000,000,000 ticks.
84
+
85
+ * `input_tokens` (integer | null) — Total input tokens: prompt text tokens + input image tokens
86
+ (the sum of \`input\_tokens\_details\`, where \`cached\_tokens\` is a subset
87
+ of \`text\_tokens\`, not additive).
88
+
89
+ * `input_tokens_details` (object)
90
+
91
+ * `cached_tokens` (integer, required) — Text tokens served from cache from previous requests (a subset of
92
+ \`text\_tokens\`).
93
+
94
+ * `image_tokens` (integer, required) — Input image tokens, as reported by the image engine.
95
+
96
+ * `text_tokens` (integer, required) — Prompt text tokens consumed by the prompt-rewriting (upsampler) LLM,
97
+ including any served from cache.
98
+
99
+ * `output_tokens` (integer | null) — Total output tokens: rewritten-prompt text tokens + reasoning tokens
100
+ \+ generated image tokens (the sum of \`output\_tokens\_details\`).
101
+
102
+ * `output_tokens_details` (object)
103
+
104
+ * `image_tokens` (integer, required) — Generated image tokens, as reported by the image engine.
105
+
106
+ * `reasoning_tokens` (integer, required) — Reasoning (thinking) tokens generated by the prompt-rewriting
107
+ (upsampler) LLM.
108
+
109
+ * `text_tokens` (integer, required) — Rewritten-prompt text tokens generated by the prompt-rewriting
110
+ (upsampler) LLM, excluding reasoning tokens.
111
+
112
+ * `total_tokens` (integer | null) — Total tokens (input + output).
113
+
114
+ ### Code Examples
115
+
116
+ ```pythonOpenAISDK
117
+ import os
118
+
119
+ from openai import OpenAI
120
+
121
+ client = OpenAI(
122
+ api_key=os.environ["XAI_API_KEY"],
123
+ base_url="https://api.x.ai/v1",
124
+ )
125
+
126
+ response = client.images.generate(
127
+ model="grok-imagine-image-2.0",
128
+ prompt="A collage of London landmarks in a stenciled street‑art style",
129
+ )
130
+
131
+ print(response.model_dump_json(indent=2))
132
+ ```
133
+
134
+ ```bash
135
+ curl -s https://api.x.ai/v1/images/generations \
136
+ -H "Content-Type: application/json" \
137
+ -H "Authorization: Bearer $XAI_API_KEY" \
138
+ -d '{
139
+ "model": "grok-imagine-image-2.0",
140
+ "prompt": "A collage of London landmarks in a stenciled street‑art style"
141
+ }'
142
+ ```
143
+
144
+ ```javascriptOpenAISDK
145
+ import OpenAI from "openai";
146
+
147
+ const client = new OpenAI({
148
+ apiKey: process.env.XAI_API_KEY,
149
+ baseURL: "https://api.x.ai/v1",
150
+ });
151
+
152
+ const response = await client.images.generate({
153
+ model: "grok-imagine-image-2.0",
154
+ prompt: "A collage of London landmarks in a stenciled street‑art style",
155
+ });
156
+
157
+ console.log(JSON.stringify(response, null, 2));
158
+ ```
159
+
160
+ \*\*Response example:\*\*
161
+
162
+ ```json
163
+ {
164
+ "data": [
165
+ {
166
+ "url": "..."
167
+ },
168
+ {
169
+ "url": "..."
170
+ }
171
+ ]
172
+ }
173
+ ```
174
+
175
+ ***
176
+
177
+ ## POST /v1/images/edits
178
+
179
+ Edit an image based on a prompt. This is the endpoint for making edit requests to image generation models.
180
+
181
+ ### Request Body
182
+
183
+ * `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")
184
+
185
+ * `deferred` (boolean | null) — If set, the request returns immediately with a \`request\_id\` and the
186
+ edit is generated in the background. Poll \`GET /v1/images/\{request\_id}\`
187
+ for the result. Only \`response\_format: "url"\` is supported in this mode.
188
+
189
+ * `image` (object)
190
+
191
+ * `file_id` (string | null) — File ID from the xAI Files API. Mutually exclusive with \`url\`.
192
+ The file must be an image (JPEG, PNG, or WebP) and fully uploaded.
193
+
194
+ * `url` (string) — Public URL or base64-encoded data URL of the image (JPEG, PNG, or WebP).
195
+ Also accepts \`image\_url\` for compatibility.
196
+ Required when \`file\_id\` is not set.
197
+
198
+ * `images` (array\<object>) — List of input images for multi-reference editing.
199
+ Mutually exclusive with \`image\`. When multiple images are provided,
200
+ refer to them as \\\<IMAGE\_0\\>, \\\<IMAGE\_1\\>, etc. in the prompt.
201
+
202
+ * `file_id` (string | null) — File ID from the xAI Files API. Mutually exclusive with \`url\`.
203
+ The file must be an image (JPEG, PNG, or WebP) and fully uploaded.
204
+
205
+ * `url` (string) — Public URL or base64-encoded data URL of the image (JPEG, PNG, or WebP).
206
+ Also accepts \`image\_url\` for compatibility.
207
+ Required when \`file\_id\` is not set.
208
+
209
+ * `model` (string | null) — Model to be used.
210
+
211
+ * `n` (integer | null) — Number of image edits to be generated.
212
+
213
+ * `output` (object)
214
+
215
+ * `upload_urls` (array\<string>, required) — Signed URLs to upload the generated images via HTTP PUT, one per
216
+ image: the list length must equal \`n\` (default 1). Each PUT sends a
217
+ \`Content-Type\` equal to the image's \`mime\_type\` in the response
218
+ (\`image/jpeg\` unless the requested quality produces PNG), so sign the
219
+ URL for that type or without a Content-Type constraint. Azure Blob SAS
220
+ URLs also get \`x-ms-blob-type: BlockBlob\`.
221
+
222
+ * `prompt` (string, required) — Prompt for image editing.
223
+
224
+ * `resolution` ("1k" | "2k" | "1.5k")
225
+
226
+ * `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.
227
+
228
+ * `storage_options` (object)
229
+
230
+ * `expires_after` (integer | null) — Seconds from now until the file auto-expires. Maximum 2592000 (30 days).
231
+ If omitted, the file does not expire.
232
+
233
+ * `filename` (string, required) — Filename for the stored file.
234
+
235
+ * `public_url` (boolean | object)
236
+
237
+ * `user` (string | null) — A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.
238
+
239
+ ### Response Body
240
+
241
+ * `data` (array\<object>, required) — A list of generated image objects.
242
+
243
+ * `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.
244
+
245
+ * `file_output` (object)
246
+
247
+ * `expires_at` (integer | null) — Unix timestamp (seconds) when the stored file expires and will be
248
+ automatically deleted. Only present when the file has an expiration.
249
+
250
+ * `file_id` (string, required) — Files API file\_id of the stored file.
251
+
252
+ * `filename` (string, required) — Filename of the stored file.
253
+
254
+ * `public_url` (string | null) — Public URL for the stored file. Only present when the request included
255
+ \`storage\_options.public\_url\` and creation succeeded.
256
+
257
+ * `public_url_error` (string | null) — Human-readable error when \`storage\_options.public\_url\` was set but
258
+ public URL creation failed. The file was stored successfully.
259
+
260
+ * `public_url_expires_at` (integer | null) — Unix timestamp (seconds) when the public URL expires. Present when
261
+ the public URL has an expiry, either from an explicit \`expires\_after\`
262
+ in the request or inherited from the file's TTL.
263
+
264
+ * `mime_type` (string | null) — The MIME type of the generated image (e.g. \`image/png\`, \`image/jpeg\`, \`image/webp\`).
265
+
266
+ * `storage_error` (string | null) — Human-readable error when \`storage\_options\` was set but the upload
267
+ failed. Absent on success or when storage was not requested.
268
+
269
+ * `url` (string | null) — A url to the generated image, if \`response\_format\` is not specified or with \`url\` in the request.
270
+
271
+ * `usage` (object)
272
+
273
+ * `cost_in_usd_ticks` (integer, required) — The cost of this request expressed in USD ticks.
274
+ One USD cent equals 100,000,000 ticks, so one US dollar equals
275
+ 10,000,000,000 ticks.
276
+
277
+ * `input_tokens` (integer | null) — Total input tokens: prompt text tokens + input image tokens
278
+ (the sum of \`input\_tokens\_details\`, where \`cached\_tokens\` is a subset
279
+ of \`text\_tokens\`, not additive).
280
+
281
+ * `input_tokens_details` (object)
282
+
283
+ * `cached_tokens` (integer, required) — Text tokens served from cache from previous requests (a subset of
284
+ \`text\_tokens\`).
285
+
286
+ * `image_tokens` (integer, required) — Input image tokens, as reported by the image engine.
287
+
288
+ * `text_tokens` (integer, required) — Prompt text tokens consumed by the prompt-rewriting (upsampler) LLM,
289
+ including any served from cache.
290
+
291
+ * `output_tokens` (integer | null) — Total output tokens: rewritten-prompt text tokens + reasoning tokens
292
+ \+ generated image tokens (the sum of \`output\_tokens\_details\`).
293
+
294
+ * `output_tokens_details` (object)
295
+
296
+ * `image_tokens` (integer, required) — Generated image tokens, as reported by the image engine.
297
+
298
+ * `reasoning_tokens` (integer, required) — Reasoning (thinking) tokens generated by the prompt-rewriting
299
+ (upsampler) LLM.
300
+
301
+ * `text_tokens` (integer, required) — Rewritten-prompt text tokens generated by the prompt-rewriting
302
+ (upsampler) LLM, excluding reasoning tokens.
303
+
304
+ * `total_tokens` (integer | null) — Total tokens (input + output).
305
+
306
+ ### Code Examples
307
+
308
+ ```bash
309
+ curl -s https://api.x.ai/v1/images/edits \
310
+ -H "Content-Type: application/json" \
311
+ -H "Authorization: Bearer $XAI_API_KEY" \
312
+ -d '{
313
+ "model": "grok-imagine-image-2.0",
314
+ "prompt": "Render this as a pencil sketch with detailed shading",
315
+ "image": {
316
+ "url": "https://docs.x.ai/assets/api-examples/images/style-realistic.png",
317
+ "type": "image_url"
318
+ }
319
+ }'
320
+ ```
321
+
322
+ ```javascriptWithoutSDK
323
+ const response = await fetch("https://api.x.ai/v1/images/edits", {
324
+ method: "POST",
325
+ headers: {
326
+ Authorization: `Bearer ${process.env.XAI_API_KEY}`,
327
+ "Content-Type": "application/json",
328
+ },
329
+ body: JSON.stringify({
330
+ model: "grok-imagine-image-2.0",
331
+ prompt: "Render this as a pencil sketch with detailed shading",
332
+ image: {
333
+ url: "https://docs.x.ai/assets/api-examples/images/style-realistic.png",
334
+ type: "image_url",
335
+ },
336
+ }),
337
+ });
338
+
339
+ console.log(JSON.stringify(await response.json(), null, 2));
340
+ ```
341
+
342
+ ```pythonWithoutSDK
343
+ import json
344
+ import os
345
+
346
+ import requests
347
+
348
+ response = requests.post(
349
+ "https://api.x.ai/v1/images/edits",
350
+ headers={
351
+ "Authorization": f"Bearer {os.environ['XAI_API_KEY']}",
352
+ "Content-Type": "application/json",
353
+ },
354
+ json={
355
+ "model": "grok-imagine-image-2.0",
356
+ "prompt": "Render this as a pencil sketch with detailed shading",
357
+ "image": {
358
+ "url": "https://docs.x.ai/assets/api-examples/images/style-realistic.png",
359
+ "type": "image_url",
360
+ },
361
+ },
362
+ )
363
+
364
+ print(json.dumps(response.json(), indent=2))
365
+ ```
366
+
367
+ \*\*Response example:\*\*
368
+
369
+ ```json
370
+ {
371
+ "data": [
372
+ {
373
+ "url": "..."
374
+ }
375
+ ]
376
+ }
377
+ ```
378
+
379
+ ***
380
+
381
+ ## GET /v1/images/\{request\_id}
382
+
383
+ \`GET /v1/images/\{request\_id}\`: 202 while pending, 200 with \`data\` when
384
+ done or with \`error\` when failed (a failed generation is a body, not an
385
+ HTTP error, so pollers do not retry-storm).
386
+
387
+ ### Path Parameters
388
+
389
+ * `request_id` (string, required) — The deferred request id returned by a previous image request.
390
+
391
+ ### Response Body
392
+
393
+ * `data` (array | null) — The generated images. Present when done.
394
+
395
+ * `error` (object)
396
+
397
+ * `code` (string, required) — Machine-readable error code: \`invalid\_argument\`, \`permission\_denied\`,
398
+ \`failed\_precondition\`, \`service\_unavailable\` or \`internal\_error\`.
399
+
400
+ * `message` (string, required) — Human-readable error message describing the failure.
401
+
402
+ * `request_id` (string, required) — The polled request id.
403
+
404
+ * `status` (string, required) — \`"pending"\`, \`"done"\` or \`"failed"\`.
405
+
406
+ * `usage` (object)
407
+
408
+ * `cost_in_usd_ticks` (integer, required) — The cost of this request expressed in USD ticks.
409
+ One USD cent equals 100,000,000 ticks, so one US dollar equals
410
+ 10,000,000,000 ticks.
411
+
412
+ * `input_tokens` (integer | null) — Total input tokens: prompt text tokens + input image tokens
413
+ (the sum of \`input\_tokens\_details\`, where \`cached\_tokens\` is a subset
414
+ of \`text\_tokens\`, not additive).
415
+
416
+ * `input_tokens_details` (object)
417
+
418
+ * `cached_tokens` (integer, required) — Text tokens served from cache from previous requests (a subset of
419
+ \`text\_tokens\`).
420
+
421
+ * `image_tokens` (integer, required) — Input image tokens, as reported by the image engine.
422
+
423
+ * `text_tokens` (integer, required) — Prompt text tokens consumed by the prompt-rewriting (upsampler) LLM,
424
+ including any served from cache.
425
+
426
+ * `output_tokens` (integer | null) — Total output tokens: rewritten-prompt text tokens + reasoning tokens
427
+ \+ generated image tokens (the sum of \`output\_tokens\_details\`).
428
+
429
+ * `output_tokens_details` (object)
430
+
431
+ * `image_tokens` (integer, required) — Generated image tokens, as reported by the image engine.
432
+
433
+ * `reasoning_tokens` (integer, required) — Reasoning (thinking) tokens generated by the prompt-rewriting
434
+ (upsampler) LLM.
435
+
436
+ * `text_tokens` (integer, required) — Rewritten-prompt text tokens generated by the prompt-rewriting
437
+ (upsampler) LLM, excluding reasoning tokens.
438
+
439
+ * `total_tokens` (integer | null) — Total tokens (input + output).
440
+
441
+ ### Code Examples
442
+
443
+ ```bash
444
+ curl -s "https://api.x.ai/v1/images/$IMAGE_REQUEST_ID" \
445
+ -H "Authorization: Bearer $XAI_API_KEY"
446
+ ```
447
+
448
+ ```javascriptWithoutSDK
449
+ const response = await fetch(
450
+ `https://api.x.ai/v1/images/${process.env.IMAGE_REQUEST_ID}`,
451
+ {
452
+ headers: {
453
+ Authorization: `Bearer ${process.env.XAI_API_KEY}`,
454
+ },
455
+ },
456
+ );
457
+
458
+ console.log(JSON.stringify(await response.json(), null, 2));
459
+ ```
460
+
461
+ ```pythonWithoutSDK
462
+ import json
463
+ import os
464
+
465
+ import requests
466
+
467
+ request_id = os.environ["IMAGE_REQUEST_ID"]
468
+
469
+ response = requests.get(
470
+ f"https://api.x.ai/v1/images/{request_id}",
471
+ headers={
472
+ "Authorization": f"Bearer {os.environ['XAI_API_KEY']}",
473
+ },
474
+ )
475
+
476
+ print(json.dumps(response.json(), indent=2))
477
+ ```
478
+
479
+ \*\*Response example:\*\*
480
+
481
+ ```json
482
+ {
483
+ "request_id": "e5b1b4d4-7b6a-4a0e-9c0d-7f3c7d8a1b2c",
484
+ "status": "done",
485
+ "data": [
486
+ {
487
+ "url": "..."
488
+ }
489
+ ],
490
+ "usage": {
491
+ "total_tokens": 0,
492
+ "image_cost": 2000000
493
+ }
494
+ }
495
+ ```