vod_transcode_video
Transcode a public video (codec, container, scaling, bitrate, fps, HDR) with MediaKit.
Default options letterbox to 720x720. Returns a task_id; poll it with vod_get_task (operation ‘transcode’). Not retried automatically. Requires background execution (ark_job_submit).
| Requirement | Value |
|---|---|
| Registration | Requires BYTEPLUS_VOD_MEDIAKIT_API_KEY. |
| Execution | Background required |
| Required permission | vod:transcode |
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_transcode_video 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 |
|---|---|---|---|
container_format |
“MP4”, “FLV”, “MPEGTS” | No | Output container format.; Default: “MP4” |
video |
VodTranscodeVideoOptions | No | Output video options. Defaults letterbox to 720x720 (h264, CRF 25). |
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: “transcode” |
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 ‘transcode’). |
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.
VodTranscodeVideoInput
| Field | Type | Required | Description and constraints |
|---|---|---|---|
container_format |
“MP4”, “FLV”, “MPEGTS” | No | Output container format.; Default: “MP4” |
video |
VodTranscodeVideoOptions | No | Output video options. Defaults letterbox to 720x720 (h264, CRF 25). |
video_url |
string | Yes | Public HTTPS source-video URL; private and link-local hosts are rejected.; minLength: 1; format: “uri” |
VodTranscodeVideoOptions
| Field | Type | Required | Description and constraints |
|---|---|---|---|
bitrate_crf |
integer | No | CRF level (0 is lossless); bitrate_mode=crf only.; minimum: 0; maximum: 51; Default: 25 |
bitrate_kbps |
integer | No | Bitrate in kbps: max limit for crf, average target for abr, constant for cbr.; minimum: 10; maximum: 50000; Default: 2000 |
bitrate_mode |
“crf”, “abr”, “cbr” | No | crf (quality), abr (average bitrate), or cbr (constant bitrate).; Default: “crf” |
codec |
“h264”, “h265” | No | Output video codec: h264 or h265.; Default: “h264” |
fps |
integer or null | No | Target frame rate; unset keeps the source rate.; Default: null |
fps_mode |
“vfr”, “cfr” | No | vfr (fps is a max) or cfr (forced constant); only used when fps is set.; Default: “vfr” |
is_hdr_to_sdr |
boolean | No | Convert HDR input to SDR; false keeps HDR.; Default: true |
scale_height |
integer or null | No | Target height in pixels; scale_type=2 only. Defaults to 720.; Default: null |
scale_long |
integer or null | No | Target long side in pixels; only when scale_type=1.; Default: null |
scale_mode |
0, 1, 2 | No | For scale_type 1 or 2: 0 = shrink only, 1 = stretch to target, 2 = letterbox with black bars.; Default: 2 |
scale_short |
integer or null | No | Target short side in pixels; only when scale_type=1.; Default: null |
scale_type |
0, 1, 2 | No | 0 = keep source size, 1 = long/short-side limit, 2 = width/height limit.; Default: 2 |
scale_width |
integer or null | No | Target width in pixels; scale_type=2 only. If only one of width/height is set, the other scales proportionally. Defaults to 720.; Default: null |
Complete JSON Schemas
Section titled “Complete JSON Schemas”Input schema, including the MCP wrapper
{ "$defs": { "VodTranscodeVideoInput": { "description": "Input for the BytePlus VOD AI MediaKit video transcoding task.", "properties": { "container_format": { "default": "MP4", "description": "Output container format.", "enum": [ "MP4", "FLV", "MPEGTS" ], "type": "string" }, "video": { "$ref": "#/$defs/VodTranscodeVideoOptions", "description": "Output video options. Defaults letterbox to 720x720 (h264, CRF 25)." }, "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" }, "VodTranscodeVideoOptions": { "description": "Output video options for transcoding.", "properties": { "bitrate_crf": { "default": 25, "description": "CRF level (0 is lossless); bitrate_mode=crf only.", "maximum": 51, "minimum": 0, "type": "integer" }, "bitrate_kbps": { "default": 2000, "description": "Bitrate in kbps: max limit for crf, average target for abr, constant for cbr.", "maximum": 50000, "minimum": 10, "type": "integer" }, "bitrate_mode": { "default": "crf", "description": "crf (quality), abr (average bitrate), or cbr (constant bitrate).", "enum": [ "crf", "abr", "cbr" ], "type": "string" }, "codec": { "default": "h264", "description": "Output video codec: h264 or h265.", "enum": [ "h264", "h265" ], "type": "string" }, "fps": { "anyOf": [ { "maximum": 240, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Target frame rate; unset keeps the source rate." }, "fps_mode": { "default": "vfr", "description": "vfr (fps is a max) or cfr (forced constant); only used when fps is set.", "enum": [ "vfr", "cfr" ], "type": "string" }, "is_hdr_to_sdr": { "default": true, "description": "Convert HDR input to SDR; false keeps HDR.", "type": "boolean" }, "scale_height": { "anyOf": [ { "maximum": 4320, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Target height in pixels; scale_type=2 only. Defaults to 720." }, "scale_long": { "anyOf": [ { "maximum": 4320, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Target long side in pixels; only when scale_type=1." }, "scale_mode": { "default": 2, "description": "For scale_type 1 or 2: 0 = shrink only, 1 = stretch to target, 2 = letterbox with black bars.", "enum": [ 0, 1, 2 ], "type": "integer" }, "scale_short": { "anyOf": [ { "maximum": 4320, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Target short side in pixels; only when scale_type=1." }, "scale_type": { "default": 2, "description": "0 = keep source size, 1 = long/short-side limit, 2 = width/height limit.", "enum": [ 0, 1, 2 ], "type": "integer" }, "scale_width": { "anyOf": [ { "maximum": 4320, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Target width in pixels; scale_type=2 only. If only one of width/height is set, the other scales proportionally. Defaults to 720." } }, "type": "object" } }, "additionalProperties": false, "properties": { "input": { "$ref": "#/$defs/VodTranscodeVideoInput" } }, "required": [ "input" ], "type": "object"}Output schema, including nested definitions
{ "description": "Accepted asynchronous transcode submission.", "properties": { "operation": { "default": "transcode", "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 'transcode').", "title": "Task Id", "type": "string" } }, "required": [ "status", "task_id", "recommended_poll_after_ms" ], "title": "VodTranscodeVideoOutput", "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.