# Spleeter

> Split a song into an instrumental backing track and an isolated vocal in a single call, charged as one flat price per track instead of per minute of audio.

## Overview

- **Endpoint**: `https://queue.modelrunner.run/deezer/spleeter`
- **Model ID**: `deezer/spleeter`
- **Category**: audio-to-audio
- **Kind**: inference
- **Tags**: spleeter, deezer, 2-stems, stem-separation, source-separation, audio-separation, vocal-remover, vocal-isolation, instrumental, backing-track, acapella, karaoke, audio-to-audio, music

## Pricing

- **Price**: $0.0025 per output

## Request Lifecycle

This model runs on the ModelRunner **asynchronous queue API** — a single POST does not return the output. Every call requires an `Authorization: Key $MODEL_RUNNER_KEY` header. Run three steps:

1. **Submit** — `POST https://queue.modelrunner.run/deezer/spleeter` with a JSON body holding the input fields at the top level. The body may also include a reserved top-level `metadata` object — a flat string map (max 16 keys, key ≤64 / value ≤512 chars) stored on the request for your own tagging. It is never sent to the model; filter your request history with `GET https://queue.modelrunner.run/requests?metadata=<url-encoded JSON>` (exact key=value matches, AND-ed). The response carries request handles only (no output yet):

```json
{
  "status": "IN_QUEUE",
  "request_id": "<21-char id>",
  "status_url": "https://queue.modelrunner.run/deezer/spleeter/requests/<request_id>/status",
  "response_url": "https://queue.modelrunner.run/deezer/spleeter/requests/<request_id>",
  "cancel_url": "https://queue.modelrunner.run/deezer/spleeter/requests/<request_id>/cancel"
}
```

2. **Poll status** — `GET <status_url>` until `status` is `COMPLETED`. Possible values are `IN_QUEUE`, `IN_PROGRESS`, `COMPLETED`, `FAILED`, `CANCELLED`. A `FAILED` request responds with HTTP 400 and an `error` field.

3. **Read result** — `GET <response_url>`. Returns the finished request, including the generated `output`:

```json
{ "id": "<request_id>", "status": "COMPLETED", "output": ..., "input": ... }
```

The JavaScript and Python SDKs below perform steps 2–3 for you. In any language without an SDK (Swift, Go, Kotlin, etc.) you must implement the polling loop and the final result fetch yourself — see the cURL example for the full flow.

### Input Schema

- **`audio`** (`string`, _required_):
  URL of the track to split. Built for a full-band music mix with the lead vocal present - a solo vocal, or a track that is already instrumental, has nothing to separate. WAV and MP3 sources both decode. Keep it to a single song: runs up to 3.5 minutes are verified and about five minutes is the practical ceiling. An over-long file FAILS the whole request - sometimes with no error message at all - rather than returning a shortened result; a failed request is not charged.

### Output Schema

_No `Output` schema properties are available._

## Default Example

**Input**

```json
{
  "audio": "https://media.modelrunner.ai/4aDfffFe0jPK0ANuVnrOQ.wav"
}
```

**Output**

```json
[
  "https://media.modelrunner.ai/CTF9WTc4icD33Ew0CtZx7.wav",
  "https://media.modelrunner.ai/EITKcuFuDZCEA2a1gyZAB.wav"
]
```
## Usage Examples

### cURL

The queue API is asynchronous: submit the request, poll `status_url` until it is `COMPLETED`, then read the result from `response_url`. Requires `jq`.

```bash
# 1. Submit the request (returns request handles, not the output)
SUBMIT=$(curl --silent --request POST \
  --url https://queue.modelrunner.run/deezer/spleeter \
  --header "Authorization: Key $MODEL_RUNNER_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "audio": "https://media.modelrunner.ai/4aDfffFe0jPK0ANuVnrOQ.wav"
}')

STATUS_URL=$(echo "$SUBMIT" | jq -r '.status_url')
RESPONSE_URL=$(echo "$SUBMIT" | jq -r '.response_url')

# 2. Poll until the request leaves the queue / in-progress state
while true; do
  STATUS=$(curl --silent --url "$STATUS_URL" \
    --header "Authorization: Key $MODEL_RUNNER_KEY" | jq -r '.status')
  echo "Status: $STATUS"
  case "$STATUS" in
    COMPLETED) break ;;
    FAILED|CANCELLED) echo "Request $STATUS"; exit 1 ;;
  esac
  sleep 1
done

# 3. Read the finished request, including the generated output
curl --silent --url "$RESPONSE_URL" \
  --header "Authorization: Key $MODEL_RUNNER_KEY"
```

### JavaScript

```javascript
import { modelrunner } from "@modelrunner/client";

const result = await modelrunner.subscribe("deezer/spleeter", {
  input: {
  "audio": "https://media.modelrunner.ai/4aDfffFe0jPK0ANuVnrOQ.wav"
}
});

console.log(result.data);
```

### Python

```python
import asyncio
import modelrunner_ai

async def main():
    response = await modelrunner_ai.submit_async(
        "deezer/spleeter",
        arguments={
  "audio": "https://media.modelrunner.ai/4aDfffFe0jPK0ANuVnrOQ.wav"
}
    )
    result = await response.get()
    print(result["output"])

asyncio.run(main())
```

## Additional Resources

- [Playground](https://modelrunner.ai/models/deezer/spleeter)
- [OpenAPI Schema](https://modelrunner.ai/models/deezer/spleeter/openapi.json)
- [LLM Instructions](https://modelrunner.ai/models/deezer/spleeter/llms.txt)
- [GitHub](https://github.com/deezer/spleeter)
- [License](https://github.com/deezer/spleeter/blob/master/LICENSE)
- [Paper](https://joss.theoj.org/papers/10.21105/joss.02154)