vod_add_subtitles
Burn subtitle cues or an SRT/VTT/ASS file into a video with MediaKit.
Returns a task_id; poll it with vod_get_task (operation ‘add_subtitles’). Not retried automatically; reuse client_token to reconcile a timeout. Requires background execution (ark_job_submit).
| Requirement | Value |
|---|---|
| Registration | Requires BYTEPLUS_VOD_MEDIAKIT_API_KEY. |
| Execution | Background required |
| Required permission | vod:subtitle:add |
This site lists the full configured capability surface, not the tools enabled on your particular server. Use model discovery and job discovery to check your connection. Credentials are server configuration, never tool arguments.
Ask your connected AI client to use vod_add_subtitles for the operation you want.
The client constructs the arguments and handles tool calls. Review its proposed
operation before approving anything billable. For a non-billable introduction,
start with discovery without generation.
Submit through ark_job_submit with tool_name and the complete target arguments, including its inner input object. Poll ark_job_get using the returned Ark job_id, respecting poll_after_ms. Inspect both terminal status and result.is_error; the original output is in result.structured_content. Do not call this tool in the foreground.
Match the input fields below and the full JSON Schema. See the worked examples for this capability and Background Execution for job/result handling.
An Ark job ID is not a provider task ID. Video and 3D tasks use gen_task_get, VOD tasks use vod_get_task, and avatars use omnihuman_get_task. Save accepted provider task IDs and resume polling instead of submitting a second generation.
Inputs
Section titled “Inputs”The MCP arguments object wraps these fields as {"input": {...}}.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
callback_args |
string or null | No | Callback payload echoed by MediaKit; max 512 UTF-8 bytes.; Default: null |
callback_url |
string or null | No | Public HTTPS task callback URL; overrides the console callback.; Default: null |
client_token |
string or null | No | Idempotency token (1-64 printable ASCII chars); reuse it to reconcile a timed-out submission.; Default: null |
project |
string or null | No | Legacy MediaKit project label (case-sensitive); omit for the API key’s project.; Default: null |
queue_id |
string or null | No | MediaKit queue ID; omit for the project’s default queue.; Default: null |
subtitle_font_color |
string | No | Subtitle color and opacity as #RRGGBBAA (default opaque white).; pattern: ”^#[0-9A-Fa-f]{8}$”; Default: “#FFFFFFFF” |
subtitle_font_size |
integer | No | Subtitle font size in pixels.; exclusiveMinimum: 0; Default: 50 |
subtitle_font_type |
“inter”, “montserrat”, “oppo_sans”, “roboto”, “source_han_serif”, “sy_black”, “pm_zhengdao”, “zhanku_kuaile” | No | MediaKit font identifier.; Default: “inter” |
subtitle_pos_preset |
“bottom_center”, “top_center”, “center”, “lower_third” | No | Subtitle position preset.; Default: “bottom_center” |
subtitle_url |
string or null | No | Public HTTPS SRT, VTT, or ASS file URL. One of subtitle_url or subtitles is required; wins if both are set.; Default: null |
subtitles |
array of VodMediaKitSubtitleCue or null | No | Inline subtitle cues. One of subtitle_url or subtitles is required.; Default: null |
video_url |
string | Yes | Public HTTPS video URL; private and link-local hosts are rejected.; minLength: 1; format: “uri” |
Outputs
Section titled “Outputs”| Field | Type | Required | Description and constraints |
|---|---|---|---|
operation |
“enhance”, “transcode”, “separate_audio”, “add_subtitles”, “remove_subtitles” | No | Operation name; pass it to vod_get_task with task_id.; Default: “add_subtitles” |
provider |
“byteplus-vod-mediakit” | No | Provider surface.; Default: “byteplus-vod-mediakit” |
provider_log_id |
string or null | No | Provider x-tt-logid, when returned.; Default: null |
recommended_poll_after_ms |
integer | Yes | Suggested delay before the first vod_get_task poll, in milliseconds. |
request_id |
string or null | No | Provider request ID, when returned.; Default: null |
status |
“accepted” | Yes | Always accepted; the task is asynchronous. |
task_id |
string | Yes | Task ID to poll with vod_get_task (operation ‘add_subtitles’). |
Nested Types
Section titled “Nested Types”Field types named above refer to these shared definitions. Optional/null fields, enum choices and bounds are retained in the complete schemas below. Schema validation is followed by runtime capability and security checks.
VodAddSubtitlesInput
| Field | Type | Required | Description and constraints |
|---|---|---|---|
callback_args |
string or null | No | Callback payload echoed by MediaKit; max 512 UTF-8 bytes.; Default: null |
callback_url |
string or null | No | Public HTTPS task callback URL; overrides the console callback.; Default: null |
client_token |
string or null | No | Idempotency token (1-64 printable ASCII chars); reuse it to reconcile a timed-out submission.; Default: null |
project |
string or null | No | Legacy MediaKit project label (case-sensitive); omit for the API key’s project.; Default: null |
queue_id |
string or null | No | MediaKit queue ID; omit for the project’s default queue.; Default: null |
subtitle_font_color |
string | No | Subtitle color and opacity as #RRGGBBAA (default opaque white).; pattern: ”^#[0-9A-Fa-f]{8}$”; Default: “#FFFFFFFF” |
subtitle_font_size |
integer | No | Subtitle font size in pixels.; exclusiveMinimum: 0; Default: 50 |
subtitle_font_type |
“inter”, “montserrat”, “oppo_sans”, “roboto”, “source_han_serif”, “sy_black”, “pm_zhengdao”, “zhanku_kuaile” | No | MediaKit font identifier.; Default: “inter” |
subtitle_pos_preset |
“bottom_center”, “top_center”, “center”, “lower_third” | No | Subtitle position preset.; Default: “bottom_center” |
subtitle_url |
string or null | No | Public HTTPS SRT, VTT, or ASS file URL. One of subtitle_url or subtitles is required; wins if both are set.; Default: null |
subtitles |
array of VodMediaKitSubtitleCue or null | No | Inline subtitle cues. One of subtitle_url or subtitles is required.; Default: null |
video_url |
string | Yes | Public HTTPS video URL; private and link-local hosts are rejected.; minLength: 1; format: “uri” |
VodMediaKitSubtitleCue
| Field | Type | Required | Description and constraints |
|---|---|---|---|
end_time |
number | Yes | Cue end time in seconds from the beginning of the video.; exclusiveMinimum: 0 |
start_time |
number | Yes | Cue start time in seconds from the beginning of the video.; minimum: 0 |
subtitle_text |
string | Yes | Subtitle text shown for this cue.; minLength: 1 |
Complete JSON Schemas
Section titled “Complete JSON Schemas”Input schema, including the MCP wrapper
{ "$defs": { "VodAddSubtitlesInput": { "description": "Input for a subtitle burn-in task.", "properties": { "callback_args": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Callback payload echoed by MediaKit; max 512 UTF-8 bytes." }, "callback_url": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "description": "Public HTTPS task callback URL; overrides the console callback." }, "client_token": { "anyOf": [ { "pattern": "^[\\x20-\\x7E]{1,64}$", "type": "string" }, { "type": "null" } ], "default": null, "description": "Idempotency token (1-64 printable ASCII chars); reuse it to reconcile a timed-out submission." }, "project": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "description": "Legacy MediaKit project label (case-sensitive); omit for the API key's project." }, "queue_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "description": "MediaKit queue ID; omit for the project's default queue." }, "subtitle_font_color": { "default": "#FFFFFFFF", "description": "Subtitle color and opacity as #RRGGBBAA (default opaque white).", "pattern": "^#[0-9A-Fa-f]{8}$", "type": "string" }, "subtitle_font_size": { "default": 50, "description": "Subtitle font size in pixels.", "exclusiveMinimum": 0, "type": "integer" }, "subtitle_font_type": { "default": "inter", "description": "MediaKit font identifier.", "enum": [ "inter", "montserrat", "oppo_sans", "roboto", "source_han_serif", "sy_black", "pm_zhengdao", "zhanku_kuaile" ], "type": "string" }, "subtitle_pos_preset": { "default": "bottom_center", "description": "Subtitle position preset.", "enum": [ "bottom_center", "top_center", "center", "lower_third" ], "type": "string" }, "subtitle_url": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "description": "Public HTTPS SRT, VTT, or ASS file URL. One of subtitle_url or subtitles is required; wins if both are set." }, "subtitles": { "anyOf": [ { "items": { "$ref": "#/$defs/VodMediaKitSubtitleCue" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Inline subtitle cues. One of subtitle_url or subtitles is required." }, "video_url": { "description": "Public HTTPS video URL; private and link-local hosts are rejected.", "format": "uri", "minLength": 1, "type": "string" } }, "required": [ "video_url" ], "type": "object" }, "VodMediaKitSubtitleCue": { "additionalProperties": false, "description": "One inline subtitle cue for the MediaKit burn-in endpoint.", "properties": { "end_time": { "description": "Cue end time in seconds from the beginning of the video.", "exclusiveMinimum": 0, "type": "number" }, "start_time": { "description": "Cue start time in seconds from the beginning of the video.", "minimum": 0, "type": "number" }, "subtitle_text": { "description": "Subtitle text shown for this cue.", "minLength": 1, "type": "string" } }, "required": [ "subtitle_text", "start_time", "end_time" ], "type": "object" } }, "additionalProperties": false, "properties": { "input": { "$ref": "#/$defs/VodAddSubtitlesInput" } }, "required": [ "input" ], "type": "object"}Output schema, including nested definitions
{ "description": "Accepted asynchronous subtitle burn-in submission.", "properties": { "operation": { "default": "add_subtitles", "description": "Operation name; pass it to vod_get_task with task_id.", "enum": [ "enhance", "transcode", "separate_audio", "add_subtitles", "remove_subtitles" ], "title": "Operation", "type": "string" }, "provider": { "const": "byteplus-vod-mediakit", "default": "byteplus-vod-mediakit", "description": "Provider surface.", "title": "Provider", "type": "string" }, "provider_log_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Provider x-tt-logid, when returned.", "title": "Provider Log Id" }, "recommended_poll_after_ms": { "description": "Suggested delay before the first vod_get_task poll, in milliseconds.", "title": "Recommended Poll After Ms", "type": "integer" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Provider request ID, when returned.", "title": "Request Id" }, "status": { "const": "accepted", "description": "Always accepted; the task is asynchronous.", "title": "Status", "type": "string" }, "task_id": { "description": "Task ID to poll with vod_get_task (operation 'add_subtitles').", "title": "Task Id", "type": "string" } }, "required": [ "status", "task_id", "recommended_poll_after_ms" ], "title": "VodAddSubtitlesOutput", "type": "object"}Troubleshooting
Section titled “Troubleshooting”- Missing tool: check provider credentials and feature flags, then restart the connection.
- Invalid arguments: keep the correct wrapper and follow current model limits from discovery. A valid schema alone does not prove the chosen model supports the combination.
- A job completes with an error: inspect the original tool result, not only the outer job status. Never automatically resubmit potentially billable work.
- Local output writes from jobs require server-configured
OUTPUT_ROOTS; HTTP cannot write to a client’s local disk.
See configuration, background execution, and artifact delivery.