# pixverse/pixverse-v5-effects

> PixVerse V5 Effects converts images into smooth, natural short videos with lifelike motion; supports 5s/8s and 720p/1080p outputs. Ready-to-use REST API, no coldstarts, best performance, affordable pricing.

## Overview

- **Endpoint**: `https://api.wavespeed.ai/api/v3/pixverse/pixverse-v5-effects`
- **Polling/result URL**: `https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result`
- **Model ID**: `pixverse/pixverse-v5-effects`
- **Category**: video-effects

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
The API is asynchronous: submit a prediction, then poll its result URL until it completes.

### Input Schema

The API accepts the following input parameters:

- **`image`** (`string`, _required_):
  Supported image formats include.jpg/.jpeg/.png; The image file size cannot exceed 10MB, and the image resolution should not be less than 300*300px, and the aspect ratio of the image should be between 1:2.5 ~ 2.5:1.

- **`effect`** (`string`, _required_):
  Effect for video generation.
  - Default: `"Kiss"`
  - Options: "Baby Arrived", "Bald Swipe", "Bikini Up", "BOOM DROP", "Creepy Devil Smile", "Dishes Served", "Dragon Evoker", "Dust Me Away", "Earth Zoom Challenge", "Eye Zoom Challenge", "Fin-tastic Mermaid", "Ghostface Terror", "Holy Wings", "Hug Your Love", "Huge Cutie", "Kiss", "Kiss Me to Heaven", "Liquid Metal", "360° Microwave", "My Boyfriendsssss", "My Girlfriendssss", "Ocean ad", "Package Explosion", "Drunk Pole Dance", "Punch Face", "Sharksnap", "Skeletal Bae", "Summoning succubus", "Supermarket AD", "Thunder God", "Lionfish Venomous", "Warmth of Jesus", "Werewolf Rage", "Who's Arrested?", "Zombie Mode"

- **`resolution`** (`string`, _optional_):
  Video quality (360p/540p/720p/1080p).
  - Default: `"540p"`
  - Options: "360p", "540p", "720p", "1080p"

- **`duration`** (`integer`, _optional_):
  Video duration in seconds.
  - Default: `5`
  - Options: 5, 8

- **`sound_effect_switch`** (`boolean`, _optional_):
  Set to true if you want to enable this feature.
  - Default: `true`

- **`negative_prompt`** (`string`, _optional_):
  The negative prompt for the generation.



**Required Parameters Example**:

```json
{
  "image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
  "effect": "Kiss"
}
```

**Full Example**:

```json
{
  "image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
  "effect": "Kiss",
  "resolution": "540p",
  "duration": 5,
  "sound_effect_switch": true,
  "negative_prompt": "A cinematic ocean wave at sunrise, highly detailed"
}
```

### Result Data Schema

The `data` object returned by the API has the following fields:

- **`created_at`** (`string (date-time)`, _optional_):
  ISO timestamp of when the request was created (e.g., "2023-04-01T12:34:56.789Z").

- **`id`** (`string`, _optional_):
  Unique identifier for the prediction, the ID of the prediction to get.

- **`model`** (`string`, _optional_):
  Model ID used for the prediction.

- **`outputs`** (`array of string | object`, _optional_):
  Array of generated outputs (empty when status is not completed). Items are usually URL strings, but may be text strings or structured result objects, depending on the model.

- **`status`** (`string`, _optional_):
  Status of the task: created, processing, completed, or failed.

- **`urls`** (`object`, _optional_):
  Object containing related API endpoints.



**Example `data` Object**:

```json
{
  "created_at": "example",
  "id": "example",
  "model": "example",
  "outputs": [],
  "status": "example",
  "urls": {}
}
```

## Usage Examples

The examples use `jq` to read JSON. Set your API key first:

```bash
set -euo pipefail
export WAVESPEED_API_KEY="your-api-key"
```

### 1. Submit a prediction

```bash
REQUEST_BODY=$(cat <<'JSON'
{
  "image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
  "effect": "Kiss"
}
JSON
)

SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  --request POST \
  --url https://api.wavespeed.ai/api/v3/pixverse/pixverse-v5-effects \
  --header "Authorization: Bearer ${WAVESPEED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data "${REQUEST_BODY}")

printf '%s\n' "${SUBMIT_RESPONSE}" | jq .
```

The response contains the prediction ID in `data.id`.

### 2. Poll until complete and read `outputs`

```bash
PREDICTION_ID=$(printf '%s' "${SUBMIT_RESPONSE}" | jq -r '.data.id')
if [ -z "${PREDICTION_ID}" ] || [ "${PREDICTION_ID}" = "null" ]; then
  printf 'Submission response did not contain data.id\n' >&2
  exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"

while true; do
  RESPONSE=$(curl --silent --show-error --fail-with-body \
    --request GET \
    --url "${RESULT_URL}" \
    --header "Authorization: Bearer ${WAVESPEED_API_KEY}")

  RESULT=$(printf '%s' "${RESPONSE}" | jq -e '.data')
  STATUS=$(printf '%s' "${RESULT}" | jq -er '.status')
  case "${STATUS}" in
    completed)
      # Generated files are returned in the outputs array.
      printf '%s\n' "${RESULT}" | jq '.outputs'
      break
      ;;
    failed|cancelled|timeout|deleted)
      printf '%s\n' "${RESULT}" | jq '{status, error, code}'
      exit 1
      ;;
    *)
      sleep 2
      ;;
  esac
done
```

## Additional Resources

### Documentation

- [Model Playground](https://wavespeed.ai/models/pixverse/pixverse-v5-effects)
- [API Documentation](https://wavespeed.ai/docs/docs-api/pixverse/pixverse-pixverse-v5-effects)