[{"data":1,"prerenderedAt":959},["ShallowReactive",2],{"page:\u002Fapi-references\u002Ffile\u002Fupload-generate":3},{"id":4,"title":5,"apiPage":6,"body":7,"description":904,"extension":905,"layout":906,"meta":907,"navigation":6,"path":908,"playground":909,"seo":956,"stem":957,"__hash__":958},"docs\u002Fapi-references\u002Ffile\u002Fupload-generate.md","Generate File",true,{"type":8,"value":9,"toc":893},"minimark",[10,14,19,25,29,55,68,71,95,288,292,297,306,310,317,324,343,351,358,367,375,384,389,408,412,417,423,432,435,453,629,633,642,759,770,774,780,872,889],[11,12,5],"h1",{"id":13},"generate-file",[15,16],"api-endpoint",{"method":17,"url":18},"POST","\u002Fapi\u002Fprojects\u002F:id\u002Ffiles\u002Fupload.generate",[20,21],"api-requirements",{":roles":22,"scope":23,"tier":24},"[\"OWNER\",\"ADMIN\",\"MEMBER\"]","ai:generate","2",[26,27,28],"p",{},"Generates a file with AI in the generation mode you choose.",[30,31,32,44],"ul",{},[33,34,35,39,40,43],"li",{},[36,37,38],"code",{},"AUTO"," analyzes your prompt and attachments to plan the generation, and keeps any output settings you send in ",[36,41,42],{},"configs",".",[33,45,46,49,50,52,53,43],{},[36,47,48],{},"ADVANCED"," generates from your prompt and ",[36,51,42],{}," as sent. Put every attachment in an attachment slot of ",[36,54,42],{},[26,56,57,58,60,61,64,65,43],{},"If ",[36,59,48],{}," cannot use an attachment under the model's rules, the error response gives that attachment's ID in ",[36,62,63],{},"error.details.attachment.id"," and the reason in ",[36,66,67],{},"error.details.reason",[26,69,70],{},"Available only in projects of the workspace your API key or connection belongs to, not in projects another workspace has linked to it.",[72,73,74],"note",{},[26,75,76,77,82,83,86,87,90,91,94],{},"To check the generation result, poll ",[78,79,81],"a",{"href":80},"\u002Fapi-references\u002Ffile\u002Fget","Get File"," until ",[36,84,85],{},"status"," is ",[36,88,89],{},"UPLOADED"," (succeeded) or ",[36,92,93],{},"FAILED"," (failed).",[96,97,99,104,166,213,254],"api-example",{"method":17,"url":18,"status":98},"202 Accepted",[100,101,103],"h2",{"id":102},"example","Example",[105,106,111],"pre",{"className":107,"code":108,"language":109,"meta":110,"style":110},"language-bash shiki shiki-themes ayu-light ayu-light ayu-dark","curl -X POST 'https:\u002F\u002Fapi.youvico.com\u002Fapi\u002Fprojects\u002Fbdbff5de-96d7-468f-9db0-85fe28bd6b62\u002Ffiles\u002Fupload.generate' \\\n  -H 'Authorization: Bearer YOUR_API_KEY' \\\n  -H 'Content-Type: application\u002Fjson' \\\n  -d '{ \"mode\": \"ADVANCED\", \"output\": { \"type\": \"VIDEO\", \"model\": \"kling-3.0\" }, \"prompt\": \"The camera slowly pushes in as the sneaker turns on a turntable.\", \"folder\": { \"id\": \"DX1234567890ABCD\" }, \"attachments\": [{ \"id\": \"GA1234567890ABCD\" }], \"configs\": { \"start\": \"GA1234567890ABCD\", \"durationSeconds\": 10 } }'\n","bash","",[36,112,113,136,147,157],{"__ignoreMap":110},[114,115,118,122,126,130,133],"span",{"class":116,"line":117},"line",1,[114,119,121],{"class":120},"s6MYo","curl",[114,123,125],{"class":124},"sTJUr"," -X",[114,127,129],{"class":128},"sHwJV"," POST",[114,131,132],{"class":128}," 'https:\u002F\u002Fapi.youvico.com\u002Fapi\u002Fprojects\u002Fbdbff5de-96d7-468f-9db0-85fe28bd6b62\u002Ffiles\u002Fupload.generate'",[114,134,135],{"class":124}," \\\n",[114,137,139,142,145],{"class":116,"line":138},2,[114,140,141],{"class":124},"  -H",[114,143,144],{"class":128}," 'Authorization: Bearer YOUR_API_KEY'",[114,146,135],{"class":124},[114,148,150,152,155],{"class":116,"line":149},3,[114,151,141],{"class":124},[114,153,154],{"class":128}," 'Content-Type: application\u002Fjson'",[114,156,135],{"class":124},[114,158,160,163],{"class":116,"line":159},4,[114,161,162],{"class":124},"  -d",[114,164,165],{"class":128}," '{ \"mode\": \"ADVANCED\", \"output\": { \"type\": \"VIDEO\", \"model\": \"kling-3.0\" }, \"prompt\": \"The camera slowly pushes in as the sneaker turns on a turntable.\", \"folder\": { \"id\": \"DX1234567890ABCD\" }, \"attachments\": [{ \"id\": \"GA1234567890ABCD\" }], \"configs\": { \"start\": \"GA1234567890ABCD\", \"durationSeconds\": 10 } }'\n",[105,167,171],{"className":168,"code":169,"language":170,"meta":110,"style":110},"language-json shiki shiki-themes ayu-light ayu-light ayu-dark","{\n  \"data\": {\n    \"id\": \"FXABCDEFGHIJKLMN\"\n  }\n}\n","json",[36,172,173,179,192,202,207],{"__ignoreMap":110},[114,174,175],{"class":116,"line":117},[114,176,178],{"class":177},"snvv_","{\n",[114,180,181,185,189],{"class":116,"line":138},[114,182,184],{"class":183},"soLcz","  \"data\"",[114,186,188],{"class":187},"sgRSP",":",[114,190,191],{"class":177}," {\n",[114,193,194,197,199],{"class":116,"line":149},[114,195,196],{"class":183},"    \"id\"",[114,198,188],{"class":187},[114,200,201],{"class":128}," \"FXABCDEFGHIJKLMN\"\n",[114,203,204],{"class":116,"line":159},[114,205,206],{"class":177},"  }\n",[114,208,210],{"class":116,"line":209},5,[114,211,212],{"class":177},"}\n",[214,215,216],"template",{"v-slot:request":110},[105,217,218],{"className":107,"code":108,"language":109,"meta":110,"style":110},[36,219,220,232,240,248],{"__ignoreMap":110},[114,221,222,224,226,228,230],{"class":116,"line":117},[114,223,121],{"class":120},[114,225,125],{"class":124},[114,227,129],{"class":128},[114,229,132],{"class":128},[114,231,135],{"class":124},[114,233,234,236,238],{"class":116,"line":138},[114,235,141],{"class":124},[114,237,144],{"class":128},[114,239,135],{"class":124},[114,241,242,244,246],{"class":116,"line":149},[114,243,141],{"class":124},[114,245,154],{"class":128},[114,247,135],{"class":124},[114,249,250,252],{"class":116,"line":159},[114,251,162],{"class":124},[114,253,165],{"class":128},[214,255,256],{"v-slot:response":110},[105,257,258],{"className":168,"code":169,"language":170,"meta":110,"style":110},[36,259,260,264,272,280,284],{"__ignoreMap":110},[114,261,262],{"class":116,"line":117},[114,263,178],{"class":177},[114,265,266,268,270],{"class":116,"line":138},[114,267,184],{"class":183},[114,269,188],{"class":187},[114,271,191],{"class":177},[114,273,274,276,278],{"class":116,"line":149},[114,275,196],{"class":183},[114,277,188],{"class":187},[114,279,201],{"class":128},[114,281,282],{"class":116,"line":159},[114,283,206],{"class":177},[114,285,286],{"class":116,"line":209},[114,287,212],{"class":177},[100,289,291],{"id":290},"request","Request",[293,294,296],"h3",{"id":295},"path","Path",[298,299,303],"param-field",{"name":300,"type":301,":required":302},"id","string","true",[26,304,305],{},"Project ID",[293,307,309],{"id":308},"body","Body",[298,311,314],{"name":312,"type":301,":required":302,"example":48,"values":313},"mode","AUTO, ADVANCED",[26,315,316],{},"Generation mode",[298,318,321],{"name":319,"type":320,":required":302},"output","object",[26,322,323],{},"Output type and model",[325,326,327,335],"param-children",{},[298,328,332],{"name":329,"type":301,":required":302,"example":330,":indent":302,"values":331},"output.type","VIDEO","PDF, MARKDOWN, IMAGE, VIDEO, 3D, MUSIC",[26,333,334],{},"Output type",[298,336,340],{"name":337,"type":301,":required":302,"example":338,":indent":302,"values-by":329,"values-table":339},"output.model","kling-3.0","models",[26,341,342],{},"Model ID for output.type. See Models below",[298,344,348],{"name":345,"type":301,":required":302,"example":346,"constraints":347},"prompt","The camera slowly pushes in as the sneaker turns on a turntable.","1-20000 characters",[26,349,350],{},"Generation prompt",[298,352,355],{"name":353,"type":354,":required":302},"folder","object?",[26,356,357],{},"Target folder. null for the project root",[325,359,360],{},[298,361,364],{"name":362,"type":301,":required":302,"example":363,":indent":302},"folder.id","DX1234567890ABCD",[26,365,366],{},"Folder ID",[298,368,372],{"name":369,"type":370,":required":302,"constraints":371},"attachments","array","0-50 items, unique IDs",[26,373,374],{},"Reference files",[325,376,377],{},[298,378,381],{"name":379,"type":301,":required":302,"example":380,":indent":302},"attachments[].id","GA1234567890ABCD",[26,382,383],{},"Project file ID (FX) or generation attachment ID (GA)",[298,385,386],{"name":42,"type":320},[26,387,388],{},"Settings. Must match the model's schema for the mode",[72,390,391],{},[26,392,393,394,396,397,399,400,404,405,407],{},"In ",[36,395,48],{},", every ID in ",[36,398,369],{}," must appear in an ",[78,401,403],{"href":402},"#attachment-slots","attachment slot"," of ",[36,406,42],{},", and the slots cannot name any other ID.",[100,409,411],{"id":410},"response","Response",[26,413,414,415,43],{},"Returns ",[36,416,98],{},[298,418,420],{"name":419,"type":320},"data",[26,421,422],{},"File being generated",[325,424,425],{},[298,426,429],{"name":427,"type":301,"example":428,":indent":302},"data.id","FXABCDEFGHIJKLMN",[26,430,431],{},"ID of the created file",[100,433,434],{"id":339},"Models",[26,436,437,441,442,445,446,449,450,452],{},[78,438,440],{"href":439},"\u002Fapi-references\u002Fai-model\u002Flist","List Models"," returns each model's settings schema. Document models (",[36,443,444],{},"PDF",", ",[36,447,448],{},"MARKDOWN",") support ",[36,451,48],{}," only.",[454,455,456,467],"table",{},[457,458,459],"thead",{},[460,461,462,465],"tr",{},[463,464,334],"th",{},[463,466,434],{},[468,469,470,506,532,562,602,617],"tbody",{},[460,471,472,477],{},[473,474,475],"td",{},[36,476,444],{},[473,478,479,445,482,445,485,445,488,445,491,445,494,445,497,445,500,445,503],{},[36,480,481],{},"claude-fable-5-1",[36,483,484],{},"claude-opus-5-5",[36,486,487],{},"claude-sonnet-5-5",[36,489,490],{},"claude-haiku-5-5",[36,492,493],{},"gpt-6-astra",[36,495,496],{},"gpt-6.1-sol",[36,498,499],{},"gpt-6-luna",[36,501,502],{},"gemini-4-argon",[36,504,505],{},"gemini-3.8-flash",[460,507,508,512],{},[473,509,510],{},[36,511,448],{},[473,513,514,445,516,445,518,445,520,445,522,445,524,445,526,445,528,445,530],{},[36,515,481],{},[36,517,484],{},[36,519,487],{},[36,521,490],{},[36,523,493],{},[36,525,496],{},[36,527,499],{},[36,529,502],{},[36,531,505],{},[460,533,534,539],{},[473,535,536],{},[36,537,538],{},"IMAGE",[473,540,541,445,544,445,547,445,550,445,553,445,556,445,559],{},[36,542,543],{},"gpt-image-2.5-flare",[36,545,546],{},"gpt-image-2.5-sunburst",[36,548,549],{},"gpt-image-2",[36,551,552],{},"gemini-nano-banana-2.1",[36,554,555],{},"gemini-3-pro-image",[36,557,558],{},"gemini-3.1-flash-image",[36,560,561],{},"gemini-3.1-flash-lite-image",[460,563,564,568],{},[473,565,566],{},[36,567,330],{},[473,569,570,445,573,445,576,445,579,445,582,445,585,445,587,445,590,445,593,445,596,445,599],{},[36,571,572],{},"seedance-2.5",[36,574,575],{},"seedance-2.0",[36,577,578],{},"seedance-2.0-fast",[36,580,581],{},"seedance-2.0-mini",[36,583,584],{},"kling-3.0-omni",[36,586,338],{},[36,588,589],{},"kling-3.0-turbo",[36,591,592],{},"minimax-h3-max",[36,594,595],{},"minimax-h3",[36,597,598],{},"veo-3.1-generate-preview",[36,600,601],{},"veo-3.1-lite-generate-preview",[460,603,604,609],{},[473,605,606],{},[36,607,608],{},"3D",[473,610,611,445,614],{},[36,612,613],{},"meshy-7.1",[36,615,616],{},"hunyuan3d-3.1",[460,618,619,624],{},[473,620,621],{},[36,622,623],{},"MUSIC",[473,625,626],{},[36,627,628],{},"lyria-3.5",[100,630,632],{"id":631},"settings","Settings",[26,634,635,636,638,639,641],{},"Accepted values and defaults are in each model's schema. In ",[36,637,38],{},", settings you omit are chosen by YouViCo. In ",[36,640,48],{},", they use their defaults.",[454,643,644,654],{},[457,645,646],{},[460,647,648,651],{},[463,649,650],{},"Setting",[463,652,653],{},"Description",[468,655,656,666,680,690,700,710,729,739,749],{},[460,657,658,663],{},[473,659,660],{},[36,661,662],{},"effort",[473,664,665],{},"Thinking level. Higher levels think longer",[460,667,668,673],{},[473,669,670],{},[36,671,672],{},"aspectRatio",[473,674,675,676,679],{},"Aspect ratio. ",[36,677,678],{},"adaptive"," follows the input image or video",[460,681,682,687],{},[473,683,684],{},[36,685,686],{},"resolution",[473,688,689],{},"Output resolution",[460,691,692,697],{},[473,693,694],{},[36,695,696],{},"quality",[473,698,699],{},"Image quality",[460,701,702,707],{},[473,703,704],{},[36,705,706],{},"outputFormat",[473,708,709],{},"Image or audio file format",[460,711,712,717],{},[473,713,714],{},[36,715,716],{},"transparent",[473,718,719,720,723,724,86,726],{},"Transparent background. Must be ",[36,721,722],{},"false"," when ",[36,725,706],{},[36,727,728],{},"jpeg",[460,730,731,736],{},[473,732,733],{},[36,734,735],{},"durationSeconds",[473,737,738],{},"Output length in seconds",[460,740,741,746],{},[473,742,743],{},[36,744,745],{},"generateAudio",[473,747,748],{},"Whether to generate sound",[460,750,751,756],{},[473,752,753],{},[36,754,755],{},"shouldTexture",[473,757,758],{},"Whether to apply textures",[26,760,761,763,764,766,767,769],{},[36,762,623],{}," models take only the ",[36,765,706],{}," setting. In ",[36,768,48],{},", describe lyrics, length, tempo, and key in the prompt.",[100,771,773],{"id":772},"attachment-slots","Attachment Slots",[26,775,776,777,779],{},"Only ",[36,778,48],{}," schemas have attachment slots. Each model's schema shows which slots it has and the rules between them.",[454,781,782,791],{},[457,783,784],{},[460,785,786,789],{},[463,787,788],{},"Slot",[463,790,653],{},[468,792,793,803,816,826,838,856],{},[460,794,795,800],{},[473,796,797],{},[36,798,799],{},"references",[473,801,802],{},"Reference images, videos, audio, or documents",[460,804,805,813],{},[473,806,807,445,810],{},[36,808,809],{},"start",[36,811,812],{},"end",[473,814,815],{},"Start and end frame images",[460,817,818,823],{},[473,819,820],{},[36,821,822],{},"edit",[473,824,825],{},"Video to edit. The output follows its length and aspect ratio",[460,827,828,833],{},[473,829,830],{},[36,831,832],{},"extend",[473,834,835,836],{},"Video to extend by ",[36,837,735],{},[460,839,840,845],{},[473,841,842],{},[36,843,844],{},"motion",[473,846,847,848,851,852,855],{},"Motion control. ",[36,849,850],{},"image"," and ",[36,853,854],{},"video"," are required",[460,857,858,863],{},[473,859,860],{},[36,861,862],{},"images",[473,864,865,866,868,869],{},"Input images for 3D. ",[36,867,616],{}," takes an object keyed by view and requires ",[36,870,871],{},"front",[26,873,874,875,878,879,882,883,851,885,888],{},"Some video models also accept ",[36,876,877],{},"negativePrompt",", what to avoid in the output, and ",[36,880,881],{},"shots",", a multi-shot list of ",[36,884,345],{},[36,886,887],{},"seconds"," that add up to the output length.",[890,891,892],"style",{},"html pre.shiki code .s6MYo, html code.shiki .s6MYo{--shiki-light:#22A4E6;--shiki-default:#22A4E6;--shiki-dark:#59C2FF}html pre.shiki code .sTJUr, html code.shiki .sTJUr{--shiki-light:#4CBF99;--shiki-default:#4CBF99;--shiki-dark:#95E6CB}html pre.shiki code .sHwJV, html code.shiki .sHwJV{--shiki-light:#86B300;--shiki-default:#86B300;--shiki-dark:#AAD94C}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .snvv_, html code.shiki .snvv_{--shiki-light:#5C6166;--shiki-default:#5C6166;--shiki-dark:#BFBDB6}html pre.shiki code .soLcz, html code.shiki .soLcz{--shiki-light:#55B4D4;--shiki-default:#55B4D4;--shiki-dark:#39BAE6}html pre.shiki code .sgRSP, html code.shiki .sgRSP{--shiki-light:#5C6166B3;--shiki-default:#5C6166B3;--shiki-dark:#BFBDB6B3}",{"title":110,"searchDepth":159,"depth":159,"links":894},[895,896,900,901,902,903],{"id":102,"depth":138,"text":103},{"id":290,"depth":138,"text":291,"children":897},[898,899],{"id":295,"depth":149,"text":296},{"id":308,"depth":149,"text":309},{"id":410,"depth":138,"text":411},{"id":339,"depth":138,"text":434},{"id":631,"depth":138,"text":632},{"id":772,"depth":138,"text":773},"Generate an image, video, 3D model, music, PDF, or Markdown file with AI from a prompt and reference files, in AUTO or ADVANCED mode.","md",null,{},"\u002Fapi-references\u002Ffile\u002Fupload-generate",{"method":17,"path":18,"params":910,"body":913,"fields":914},[911],{"name":300,"example":912,"type":301,"required":6,"constraints":110,"description":305},"bdbff5de-96d7-468f-9db0-85fe28bd6b62","{\n  \"mode\": \"ADVANCED\",\n  \"output\": {\n    \"type\": \"VIDEO\",\n    \"model\": \"kling-3.0\"\n  },\n  \"prompt\": \"The camera slowly pushes in as the sneaker turns on a turntable.\",\n  \"folder\": {\n    \"id\": \"DX1234567890ABCD\"\n  },\n  \"attachments\": [\n    {\n      \"id\": \"GA1234567890ABCD\"\n    }\n  ],\n  \"configs\": {\n    \"start\": \"GA1234567890ABCD\",\n    \"durationSeconds\": 10\n  }\n}",[915,919,938,941,947,953],{"key":312,"type":301,"required":6,"constraints":110,"description":316,"values":916,"array":917,"children":918},[38,48],false,[],{"key":319,"type":320,"required":6,"constraints":110,"description":323,"values":920,"array":917,"children":921},[],[922,926],{"key":923,"type":301,"required":6,"constraints":110,"description":334,"values":924,"array":917,"children":925},"type",[444,448,538,330,608,623],[],{"key":927,"type":301,"required":6,"constraints":110,"description":342,"values":928,"valuesBy":929,"array":917,"children":937},"model",[],{"key":923,"map":930},{"PDF":931,"MARKDOWN":932,"IMAGE":933,"VIDEO":934,"3D":935,"MUSIC":936},[481,484,487,490,493,496,499,502,505],[481,484,487,490,493,496,499,502,505],[543,546,549,552,555,558,561],[572,575,578,581,584,338,589,592,595,598,601],[613,616],[628],[],{"key":345,"type":301,"required":6,"constraints":347,"description":350,"values":939,"array":917,"children":940},[],[],{"key":353,"type":354,"required":6,"constraints":110,"description":357,"values":942,"array":917,"children":943},[],[944],{"key":300,"type":301,"required":6,"constraints":110,"description":366,"values":945,"array":917,"children":946},[],[],{"key":369,"type":370,"required":6,"constraints":371,"description":374,"values":948,"array":6,"children":949},[],[950],{"key":300,"type":301,"required":6,"constraints":110,"description":383,"values":951,"array":917,"children":952},[],[],{"key":42,"type":320,"required":917,"constraints":110,"description":388,"values":954,"array":917,"children":955},[],[],{"title":5,"description":904},"api-references\u002Ffile\u002Fupload-generate","Z3r8CrW_KnkbhXyjQhjy4W7T31bebeK4xljcept38LQ",1792305901597]