## Basic tool info

Model name: wiro/MotionFlow
Model description: Transform any character image into a moving video. Provide a reference image and select an video effect.
Model cover: https://cdn.wiro.ai/uploads/models/wiro-motionflow-cover.mp4
Model categories:
  - persistent
  - checkpoint-folder
  - wan2.2
  - image-to-video
  - videomagic
  - wiroEntertainment
  - tool
  - beautykit
  - wiro-app

Model tags:
  - video
  - image-to-video

Run Task Endpoint (POST):
https://api.wiro.ai/v1/Run/wiro/motionflow

Get Task Detail Endpoint (POST):
https://api.wiro.ai/v1/Task/Detail

## Model Inputs: 

  - name: inputImage
    label: Input Image
    help: Reference character image - the person to animate
    type: combinefileinput
    default: dancing_default_input_image.jpg

  - name: effectType
    label: Effect Type
    help: 
    type: selectwithcover
    default: dancing-mente-ma
    options:
      - value: "tiktokdance-supernova"
        label: Supernova
        cover: tiktokdance-supernova.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-meow"
        label: Meow
        cover: tiktokdance-meow.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-tiada-arti"
        label: Tiada Arti
        cover: tiktokdance-tiada-arti.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-yeah"
        label: Yeah
        cover: tiktokdance-yeah.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-data"
        label: Data
        cover: tiktokdance-data.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-ela-ke"
        label: Ela Ke
        cover: tiktokdance-ela-ke.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-mistake"
        label: Mistake
        cover: tiktokdance-mistake.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-mommae"
        label: Mommae
        cover: tiktokdance-mommae.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-pinky"
        label: Pinky
        cover: tiktokdance-pinky.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-six-seven"
        label: Six Seven
        cover: tiktokdance-six-seven.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-dai-dai"
        label: Dai Dai
        cover: tiktokdance-dai-dai.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-magica"
        label: Magica
        cover: tiktokdance-magica.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-let-me-be-mixed"
        label: Let Me Be Mixed
        cover: tiktokdance-let-me-be-mixed.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-goals"
        label: Goals
        cover: tiktokdance-goals.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-jump"
        label: Jump
        cover: tiktokdance-jump.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-catch-catch"
        label: Catch Catch
        cover: tiktokdance-catch-catch.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-let-me-be"
        label: Let Me Be
        cover: tiktokdance-let-me-be.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-copine"
        label: Copine
        cover: tiktokdance-copine.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-boompala"
        label: Boompala
        cover: tiktokdance-boompala.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-mente-ma"
        label: Mente Ma v2
        cover: tiktokdance-mente-ma.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-do-dru"
        label: Do Dru
        cover: tiktokdance-do-dru.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-apex"
        label: APEX
        cover: tiktokdance-apex.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-bloodline"
        label: Bloodline
        cover: tiktokdance-bloodline.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-no-batidao"
        label: No Batidao
        cover: tiktokdance-no-batidao.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-no-favelinha"
        label: No Favelinha
        cover: tiktokdance-no-favelinha.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-shake-it-to-the-max"
        label: Shake It To The Max
        cover: tiktokdance-shake-it-to-the-max.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "tiktokdance-you-know-nothing"
        label: You Know Nothing
        cover: tiktokdance-you-know-nothing.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "minidoll-mini-doll-chanel-dance"
        label: Mini Doll Chanel
        cover: minidoll-mini-doll-chanel-dance.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "dancing-bloodline"
        label: Bloodline
        cover: dancing-default-bloodline.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "dancing-chanel"
        label: Chanel
        cover: dancing-default-chanel.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "dancing-mente-ma"
        label: Mente Ma
        cover: dancing-default-mente-ma.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "dancing-milkshake-challange"
        label: Milkshake Challange
        cover: dancing-default-milkshake-challange.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "dancing-shake-that"
        label: Shake That
        cover: dancing-default-shake-that.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "dancing-solo-twist"
        label: Solo Twist
        cover: dancing-default-solo-twist.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image

      - value: "dancing-trend"
        label: Trend Dancing
        cover: dancing-default-dancing-trend.mp4
        inputImageCount: 1
        inputImageNote: You need to upload 1 person image



## 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/motionflow" 
-H "Content-Type: multipart/form-data" 
-H "x-api-key: ${YOUR_API_KEY}" 
-H "x-nonce: ${NONCE}" 
-H "x-signature: ${SIGNATURE}" 
-d '{
  "inputImage": "dancing_default_input_image.jpg",
  "effectType": "dancing-mente-ma",
  "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.