Skip to content

vod_get_task

Poll any VOD MediaKit task (enhance, transcode, separate_audio, add_subtitles, remove_subtitles).

Pass the task_id and operation returned by the vod_* create tool. A processing task is not a failure: poll again, do not resubmit. persist_output=true (default false) copies outputs into durable storage once and requires background execution (ark_job_submit); outputs always keep their expiring source_url.

Requirement Value
Registration Requires BYTEPLUS_VOD_MEDIAKIT_API_KEY.
Execution Foreground or background
Required permission vod:read

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_get_task 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.

Use a direct foreground call for lightweight operations. Submit through ark_job_submit when output persistence or a large download may take time. The full arguments still include the input wrapper.

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.

The MCP arguments object wraps these fields as {"input": {...}}.

Field Type Required Description and constraints
operation “enhance”, “transcode”, “separate_audio”, “add_subtitles”, “remove_subtitles” Yes Operation returned by the vod_* create tool that made the task.
output_path string or null No Optional local destination for the output (needs persist_output=true; separate_audio requires a ’/’ directory): a file, or a directory when it ends with ’/’ (files named <artifact_id>.). stdio only; absolute path inside an allowed output root (client MCP roots or OUTPUT_ROOTS). The durable artifact is always kept; the copy is reported in ArtifactRef.local_path.; Default: null
overwrite boolean No Replace an existing file at output_path/output_dir when its content differs (identical content is always accepted).; Default: false
persist_output boolean No Persist finished outputs as durable artifacts (once per task). Requires background execution (ark_job_submit); leave false for a foreground poll.; Default: false
task_id string Yes Task ID returned by a vod_* create tool.; minLength: 1; maxLength: 256; pattern: ”^[A-Za-z0-9._:-]+$”
Field Type Required Description and constraints
created_at string or null No ISO-8601 creation time.; Default: null
duration_seconds number or null No Output duration in seconds (input duration for separate_audio).; Default: null
error TaskError or null No Failure code and safe message when status is failed.; Default: null
finished_at string or null No ISO-8601 completion time.; Default: null
fps number or null No Output frames per second (enhance only).; Default: null
operation “enhance”, “transcode”, “separate_audio”, “add_subtitles”, “remove_subtitles” Yes Operation that created the task.
outputs array of TaskOutputFile Yes Finished outputs (role video, or voice/background/music/sfx for separate_audio); empty until succeeded.
provider “byteplus-vod-mediakit” No Provider surface.; Default: “byteplus-vod-mediakit”
provider_status string or null No Raw provider status, when returned.; Default: null
request_id string or null No Provider request ID, when returned.; Default: null
resolution string or null No Output resolution label, when reported (video operations).; Default: null
status “processing”, “succeeded”, “failed” Yes processing (poll again), succeeded, or failed.
task_id string Yes Task ID.
tool_version string or null No Enhancement tier (enhance only).; Default: null
video_codec string or null No Output video codec (transcode only).; Default: null

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.

VodGetTaskInput
Field Type Required Description and constraints
operation “enhance”, “transcode”, “separate_audio”, “add_subtitles”, “remove_subtitles” Yes Operation returned by the vod_* create tool that made the task.
output_path string or null No Optional local destination for the output (needs persist_output=true; separate_audio requires a ’/’ directory): a file, or a directory when it ends with ’/’ (files named <artifact_id>.). stdio only; absolute path inside an allowed output root (client MCP roots or OUTPUT_ROOTS). The durable artifact is always kept; the copy is reported in ArtifactRef.local_path.; Default: null
overwrite boolean No Replace an existing file at output_path/output_dir when its content differs (identical content is always accepted).; Default: false
persist_output boolean No Persist finished outputs as durable artifacts (once per task). Requires background execution (ark_job_submit); leave false for a foreground poll.; Default: false
task_id string Yes Task ID returned by a vod_* create tool.; minLength: 1; maxLength: 256; pattern: ”^[A-Za-z0-9._:-]+$”
Input schema, including the MCP wrapper
{
"$defs": {
"VodGetTaskInput": {
"description": "Input for ``vod_get_task``.",
"properties": {
"operation": {
"description": "Operation returned by the vod_* create tool that made the task.",
"enum": [
"enhance",
"transcode",
"separate_audio",
"add_subtitles",
"remove_subtitles"
],
"type": "string"
},
"output_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional local destination for the output (needs persist_output=true; separate_audio requires a '/' directory): a file, or a directory when it ends with '/' (files named <artifact_id>.<ext>). stdio only; absolute path inside an allowed output root (client MCP roots or OUTPUT_ROOTS). The durable artifact is always kept; the copy is reported in ArtifactRef.local_path."
},
"overwrite": {
"default": false,
"description": "Replace an existing file at output_path/output_dir when its content differs (identical content is always accepted).",
"type": "boolean"
},
"persist_output": {
"default": false,
"description": "Persist finished outputs as durable artifacts (once per task). Requires background execution (ark_job_submit); leave false for a foreground poll.",
"type": "boolean"
},
"task_id": {
"description": "Task ID returned by a vod_* create tool.",
"maxLength": 256,
"minLength": 1,
"pattern": "^[A-Za-z0-9._:-]+$",
"type": "string"
}
},
"required": [
"task_id",
"operation"
],
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"input": {
"$ref": "#/$defs/VodGetTaskInput"
}
},
"required": [
"input"
],
"type": "object"
}
Output schema, including nested definitions
{
"$defs": {
"ArtifactPersistenceIssue": {
"description": "Safe explanation for a provider output that could not be persisted.",
"properties": {
"artifact_limit_bytes": {
"description": "Maximum durable artifact size in bytes.",
"title": "Artifact Limit Bytes",
"type": "integer"
},
"code": {
"description": "Failure category.",
"enum": [
"untrusted_output_host",
"output_too_large",
"invalid_output_mime",
"source_expired",
"download_failed",
"storage_failed"
],
"title": "Code",
"type": "string"
},
"message": {
"description": "Safe failure message (no credentials or URLs).",
"title": "Message",
"type": "string"
},
"retryable": {
"description": "Whether retrying persistence later may succeed.",
"title": "Retryable",
"type": "boolean"
},
"source_url_expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "ISO-8601 expiry of the unpersisted provider URL (the artifact uri).",
"title": "Source Url Expires At"
}
},
"required": [
"code",
"message",
"retryable",
"artifact_limit_bytes"
],
"title": "ArtifactPersistenceIssue",
"type": "object"
},
"ArtifactRef": {
"description": "Stable reference to a persisted media artifact.",
"properties": {
"bytes": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Size in bytes.",
"title": "Bytes"
},
"created_at": {
"description": "ISO-8601 timestamp of artifact creation.",
"title": "Created At",
"type": "string"
},
"expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "ISO-8601 expiry of the stored artifact.",
"title": "Expires At"
},
"export_error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Why the requested local copy was not written (the artifact is unaffected).",
"title": "Export Error"
},
"fallback_data": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Base64 output bytes, only with id 'inline-fallback'.",
"title": "Fallback Data"
},
"id": {
"description": "Unique artifact identifier.",
"title": "Id",
"type": "string"
},
"local_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Absolute path of the local copy written for output_path/output_dir.",
"title": "Local Path"
},
"media_type": {
"$ref": "#/$defs/MediaType",
"description": "image, audio, video or three_d."
},
"mime_type": {
"description": "MIME type, e.g. image/png.",
"title": "Mime Type",
"type": "string"
},
"persistence_error": {
"anyOf": [
{
"$ref": "#/$defs/ArtifactPersistenceIssue"
},
{
"type": "null"
}
],
"default": null,
"description": "Set when the output was billed but not stored. id is then 'provider-url' (uri is the temporary provider URL; re-persist it with seed_media_persist_url before source_expires_at) or 'inline-fallback' (bytes in fallback_data)."
},
"sha256": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "SHA-256 hex digest.",
"title": "Sha256"
},
"source_expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "ISO-8601 expiry of the provider URL.",
"title": "Source Expires At"
},
"uri": {
"description": "MCP resource URI (seed-media://artifacts/{id}).",
"title": "Uri",
"type": "string"
}
},
"required": [
"id",
"uri",
"media_type",
"mime_type",
"created_at"
],
"title": "ArtifactRef",
"type": "object"
},
"MediaType": {
"description": "Logical generated-media categories.",
"enum": [
"image",
"audio",
"video",
"three_d"
],
"title": "MediaType",
"type": "string"
},
"TaskError": {
"description": "Safe provider failure detail for an asynchronous task.",
"properties": {
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Provider failure code, when returned.",
"title": "Code"
},
"message": {
"default": "",
"description": "Failure explanation without credentials or signed URLs.",
"title": "Message",
"type": "string"
}
},
"title": "TaskError",
"type": "object"
},
"TaskOutputFile": {
"description": "One output file of a finished task (ModelArk generation or VOD MediaKit).",
"properties": {
"artifact": {
"anyOf": [
{
"$ref": "#/$defs/ArtifactRef"
},
{
"type": "null"
}
],
"default": null,
"description": "Durable artifact when persisted."
},
"persistence": {
"description": "Persistence outcome, independent of task success.",
"enum": [
"not_requested",
"persisted",
"failed"
],
"title": "Persistence",
"type": "string"
},
"persistence_issue": {
"anyOf": [
{
"$ref": "#/$defs/ArtifactPersistenceIssue"
},
{
"type": "null"
}
],
"default": null,
"description": "Safe explanation when persistence failed."
},
"role": {
"description": "Output kind: video, last_frame (Seedance), model_file (3D), or voice, background, music, sfx (VOD audio separation).",
"enum": [
"video",
"last_frame",
"model_file",
"voice",
"background",
"music",
"sfx"
],
"title": "Role",
"type": "string"
},
"source_expires_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "ISO-8601 expiry of source_url.",
"title": "Source Expires At"
},
"source_url": {
"anyOf": [
{
"format": "uri",
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Expiring provider URL (kept when persistence is skipped or fails).",
"title": "Source Url"
}
},
"required": [
"role",
"persistence"
],
"title": "TaskOutputFile",
"type": "object"
}
},
"description": "Normalized status and outputs of a VOD AI MediaKit task.",
"properties": {
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "ISO-8601 creation time.",
"title": "Created At"
},
"duration_seconds": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Output duration in seconds (input duration for separate_audio).",
"title": "Duration Seconds"
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/TaskError"
},
{
"type": "null"
}
],
"default": null,
"description": "Failure code and safe message when status is failed."
},
"finished_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "ISO-8601 completion time.",
"title": "Finished At"
},
"fps": {
"anyOf": [
{
"exclusiveMinimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Output frames per second (enhance only).",
"title": "Fps"
},
"operation": {
"description": "Operation that created the task.",
"enum": [
"enhance",
"transcode",
"separate_audio",
"add_subtitles",
"remove_subtitles"
],
"title": "Operation",
"type": "string"
},
"outputs": {
"description": "Finished outputs (role video, or voice/background/music/sfx for separate_audio); empty until succeeded.",
"items": {
"$ref": "#/$defs/TaskOutputFile"
},
"title": "Outputs",
"type": "array"
},
"provider": {
"const": "byteplus-vod-mediakit",
"default": "byteplus-vod-mediakit",
"description": "Provider surface.",
"title": "Provider",
"type": "string"
},
"provider_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Raw provider status, when returned.",
"title": "Provider Status"
},
"request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Provider request ID, when returned.",
"title": "Request Id"
},
"resolution": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Output resolution label, when reported (video operations).",
"title": "Resolution"
},
"status": {
"description": "processing (poll again), succeeded, or failed.",
"enum": [
"processing",
"succeeded",
"failed"
],
"title": "Status",
"type": "string"
},
"task_id": {
"description": "Task ID.",
"title": "Task Id",
"type": "string"
},
"tool_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Enhancement tier (enhance only).",
"title": "Tool Version"
},
"video_codec": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Output video codec (transcode only).",
"title": "Video Codec"
}
},
"required": [
"task_id",
"operation",
"status",
"outputs"
],
"title": "VodTaskOutput",
"type": "object"
}
  • 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.