# PixVerse Sound Effects API

> 任意のテキスト説明から、既存動画に生成音響効果と音楽を追加

`video_url`で指定した動画に音声を追加します。`prompt`で希望する音を記述し、空の場合はランダムな効果音が生成されます。`original_sound_switch`フラグで既存音声を保持するかを制御します。デフォルトではオフです。結果は動画として返されます。

- Model id: `pixverse/sound-effects`
- Made by: PixVerse
- Category: Video to Audio
- Output: video
- Price per 5 seconds of your input video: $0.10 / 5 seconds of input video (cheapest run $0.10 (100 API credits))
- Run: `POST https://api.doitong.com/v1/run/pixverse/sound-effects`
- Quote: `POST https://api.doitong.com/v1/quote/pixverse/sound-effects`
- Docs page: https://doitong.com/ja/developers/models/pixverse/sound-effects

## Pricing

Price: **$0.10 / 5 seconds of input video**. Price per 5 seconds of your input video: the input files are measured before the run (length, resolution, frame rate). The quote measures the same files and is exactly what the run charges.

The full example input below costs $0.20 = 200 API credits (2 × 5 s input video × $0.10).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). `POST https://api.doitong.com/v1/quote/pixverse/sound-effects` with the same JSON body returns the exact price for that input; the quote is exactly what a run charges. Invalid input is never charged and failed or canceled requests are refunded automatically.

## Input parameters

Send either the canonical name or the native field name (not both). Canonical names are the same across models.

| Parameter | Canonical name | Type | Required | Default | Allowed values / range | Description |
|---|---|---|---|---|---|---|
| `video_url` | `video` | string (video URL) | yes |  |  | 効果音を追加する入力動画URL。 |
| `original_sound_switch` |  | boolean | no | `false` |  | 動画の元の音声を保持するかどうかを制御します。 |
| `prompt` |  | string | no | `` |  | 空でない場合、ランダムな音声生成を置き換える効果音の指示。 |
| `enable_safety_checker` |  | boolean | no | `true` |  | 呼び出し元に権限がある場合、false に設定するとスクリーニングを緩和できます。 |

File parameters (`video`) take a public `https://` URL, a `data:` URI up to 10 MB, or the `file_url` of an upload from `POST /files`.

## Example input

Required parameters only:

```json
{
  "video": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
}
```

A fuller example:

```json
{
  "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
}
```

## Run it

Set `DOITONG_API_KEY` to a key from https://doitong.com/developers/dashboard#keys. `?wait=20` returns the finished request in the same call when it is ready within 20 seconds; otherwise poll `GET /requests/{id}` (it also accepts `?wait=`), or pass `webhook_url`.

### curl

```bash
# Run the model; wait up to 20 s for the finished result in the same call
curl -X POST "https://api.doitong.com/v1/run/pixverse/sound-effects?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
  }'

# Still "queued" or "running"? Poll with the id from the response:
curl "https://api.doitong.com/v1/requests/REQUEST_ID?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY"
```

### JavaScript

```javascript
const API = "https://api.doitong.com/v1";
const headers = {
  "Authorization": "Bearer " + process.env.DOITONG_API_KEY,
  "Content-Type": "application/json",
};

// Run the model; wait up to 20 s for the finished result in the same call
let res = await fetch(API + "/run/pixverse/sound-effects?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
  }),
});
let request = await res.json();
if (!res.ok) throw new Error(request.error.code + ": " + request.error.message);

// Not finished yet: long-poll until it is
while (request.status === "queued" || request.status === "running") {
  res = await fetch(API + "/requests/" + request.id + "?wait=20", { headers });
  request = await res.json();
}
if (request.status !== "succeeded") throw new Error(JSON.stringify(request.error));
console.log(request.outputs.map((o) => o.url), request.cost.credits + " API credits ($" + request.cost.usd + ")");
```

### Python

```python
import os
import requests

API = "https://api.doitong.com/v1"
headers = {"Authorization": "Bearer " + os.environ["DOITONG_API_KEY"]}

payload = {
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/pixverse/sound-effects", params={"wait": 20}, json=payload, headers=headers)
request = r.json()
if not r.ok:
    raise RuntimeError(request["error"]["code"] + ": " + request["error"]["message"])

# Not finished yet: long-poll until it is
while request["status"] in ("queued", "running"):
    request = requests.get(API + "/requests/" + request["id"], params={"wait": 20}, headers=headers).json()
if request["status"] != "succeeded":
    raise RuntimeError(request["error"])
print([o["url"] for o in request["outputs"]], request["cost"]["credits"], "API credits", "$" + request["cost"]["usd"])
```

### MCP

The MCP server at `https://api.doitong.com/v1/mcp` exposes the tools `search_models`, `get_model`, `quote`, `run`, `get_request`, `cancel_request`, `list_requests`, `create_upload` and `get_account`. A `run` call for this model:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "run",
    "arguments": {
      "model_id": "pixverse/sound-effects",
      "input": {
        "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
      },
      "wait_seconds": 20
    }
  }
}
```

## Response

Every call returns a request object. `status` is one of `queued`, `running`, `succeeded`, `failed`, `canceled`. `outputs` lists the generated files with URLs on our storage (kept forever, or 7 days with `?storage=temporary`; `storage` says which); `output` is the model's own result object with the same URLs.

```json
{
  "id": "req_8k2m4q7x1z9c3v5b6n0p2r4t",
  "object": "request",
  "model": "pixverse/sound-effects",
  "status": "succeeded",
  "created_at": "2026-10-20T12:00:00Z",
  "started_at": "2026-10-20T12:00:02Z",
  "completed_at": "2026-10-20T12:00:09Z",
  "queue_position": null,
  "cost": {
    "credits": 200,
    "usd": "0.20",
    "charged": 200,
    "refunded": 0
  },
  "input": {
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
  },
  "output": {
    "video": {
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_name": "0-output.mp4",
      "file_size": 1843200
    }
  },
  "outputs": [
    {
      "type": "video",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_size": 1843200,
      "width": 1280,
      "height": 720,
      "duration": 5,
      "stored": true
    }
  ],
  "error": null,
  "metrics": {
    "inference_seconds": 6.8
  },
  "urls": {
    "self": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `video` | object {url, content_type, file_name, file_size} | 追加された効果音を含む動画。 |

## Related models

- [PixVerse V4.5 Text To Video](https://doitong.com/developers/models/pixverse/v4.5/text-to-video.md) (`pixverse/v4.5/text-to-video`): from $0.15 / run
- [PixVerse V4.5 Text To Video Fast](https://doitong.com/developers/models/pixverse/v4.5/text-to-video/fast.md) (`pixverse/v4.5/text-to-video/fast`): from $0.30 / request
- [PixVerse V4.5 Effects](https://doitong.com/developers/models/pixverse/v4.5/effects.md) (`pixverse/v4.5/effects`): from $0.15 / run
- [PixVerse V4.5 Image To Video](https://doitong.com/developers/models/pixverse/v4.5/image-to-video.md) (`pixverse/v4.5/image-to-video`): from $0.15 / run
- [PixVerse V4.5 Image To Video Fast](https://doitong.com/developers/models/pixverse/v4.5/image-to-video/fast.md) (`pixverse/v4.5/image-to-video/fast`): from $0.30 / request
- [PixVerse V4.5 Transition](https://doitong.com/developers/models/pixverse/v4.5/transition.md) (`pixverse/v4.5/transition`): from $0.15 / run
- [PixVerse Extend](https://doitong.com/developers/models/pixverse/extend.md) (`pixverse/extend`): from $0.15 / run
- [PixVerse Extend Fast](https://doitong.com/developers/models/pixverse/extend/fast.md) (`pixverse/extend/fast`): from $0.30 / run

## Links

- HTML page: https://doitong.com/developers/models/pixverse/sound-effects
- All models and guides for AI agents: https://doitong.com/developers/llms.txt
- OpenAPI 3.1 with this model's typed request body: https://doitong.com/developers/openapi.json?model=pixverse/sound-effects
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/pixverse/sound-effects