omnihuman_get_task
Poll an OmniHuman 2.0 task and retrieve the generated video.
Keep polling while status is queued or running. With persist_output=true the finished video is copied to a durable artifact on the first successful poll (background execution, ark_job_submit); later polls return the cached artifact.
| Requirement | Value |
|---|---|
| Registration | Requires BYTEPLUS_OMNIHUMAN_ENABLED=true and BYTEPLUS_CV_API_KEY. |
| Execution | Foreground or background |
| Required permission | omnihuman: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 omnihuman_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.
Inputs
Section titled “Inputs”The MCP arguments object wraps these fields as {"input": {...}}.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
output_path |
string or null | No | Optional local destination for the generated video: a file, or a directory when it ends with ’/’ (files named <artifact_id>. |
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 | Copy a completed video into artifact storage. true requires background execution (ark_job_submit); use false for a foreground status check.; Default: true |
task_id |
string | Yes | Task ID returned by omnihuman_create_task.; minLength: 1 |
Outputs
Section titled “Outputs”| Field | Type | Required | Description and constraints |
|---|---|---|---|
error |
OmniHumanTaskFailure or null | No | Provider failure detail for a failed task.; Default: null |
persistence |
“not_applicable”, “not_requested”, “persisted”, “failed” | Yes | Artifact persistence outcome. |
persistence_issue |
ArtifactPersistenceIssue or null | No | Why a succeeded video could not be persisted.; Default: null |
provider |
“byteplus-vision-cv” | No | Provider surface.; Default: “byteplus-vision-cv” |
request_id |
string or null | No | Provider diagnostic request ID, when returned.; Default: null |
source_expires_at |
string or null | No | ISO-8601 estimate of when source_url expires (first poll plus one hour).; Default: null |
source_url |
string or null | No | Provider video URL for a succeeded task; valid about one hour.; Default: null |
status |
“queued”, “running”, “succeeded”, “failed”, “canceled”, “expired”, “not_found” | Yes | queued, running, succeeded (video ready), failed (see error), canceled, expired (provider dropped the task; resubmit), or not_found (unknown or older than 12 h). |
task_id |
string | Yes | Task ID. |
video |
ArtifactRef or null | No | Durable video artifact when persistence succeeded.; Default: null |
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.
OmniHumanGetTaskInput
| Field | Type | Required | Description and constraints |
|---|---|---|---|
output_path |
string or null | No | Optional local destination for the generated video: a file, or a directory when it ends with ’/’ (files named <artifact_id>. |
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 | Copy a completed video into artifact storage. true requires background execution (ark_job_submit); use false for a foreground status check.; Default: true |
task_id |
string | Yes | Task ID returned by omnihuman_create_task.; minLength: 1 |
Complete JSON Schemas
Section titled “Complete JSON Schemas”Input schema, including the MCP wrapper
{ "$defs": { "OmniHumanGetTaskInput": { "description": "Input for ``omnihuman_get_task``.", "properties": { "output_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional local destination for the generated video: 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": true, "description": "Copy a completed video into artifact storage. true requires background execution (ark_job_submit); use false for a foreground status check.", "type": "boolean" }, "task_id": { "description": "Task ID returned by omnihuman_create_task.", "minLength": 1, "type": "string" } }, "required": [ "task_id" ], "type": "object" } }, "additionalProperties": false, "properties": { "input": { "$ref": "#/$defs/OmniHumanGetTaskInput" } }, "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" }, "OmniHumanTaskFailure": { "description": "Provider failure detail for a failed OmniHuman task.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Provider failure code, when returned.", "title": "Code" }, "message": { "description": "Provider failure explanation.", "title": "Message", "type": "string" } }, "required": [ "message" ], "title": "OmniHumanTaskFailure", "type": "object" } }, "description": "Normalized status and output of an OmniHuman 2.0 task.", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/OmniHumanTaskFailure" }, { "type": "null" } ], "default": null, "description": "Provider failure detail for a failed task." }, "persistence": { "description": "Artifact persistence outcome.", "enum": [ "not_applicable", "not_requested", "persisted", "failed" ], "title": "Persistence", "type": "string" }, "persistence_issue": { "anyOf": [ { "$ref": "#/$defs/ArtifactPersistenceIssue" }, { "type": "null" } ], "default": null, "description": "Why a succeeded video could not be persisted." }, "provider": { "const": "byteplus-vision-cv", "default": "byteplus-vision-cv", "description": "Provider surface.", "title": "Provider", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Provider diagnostic request ID, when returned.", "title": "Request Id" }, "source_expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO-8601 estimate of when source_url expires (first poll plus one hour).", "title": "Source Expires At" }, "source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Provider video URL for a succeeded task; valid about one hour.", "title": "Source Url" }, "status": { "description": "queued, running, succeeded (video ready), failed (see error), canceled, expired (provider dropped the task; resubmit), or not_found (unknown or older than 12 h).", "enum": [ "queued", "running", "succeeded", "failed", "canceled", "expired", "not_found" ], "title": "Status", "type": "string" }, "task_id": { "description": "Task ID.", "title": "Task Id", "type": "string" }, "video": { "anyOf": [ { "$ref": "#/$defs/ArtifactRef" }, { "type": "null" } ], "default": null, "description": "Durable video artifact when persistence succeeded." } }, "required": [ "task_id", "status", "persistence" ], "title": "OmniHumanTaskOutput", "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.