vod_remove_subtitles
Remove hardcoded subtitles or on-screen text from a video with MediaKit.
Mode ‘text’ also erases titles, labels, and watermarks. Returns a task_id; poll it with vod_get_task (operation ‘remove_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:remove |
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_remove_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 |
erase_ratio_location |
array of VodMediaKitEraseLocation or null | No | Normalized rectangular regions (1-20) limiting where text is erased.; Default: null |
mode |
“subtitle”, “text” | No | subtitle: erase recognized dialogue subtitles. text: erase all recognized on-screen text, including titles, labels, and watermarks.; Default: “subtitle” |
model_version |
“v4”, “v5” or null | No | Legacy precision-erasure model version.; Default: null |
output_encode_mode |
“quality”, “size” | No | quality: higher bitrate. size: stay near the source bitrate.; Default: “quality” |
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_filter |
VodMediaKitSubtitleFilter or null | No | OCR size and centering thresholds; subtitle mode only.; Default: null |
time_segment_filter |
VodMediaKitTimeSegmentFilter or null | No | Time segments to erase or skip.; Default: null |
video_url |
string | Yes | Public HTTPS source-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: “remove_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 ‘remove_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.
VodMediaKitEraseLocation
| Field | Type | Required | Description and constraints |
|---|---|---|---|
bottom_right_x |
number | Yes | Right edge as a frame-width ratio; greater than top_left_x.; minimum: 0; maximum: 1 |
bottom_right_y |
number | Yes | Bottom edge as a frame-height ratio; greater than top_left_y.; minimum: 0; maximum: 1 |
top_left_x |
number | Yes | Left edge as a frame-width ratio.; minimum: 0; maximum: 1 |
top_left_y |
number | Yes | Top edge as a frame-height ratio.; minimum: 0; maximum: 1 |
VodMediaKitSubtitleFilter
| Field | Type | Required | Description and constraints |
|---|---|---|---|
center_offset_ratio |
number or null | No | Maximum horizontal center offset ratio treated as a subtitle.; Default: null |
max_text_height_ratio |
number or null | No | Maximum OCR text-height ratio treated as a subtitle.; Default: null |
min_text_height_ratio |
number or null | No | Minimum OCR text-height ratio treated as a subtitle.; Default: null |
VodMediaKitTimeSegment
| Field | Type | Required | Description and constraints |
|---|---|---|---|
end_time |
number | Yes | Segment end time in seconds; greater than start_time.; exclusiveMinimum: 0 |
start_time |
number | Yes | Segment start time in seconds.; minimum: 0 |
VodMediaKitTimeSegmentFilter
| Field | Type | Required | Description and constraints |
|---|---|---|---|
mode |
“selected”, “skip” | Yes | selected erases only listed segments; skip erases outside them. |
segments |
array of VodMediaKitTimeSegment | Yes | Non-empty list of time segments.; minItems: 1 |
VodRemoveSubtitlesInput
| 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 |
erase_ratio_location |
array of VodMediaKitEraseLocation or null | No | Normalized rectangular regions (1-20) limiting where text is erased.; Default: null |
mode |
“subtitle”, “text” | No | subtitle: erase recognized dialogue subtitles. text: erase all recognized on-screen text, including titles, labels, and watermarks.; Default: “subtitle” |
model_version |
“v4”, “v5” or null | No | Legacy precision-erasure model version.; Default: null |
output_encode_mode |
“quality”, “size” | No | quality: higher bitrate. size: stay near the source bitrate.; Default: “quality” |
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_filter |
VodMediaKitSubtitleFilter or null | No | OCR size and centering thresholds; subtitle mode only.; Default: null |
time_segment_filter |
VodMediaKitTimeSegmentFilter or null | No | Time segments to erase or skip.; Default: null |
video_url |
string | Yes | Public HTTPS source-video URL; private and link-local hosts are rejected.; minLength: 1; format: “uri” |
Complete JSON Schemas
Section titled “Complete JSON Schemas”Input schema, including the MCP wrapper
{ "$defs": { "VodMediaKitEraseLocation": { "additionalProperties": false, "description": "Normalized rectangular erasure area within a video frame.", "properties": { "bottom_right_x": { "description": "Right edge as a frame-width ratio; greater than top_left_x.", "maximum": 1, "minimum": 0, "type": "number" }, "bottom_right_y": { "description": "Bottom edge as a frame-height ratio; greater than top_left_y.", "maximum": 1, "minimum": 0, "type": "number" }, "top_left_x": { "description": "Left edge as a frame-width ratio.", "maximum": 1, "minimum": 0, "type": "number" }, "top_left_y": { "description": "Top edge as a frame-height ratio.", "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "top_left_x", "top_left_y", "bottom_right_x", "bottom_right_y" ], "type": "object" }, "VodMediaKitSubtitleFilter": { "additionalProperties": false, "description": "Optional OCR thresholds used by precision subtitle erasure.", "properties": { "center_offset_ratio": { "anyOf": [ { "maximum": 1, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Maximum horizontal center offset ratio treated as a subtitle." }, "max_text_height_ratio": { "anyOf": [ { "maximum": 1, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Maximum OCR text-height ratio treated as a subtitle." }, "min_text_height_ratio": { "anyOf": [ { "maximum": 1, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Minimum OCR text-height ratio treated as a subtitle." } }, "type": "object" }, "VodMediaKitTimeSegment": { "additionalProperties": false, "description": "Time interval selected or skipped during precision erasure.", "properties": { "end_time": { "description": "Segment end time in seconds; greater than start_time.", "exclusiveMinimum": 0, "type": "number" }, "start_time": { "description": "Segment start time in seconds.", "minimum": 0, "type": "number" } }, "required": [ "start_time", "end_time" ], "type": "object" }, "VodMediaKitTimeSegmentFilter": { "additionalProperties": false, "description": "Controls whether listed erasure time segments are selected or skipped.", "properties": { "mode": { "description": "selected erases only listed segments; skip erases outside them.", "enum": [ "selected", "skip" ], "type": "string" }, "segments": { "description": "Non-empty list of time segments.", "items": { "$ref": "#/$defs/VodMediaKitTimeSegment" }, "minItems": 1, "type": "array" } }, "required": [ "mode", "segments" ], "type": "object" }, "VodRemoveSubtitlesInput": { "description": "Input for a MediaKit precision-erasure 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." }, "erase_ratio_location": { "anyOf": [ { "items": { "$ref": "#/$defs/VodMediaKitEraseLocation" }, "maxItems": 20, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "description": "Normalized rectangular regions (1-20) limiting where text is erased." }, "mode": { "default": "subtitle", "description": "subtitle: erase recognized dialogue subtitles. text: erase all recognized on-screen text, including titles, labels, and watermarks.", "enum": [ "subtitle", "text" ], "type": "string" }, "model_version": { "anyOf": [ { "enum": [ "v4", "v5" ], "type": "string" }, { "type": "null" } ], "default": null, "description": "Legacy precision-erasure model version." }, "output_encode_mode": { "default": "quality", "description": "quality: higher bitrate. size: stay near the source bitrate.", "enum": [ "quality", "size" ], "type": "string" }, "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_filter": { "anyOf": [ { "$ref": "#/$defs/VodMediaKitSubtitleFilter" }, { "type": "null" } ], "default": null, "description": "OCR size and centering thresholds; subtitle mode only." }, "time_segment_filter": { "anyOf": [ { "$ref": "#/$defs/VodMediaKitTimeSegmentFilter" }, { "type": "null" } ], "default": null, "description": "Time segments to erase or skip." }, "video_url": { "description": "Public HTTPS source-video URL; private and link-local hosts are rejected.", "format": "uri", "minLength": 1, "type": "string" } }, "required": [ "video_url" ], "type": "object" } }, "additionalProperties": false, "properties": { "input": { "$ref": "#/$defs/VodRemoveSubtitlesInput" } }, "required": [ "input" ], "type": "object"}Output schema, including nested definitions
{ "description": "Accepted asynchronous precision-erasure submission.", "properties": { "operation": { "default": "remove_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 'remove_subtitles').", "title": "Task Id", "type": "string" } }, "required": [ "status", "task_id", "recommended_poll_after_ms" ], "title": "VodRemoveSubtitlesOutput", "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.