## Basic tool info Model name: wiro/Animated Short Effect Model description: Turn a single portrait photo into a stylized 3D animated short film with cinematic comedy timing and family-film CG aesthetics. 17 scenarios. Model cover: https://cdn.wiro.ai/uploads/models/wiro-animated-short-effect-cover.mp4 Model categories: - tool - use-agent - wiroEntertainment - fast-inference - image-to-video - wiro-app - beautykit - partner - nogpu-pipeline Run Task Endpoint (POST): https://api.wiro.ai/v1/Run/wiro/animated-short-effect Get Task Detail Endpoint (POST): https://api.wiro.ai/v1/Task/Detail ## Model Inputs: - name: inputImage label: Input Image help: Required: see selected effect for image details type: combinefileinput default: ai-portrait-daily-asian-woman.webp - name: effectType label: Effect Type help: Required type: selectwithcover default: cg+short-pigeon+museum+heist+donut options: - value: "cg+short-pigeon+museum+heist+donut" label: Pigeon Museum Heist Donut Caper cover: seffect/cg%2Bshort-pigeon%2Bmuseum%2Bheist%2Bdonut.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-wifi+vs+smartphone+living+room" label: Router vs Smartphone Living-Room Brawl cover: seffect/cg%2Bshort-wifi%2Bvs%2Bsmartphone%2Bliving%2Broom.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "stopmotion+clay-matchbox+candle+love+tragedy" label: Matchbox Loves Candle Clay Tragedy cover: seffect/stopmotion%2Bclay-matchbox%2Bcandle%2Blove%2Btragedy.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-chameleon+panic+sneeze+macro" label: Chameleon Butterfly Panic Sneeze cover: seffect/cg%2Bshort-chameleon%2Bpanic%2Bsneeze%2Bmacro.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-cat+mouse+piano+keys+chase" label: Moonlit Cat and Mouse Piano Chase cover: seffect/cg%2Bshort-cat%2Bmouse%2Bpiano%2Bkeys%2Bchase.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-avocado+vs+toast+counter+debate" label: Avocado vs Toast Kitchen Counter Debate cover: seffect/cg%2Bshort-avocado%2Bvs%2Btoast%2Bcounter%2Bdebate.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-goat+man+victorian+tea+ceremony" label: Goat-Man Victorian Greenhouse Tea Ceremony cover: seffect/cg%2Bshort-goat%2Bman%2Bvictorian%2Btea%2Bceremony.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-courier+sliding+door+comedy+loop" label: Courier vs Sliding Door Comedy Loop cover: seffect/cg%2Bshort-courier%2Bsliding%2Bdoor%2Bcomedy%2Bloop.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-rubber+duck+bathtub+formula+splash" label: Rubber Duck Bathtub Formula Splash cover: seffect/cg%2Bshort-rubber%2Bduck%2Bbathtub%2Bformula%2Bsplash.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-bazaar+ice+cream+trickster+gag" label: Bazaar Ice-Cream Trickster Gag cover: seffect/cg%2Bshort-bazaar%2Bice%2Bcream%2Btrickster%2Bgag.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-cat+kung+fu+training+montage+trailer" label: Clumsy Cat Kung Fu Training Montage cover: seffect/cg%2Bshort-cat%2Bkung%2Bfu%2Btraining%2Bmontage%2Btrailer.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-mechanic+robot+zerog+repair+bay" label: Zero-G Mechanic vs Mischievous Repair Robot cover: seffect/cg%2Bshort-mechanic%2Brobot%2Bzerog%2Brepair%2Bbay.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-storybook+egyptian+crocodile+servant" label: Storybook Egyptian Bazaar Crocodile Servant cover: seffect/cg%2Bshort-storybook%2Begyptian%2Bcrocodile%2Bservant.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-talking+forest+rabbits" label: Forest Rabbits Found Footage cover: seffect/cg%2Bshort-talking%2Bforest%2Brabbits.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "artwork+timelapse-pencil+flower+field" label: Colored Pencil Flower Field Timelapse cover: seffect/artwork%2Btimelapse-pencil%2Bflower%2Bfield.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-tomb+cat+banknote+twist" label: Tomb Cat Banknote Reveal cover: seffect/cg%2Bshort-tomb%2Bcat%2Bbanknote%2Btwist.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - value: "cg+short-taekwondo+cat+rooftop+chase" label: Taekwondo Cat Rooftop Escape cover: seffect/cg%2Bshort-taekwondo%2Bcat%2Brooftop%2Bchase.mp4 inputImageCount: 1 inputImageNote: Upload 1 human portrait photo. - name: videoMode label: Video Mode help: Required. Default Standard type: select default: std options: - value: "std" label: Standard - value: "pro" label: Pro - name: ratio label: ratio help: Required. Default 9:16 type: select default: 9:16 options: - value: "9:16" label: 9:16 - value: "16:9" label: 16:9 - value: "1:1" label: 1:1 - name: duration label: Duration help: Required. Default 5s type: select default: 5 options: - value: "5" label: 5s - value: "10" label: 10s - value: "15" label: 15s ## Integration Header Prepare ```bash # Sign up Wiro dashboard and create project export YOUR_API_KEY="{{useSelectedProjectAPIKey}}"; export YOUR_API_SECRET="XXXXXXXXX"; # unix time or any random integer value export NONCE=$(date +%s); # hmac-SHA256 (YOUR_API_SECRET+Nonce) with YOUR_API_KEY export SIGNATURE="$(echo -n "${YOUR_API_SECRET}${NONCE}" | openssl dgst -sha256 -hmac "${YOUR_API_KEY}")"; ``` ## Run Command - Make HTTP Post Request ```bash curl -X POST "https://api.wiro.ai/v1/Run/wiro/animated-short-effect" -H "Content-Type: multipart/form-data" -H "x-api-key: ${YOUR_API_KEY}" -H "x-nonce: ${NONCE}" -H "x-signature: ${SIGNATURE}" -d '{ "inputImage": "ai-portrait-daily-asian-woman.webp", "effectType": "cg+short-pigeon+museum+heist+donut", "videoMode": "std", "ratio": "9:16", "duration": "5", "callbackUrl": "You can provide a callback URL; Wiro will send a POST request to it when the task is completed." }'; ``` ## Run Command - Response ```json { "errors": [], "taskid": "2221", "socketaccesstoken": "eDcCm5yyUfIvMFspTwww49OUfgXkQt", "result": true } ``` ## Get Task Detail - Make HTTP Post Request with Task ID ```bash curl -X POST "https://api.wiro.ai/v1/Task/Detail" -H "Content-Type: multipart/form-data" -H "x-api-key: ${YOUR_API_KEY}" -H "x-nonce: ${NONCE}" -H "x-signature: ${SIGNATURE}" -d '{ "taskid": "2221" }'; ``` ## Get Task Detail - Make HTTP Post Request with Socket Access Token ```bash curl -X POST "https://api.wiro.ai/v1/Task/Detail" -H "Content-Type: multipart/form-data" -H "x-api-key: ${YOUR_API_KEY}" -H "x-nonce: ${NONCE}" -H "x-signature: ${SIGNATURE}" -d '{ "tasktoken": "eDcCm5yyUfIvMFspTwww49OUfgXkQt" }'; ``` ## Get Task Detail - Response ```json { "total": "1", "errors": [], "tasklist": [ { "id": "2221", "uuid": "15bce51f-442f-4f44-a71d-13c6374a62bd", "socketaccesstoken": "eDcCm5yyUfIvMFspTwww49OUfgXkQt", "parameters": {}, "debugoutput": "", "debugerror": "", "starttime": "1734513809", "endtime": "1734513813", "elapsedseconds": "6.0000", "status": "task_postprocess_end", "createtime": "1734513807", "canceltime": "0", "assigntime": "1734513807", "accepttime": "1734513807", "preprocessstarttime": "1734513807", "preprocessendtime": "1734513807", "postprocessstarttime": "1734513813", "postprocessendtime": "1734513814", "outputs": [ { "id": "6bc392c93856dfce3a7d1b4261e15af3", "name": "0.png", "contenttype": "image/png", "parentid": "6c1833f39da71e6175bf292b18779baf", "uuid": "15bce51f-442f-4f44-a71d-13c6374a62bd", "size": "202472", "addedtime": "1734513812", "modifiedtime": "1734513812", "accesskey": "dFKlMApaSgMeHKsJyaDeKrefcHahUK", "url": "https://cdn1.wiro.ai/6a6af820-c5050aee-40bd7b83-a2e186c6-7f61f7da-3894e49c-fc0eeb66-9b500fe2/0.png" } ], "size": "202472" } ], "result": true } ``` ## Kill Task - Make HTTP Post Request with Task ID ```bash curl -X POST "https://api.wiro.ai/v1/Task/Kill" -H "Content-Type: multipart/form-data" -H "x-api-key: ${YOUR_API_KEY}" -H "x-nonce: ${NONCE}" -H "x-signature: ${SIGNATURE}" -d '{ "taskid": "534574" }'; ``` ## Kill Task - Make HTTP Post Request with Socket Access Token ```bash curl -X POST "https://api.wiro.ai/v1/Task/Kill" -H "Content-Type: multipart/form-data" -H "x-api-key: ${YOUR_API_KEY}" -H "x-nonce: ${NONCE}" -H "x-signature: ${SIGNATURE}" -d '{ "socketaccesstoken": "ZpYote30on42O4jjHXNiKmrWAZqbRE" }'; ``` ## Kill Task - Response ```json { "errors": [], "tasklist": [ { "id": "534574", "uuid": "15bce51f-442f-4f44-a71d-13c6374a62bd", "name": "", "socketaccesstoken": "ZpYote30on42O4jjHXNiKmrWAZqbRE", "parameters": { "inputImage": "https://api.wiro.ai/v1/File/mCmUXgZLG1FNjjjwmbtPFr2LVJA112/inputImage-6060136.png" }, "debugoutput": "", "debugerror": "", "starttime": "1734513809", "endtime": "1734513813", "elapsedseconds": "6.0000", "status": "task_cancel", "cps": "0.000585000000", "totalcost": "0.003510000000", "guestid": null, "projectid": "699", "modelid": "598", "description": "", "basemodelid": "0", "runtype": "model", "modelfolderid": "", "modelfileid": "", "callbackurl": "", "marketplaceid": null, "createtime": "1734513807", "canceltime": "0", "assigntime": "1734513807", "accepttime": "1734513807", "preprocessstarttime": "1734513807", "preprocessendtime": "1734513807", "postprocessstarttime": "1734513813", "postprocessendtime": "1734513814", "pexit": "0", "categories": "["tool","image-to-image","quick-showcase","compare-landscape"]", "outputs": [ { "id": "6bc392c93856dfce3a7d1b4261e15af3", "name": "0.png", "contenttype": "image/png", "parentid": "6c1833f39da71e6175bf292b18779baf", "uuid": "15bce51f-442f-4f44-a71d-13c6374a62bd", "size": "202472", "addedtime": "1734513812", "modifiedtime": "1734513812", "accesskey": "dFKlMApaSgMeHKsJyaDeKrefcHahUK", "foldercount": "0", "filecount": "0", "ispublic": 0, "expiretime": null, "url": "https://cdn1.wiro.ai/6a6af820-c5050aee-40bd7b83-a2e186c6-7f61f7da-3894e49c-fc0eeb66-9b500fe2/0.png" } ], "size": "202472" } ], "result": true } ``` ## Cancel Task - Make HTTP Post Request (For tasks on queue) ```bash curl -X POST "https://api.wiro.ai/v1/Task/Cancel" -H "Content-Type: multipart/form-data" -H "x-api-key: ${YOUR_API_KEY}" -H "x-nonce: ${NONCE}" -H "x-signature: ${SIGNATURE}" -d '{ "taskid": "634574" }'; ``` ## Cancel Task - Response ```json { "errors": [], "tasklist": [ { "id": "634574", "uuid": "15bce51f-442f-4f44-a71d-13c6374a62bd", "name": "", "socketaccesstoken": "ZpYote30on42O4jjHXNiKmrWAZqbRE", "parameters": { "inputImage": "https://api.wiro.ai/v1/File/mCmUXgZLG1FNjjjwmbtPFr2LVJA112/inputImage-6060136.png" }, "debugoutput": "", "debugerror": "", "starttime": "1734513809", "endtime": "1734513813", "elapsedseconds": "6.0000", "status": "task_cancel", "cps": "0.000585000000", "totalcost": "0.003510000000", "guestid": null, "projectid": "699", "modelid": "598", "description": "", "basemodelid": "0", "runtype": "model", "modelfolderid": "", "modelfileid": "", "callbackurl": "", "marketplaceid": null, "createtime": "1734513807", "canceltime": "0", "assigntime": "1734513807", "accepttime": "1734513807", "preprocessstarttime": "1734513807", "preprocessendtime": "1734513807", "postprocessstarttime": "1734513813", "postprocessendtime": "1734513814", "pexit": "0", "categories": "["tool","image-to-image","quick-showcase","compare-landscape"]", "outputs": [ { "id": "6bc392c93856dfce3a7d1b4261e15af3", "name": "0.png", "contenttype": "image/png", "parentid": "6c1833f39da71e6175bf292b18779baf", "uuid": "15bce51f-442f-4f44-a71d-13c6374a62bd", "size": "202472", "addedtime": "1734513812", "modifiedtime": "1734513812", "accesskey": "dFKlMApaSgMeHKsJyaDeKrefcHahUK", "foldercount": "0", "filecount": "0", "ispublic": 0, "expiretime": null, "url": "https://cdn1.wiro.ai/6a6af820-c5050aee-40bd7b83-a2e186c6-7f61f7da-3894e49c-fc0eeb66-9b500fe2/0.png" } ], "size": "202472" } ], "result": true } ``` ## Task Status Information This section defines the possible task status values returned by the API when polling for task completion. ### Completed Task Statuses (Polling can stop) These indicate that the task has reached a terminal state — either success or failure. Once any of these is received, polling should stop. - task_postprocess_end : Task completed successfully and post-processing is done. - task_cancel : Task was cancelled by the user or system. ### Running Task Statuses (Continue polling) These statuses indicate that the task is still in progress. Polling should continue if one of these is returned. - task_queue : Task is waiting in the queue. - task_accept : Task has been accepted for processing. - task_assign : Task is being assigned to a worker. - task_preprocess_start : Preprocessing is starting. - task_preprocess_end : Preprocessing is complete. - task_start : Task execution has started. - task_output : Output is being generated.