# wavespeed-ai/video-merger

> Video Merger joins 2 to 20 video clips into one video with crossfades or straight cuts and optional background music, fitting every clip into the first clip's frame. Ready-to-use REST inference API, no coldstarts, affordable pricing.

## Overview

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

## Pricing

Billing is per second of the clips' total length (each started second counts), with a minimum of 3 seconds and a maximum of 600 seconds.

| Clips | Price |
|-------|-------|
| 2 clips of 5 seconds (10 seconds) | $0.002 |
| 3 clips of 10 seconds (30 seconds) | $0.006 |
| 4 clips of 15 seconds (60 seconds) | $0.012 |
| 10 clips of 30 seconds (300 seconds) | $0.06 |
| 20 clips of 30 seconds (600 seconds, the maximum billed length) | $0.12 |

---

## 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:

- **`videos`** (`array of string`, _required_):
  The clips to join, in playing order: 2 to 20 videos. The merged video is at most 600 seconds; clips that would start later are left out and the last one is cut. Clips of another shape are fitted into the first clip's frame with black bars, never stretched.

- **`transition`** (`string`, _optional_):
  fade crossfades picture and sound between clips; none cuts straight from one clip to the next.
  - Default: `"fade"`
  - Options: "fade", "none"

- **`transition_duration`** (`number`, _optional_):
  Length of each crossfade in seconds (used with transition fade).
  - Default: `0.5`
  - Range: `0.1` to `2`

- **`audio`** (`string`, _optional_):
  Optional background music, looped or cut to the length of the merged video and faded out at the end.

- **`audio_volume`** (`number`, _optional_):
  Volume of the background music, from 0 (silent) to 1 (as recorded).
  - Default: `0.3`
  - Range: `0` to `1`

- **`keep_original_audio`** (`boolean`, _optional_):
  Keep the clips' own sound. Turn off to use only the background music, or to get a silent video.
  - Default: `true`



**Required Parameters Example**:

```json
{
  "videos": [
    "https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4",
    "https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4"
  ]
}
```

**Full Example**:

```json
{
  "videos": [
    "https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4",
    "https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4"
  ],
  "transition": "fade",
  "transition_duration": 0.5,
  "audio": "https://interactive-examples.mdn.mozilla.net/media/cc0-audio/t-rex-roar.mp3",
  "audio_volume": 0.3,
  "keep_original_audio": true
}
```

### 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'
{
  "videos": [
    "https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4",
    "https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4"
  ]
}
JSON
)

SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  --request POST \
  --url https://api.wavespeed.ai/api/v3/wavespeed-ai/video-merger \
  --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/wavespeed-ai/video-merger)
- [API Documentation](https://wavespeed.ai/docs/docs-api/wavespeed-ai/video-merger)
