omnihuman_cancel_task
Cancel an OmniHuman 2.0 task that is still queued.
A task that already started returns canceled=false, not an error. Right after omnihuman_create_task the provider may reject the ID as invalid; wait a few seconds and retry.
| Requirement | Value |
|---|---|
| Registration | Requires BYTEPLUS_OMNIHUMAN_ENABLED=true and BYTEPLUS_CV_API_KEY. |
| Execution | Foreground only |
| Required permission | omnihuman:cancel |
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_cancel_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.
Call this tool directly. It is not a background-job target.
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 |
|---|---|---|---|
task_id |
string | Yes | Task ID returned by omnihuman_create_task.; minLength: 1 |
Outputs
Section titled “Outputs”| Field | Type | Required | Description and constraints |
|---|---|---|---|
canceled |
boolean | Yes | True when canceled; false when it already started or finished (see message). |
message |
string or null | No | Explanation when canceled is false; otherwise null.; 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 |
task_id |
string | Yes | Task ID targeted. |
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.
OmniHumanCancelTaskInput
| Field | Type | Required | Description and constraints |
|---|---|---|---|
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": { "OmniHumanCancelTaskInput": { "description": "Input for ``omnihuman_cancel_task``.", "properties": { "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/OmniHumanCancelTaskInput" } }, "required": [ "input" ], "type": "object"}Output schema, including nested definitions
{ "description": "Outcome of an OmniHuman 2.0 cancel request.", "properties": { "canceled": { "description": "True when canceled; false when it already started or finished (see message).", "title": "Canceled", "type": "boolean" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Explanation when canceled is false; otherwise null.", "title": "Message" }, "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" }, "task_id": { "description": "Task ID targeted.", "title": "Task Id", "type": "string" } }, "required": [ "task_id", "canceled" ], "title": "OmniHumanCancelTaskOutput", "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.