## Basic model info

- Model name: bytedance/bytedance voice-separation
- Model description: Separate any audio or video into two clean stems - isolated vocals and full background accompaniment - powered by Volcengine AI MediaKit.
- Endpoint name: audio-separation


## Model schema

The model schema is defined in the OpenAPI schema: [OpenAPI Schema](https://oapi.sunra.ai/main/bytedance/voice-separation/latest.json)

### Model input schema

The model input schema is:



```json
{
  "description": "Input schema for Volcengine AI MediaKit voice / background separation.",
  "properties": {
    "media": {
      "anyOf": [
        {
          "format": "uri",
          "maxLength": 2083,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "Audio or video file URL. Video: mp4, flv, ts, avi, mov, wmv, mkv. Audio: mp3, m4a, wav.",
      "title": "Media",
      "x-sr-order": 301
    },
    "output_format": {
      "default": "aac",
      "description": "Output format of the separated audio tracks.",
      "enum": [
        "aac",
        "mp3",
        "wav",
        "m4a",
        "flac"
      ],
      "title": "Output Format",
      "type": "string",
      "x-sr-order": 401
    }
  },
  "required": [
    "media"
  ],
  "title": "AudioSeparationInput",
  "type": "object"
}
```



### Model output schema

The model output schema is:



```json
{
  "description": "Output schema for voice / background separation results.",
  "properties": {
    "background_audio": {
      "description": "The background / accompaniment track",
      "properties": {
        "content_type": {
          "description": "The mime type of the file.",
          "title": "Content Type",
          "type": "string"
        },
        "file_name": {
          "description": "The name of the file. It will be auto-generated if not provided.",
          "title": "File Name",
          "type": "string"
        },
        "file_size": {
          "description": "The size of the file in bytes.",
          "title": "File Size",
          "type": "integer"
        },
        "url": {
          "description": "The URL where the file can be downloaded from.",
          "title": "Url",
          "type": "string"
        }
      },
      "required": [
        "content_type",
        "file_name",
        "file_size",
        "url"
      ],
      "title": "SunraFile",
      "type": "object"
    },
    "input_audio_duration": {
      "description": "The duration of the input media in seconds",
      "title": "Input Audio Duration",
      "type": "integer"
    },
    "voice_audio": {
      "description": "The isolated vocal track",
      "properties": {
        "content_type": {
          "description": "The mime type of the file.",
          "title": "Content Type",
          "type": "string"
        },
        "file_name": {
          "description": "The name of the file. It will be auto-generated if not provided.",
          "title": "File Name",
          "type": "string"
        },
        "file_size": {
          "description": "The size of the file in bytes.",
          "title": "File Size",
          "type": "integer"
        },
        "url": {
          "description": "The URL where the file can be downloaded from.",
          "title": "Url",
          "type": "string"
        }
      },
      "required": [
        "content_type",
        "file_name",
        "file_size",
        "url"
      ],
      "title": "SunraFile",
      "type": "object"
    }
  },
  "required": [
    "voice_audio",
    "background_audio",
    "input_audio_duration"
  ],
  "title": "VoiceSeparationOutput",
  "type": "object"
}
```



## Example inputs and outputs

Use the following example inputs and outputs to understand the model.

### Input example



```json
{
  "media": "",
  "output_format": "aac"
}
```



### Output example



```json
{
}
```



## Model code examples

### JavaScript



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

const result = await sunra.subscribe("bytedance/voice-separation/audio-separation", {
  input: {
  	media: '',
  	output_format: 'aac'
  },
  logs: true,
  onQueueUpdate: (update) => {
    console.log(`Status Update: ${update.status}, Request ID: ${update.request_id}`);
  },
});
console.log(result.data);
console.log(result.requestId);
```



### Python



```python
import sunra_client

result = sunra_client.subscribe(
    "bytedance/voice-separation/audio-separation",
    arguments={
        "media": "",
        "output_format": "aac"
    },

    with_logs=True,
    on_enqueue=print,
    on_queue_update=print,
)
print(result)
```



### Java



```java
import ai.sunra.client.*;
import java.util.Map;
import com.google.gson.JsonObject;

var client = SunraClient.withEnvCredentials();

var response = client.subscribe(
    "bytedance/voice-separation/audio-separation",
    SubscribeOptions.<JsonObject>builder()
        .input(Map.of(
            "media", "",
            "output_format", "aac"))

        .resultType(JsonObject.class)
        .onQueueUpdate(update -> System.out.printf(
            "\nStatus Update: %s, Request ID: %s%n",
            update.getStatus(),
            update.getRequestId()
        ))
        .logs(true)
        .build()
);

System.out.println("Completed!");
System.out.println(response.getData());
  
```



### Kotlin



```kotlin
import ai.sunra.client.kt.*
import com.google.gson.JsonObject

val client = createSunraClient()

val response = client.subscribe<JsonObject>(
    endpointId = "bytedance/voice-separation/audio-separation",
    input = mapOf(
            "media" to "",
            "output_format" to "aac"),
    options = ai.sunra.client.kt.SubscribeOptions(logs = true),
    onUpdate = { update ->
        println("\nStatus Update: ${update.status}, Request ID: ${update.requestId}")
    }
)

println("Completed!")
println(response.data)
  
```



### Curl



```bash

curl --request POST \
  --url https://api.sunra.ai/v1/queue/bytedance/voice-separation/audio-separation \
  --header "Authorization: Key $SUNRA_KEY" \
  --header "Content-Type: application/json" \
  --data '{"media":"","output_format":"aac"}'
    
```



## Model readme

undefined