2026-06-17 11:11:37 +08:00
---
description : Mux a subtitle track into the video container.
---
2026-07-11 13:01:55 +08:00
# Embed Subtitles {#embed-subtitles}
2026-06-17 11:11:37 +08:00
Mux a subtitle file into the video container as a soft subtitle track that viewers can toggle on or off.
2026-07-11 13:01:55 +08:00
## API Endpoint {#api-endpoint}
2026-06-17 11:11:37 +08:00
2026-06-21 00:12:59 +08:00
`POST /api/v1/tools/video/embed-subtitles`
2026-06-17 11:11:37 +08:00
Accepts multipart form data with a video file and a subtitle file, plus a JSON `settings` field.
2026-07-11 13:01:55 +08:00
## Parameters {#parameters}
2026-06-17 11:11:37 +08:00
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| language | string | No | `"eng"` | ISO 639-2/B language code (3 lowercase letters, e.g. `"eng"` , `"fra"` , `"deu"` ) |
2026-07-11 13:01:55 +08:00
## Example Request {#example-request}
2026-06-17 11:11:37 +08:00
```bash
2026-06-21 00:12:59 +08:00
curl -X POST http://localhost:1349/api/v1/tools/video/embed-subtitles \
2026-06-17 11:11:37 +08:00
-H "Authorization: Bearer si_your-api-key" \
-F "file=@clip.mp4" \
-F "file=@subtitles.srt" \
-F 'settings={"language": "fra"}'
```
2026-07-11 13:01:55 +08:00
## Example Response {#example-response}
2026-06-17 11:11:37 +08:00
```json
{
"jobId" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ,
"downloadUrl" : "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/clip.mp4" ,
"originalSize" : 12500000 ,
"processedSize" : 12520000
}
```
2026-07-11 13:01:55 +08:00
## Notes {#notes}
2026-06-17 11:11:37 +08:00
- Upload two files: the first must be a video, the second must be a subtitle file (.srt, .vtt, or .ass).
- Embedded (soft) subtitles can be toggled by the viewer in their media player. For permanently visible subtitles, use the Burn Subtitles tool instead.
- The language code is stored as metadata in the container and helps media players label the subtitle track.