Skip to content

hyper3d_create_task

Create a Hyper3D 3D generation task from a text prompt and/or up to 5 images.

Poll the returned task_id with gen_task_get. Requires background execution (ark_job_submit).

Requirement Value
Registration Requires BYTEPLUS_MODELARK_3D_ENABLED=true and BYTEPLUS_MODELARK_API_KEY.
Execution Background required
Required permission hyper3d:create

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.

These are supported families and built-in model or service IDs for this site revision, not provider account access or a guarantee that every row is enabled on your server. Check model discovery for configured bindings and service availability.

Model Model or service ID Availability Capabilities
Hyper3D Gen 2 hyper3d-gen2-260112 BYTEPLUS_MODELARK_3D_ENABLED=true and ModelArk key; disabled by default. Text and/or up to 5 reference images; seed support; GLB/OBJ/USDZ/FBX/STL; asynchronous tasks polled with gen_task_get.

Omit model for HYPER3D_DEFAULT_MODEL, or pass an exact ID bound to hyper3d in SEED3D_MODEL_BINDINGS.

Ask your connected AI client to use hyper3d_create_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.

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.

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

Field Type Required Description and constraints
addons “HighPack” or null No HighPack gives 4K textures.; Default: null
bbox_condition array of integer or null No Bounding box [width, height, length].; Default: null
callback_url string or null No Callback URL notified on task status changes.; Default: null
file_format “glb”, “obj”, “usdz”, “fbx”, “stl” or null No Output format. Default glb.; Default: null
hd_texture boolean or null No Enable HD textures.; Default: null
images array of Seed3DImageInput or null No Reference images for image-to-3D (max 5); a prompt may accompany them.; Default: null
material “PBR”, “Shaded”, “All”, “None” or null No Material type; None gives a white model. Default PBR.; Default: null
mesh_mode “Raw”, “Quad” or null No Raw (triangles) or Quad. Default Quad.; Default: null
model string or null No Hyper3D model ID from ark_list_models(kind=‘3d’). Omit for the default.; Default: null
prompt string or null No English description of the model (max 400 chars). Required when no images are given.; Default: null
quality_override integer or null No Polygon face count (Raw: 500-1000000, Quad: 1000-200000).; Default: null
seed integer or null No Random seed for reproducible output.; Default: null
subdivision_level “high”, “medium”, “low” or null No Polygon count level; ignored when quality_override is set.; Default: null
ta_pose boolean or null No Force a T-Pose/A-Pose bind for humanoid models.; Default: null
use_original_alpha boolean or null No Preserve transparent areas of the input image.; Default: null
Field Type Required Description and constraints
recommended_poll_after_ms integer Yes Suggested delay in milliseconds before the first poll.
status “queued” No Initial task status.; Default: “queued”
task_id string Yes Pass to gen_task_get to poll or gen_task_cancel_or_delete to cancel.

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.

Hyper3DCreateTaskInput
Field Type Required Description and constraints
addons “HighPack” or null No HighPack gives 4K textures.; Default: null
bbox_condition array of integer or null No Bounding box [width, height, length].; Default: null
callback_url string or null No Callback URL notified on task status changes.; Default: null
file_format “glb”, “obj”, “usdz”, “fbx”, “stl” or null No Output format. Default glb.; Default: null
hd_texture boolean or null No Enable HD textures.; Default: null
images array of Seed3DImageInput or null No Reference images for image-to-3D (max 5); a prompt may accompany them.; Default: null
material “PBR”, “Shaded”, “All”, “None” or null No Material type; None gives a white model. Default PBR.; Default: null
mesh_mode “Raw”, “Quad” or null No Raw (triangles) or Quad. Default Quad.; Default: null
model string or null No Hyper3D model ID from ark_list_models(kind=‘3d’). Omit for the default.; Default: null
prompt string or null No English description of the model (max 400 chars). Required when no images are given.; Default: null
quality_override integer or null No Polygon face count (Raw: 500-1000000, Quad: 1000-200000).; Default: null
seed integer or null No Random seed for reproducible output.; Default: null
subdivision_level “high”, “medium”, “low” or null No Polygon count level; ignored when quality_override is set.; Default: null
ta_pose boolean or null No Force a T-Pose/A-Pose bind for humanoid models.; Default: null
use_original_alpha boolean or null No Preserve transparent areas of the input image.; Default: null
MediaSourceKind

No fields. Pass {}.

Seed3DImageInput
Field Type Required Description and constraints
data string or null No Base64-encoded media data. Required when kind is ‘base64’.; Default: null
kind MediaSourceKind Yes Whether the media is referenced by URL or Base64.
mime_type string or null No MIME type of the media (e.g. image/png, audio/wav).; Default: null
url string or null No HTTPS URL of the media. Required when kind is ‘url’.; Default: null
Input schema, including the MCP wrapper
{
"$defs": {
"Hyper3DCreateTaskInput": {
"description": "Input model for ``hyper3d_create_task``.",
"properties": {
"addons": {
"anyOf": [
{
"const": "HighPack",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "HighPack gives 4K textures."
},
"bbox_condition": {
"anyOf": [
{
"items": {
"type": "integer"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Bounding box [width, height, length]."
},
"callback_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Callback URL notified on task status changes."
},
"file_format": {
"anyOf": [
{
"enum": [
"glb",
"obj",
"usdz",
"fbx",
"stl"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Output format. Default glb."
},
"hd_texture": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Enable HD textures."
},
"images": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Seed3DImageInput"
},
"maxItems": 5,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Reference images for image-to-3D (max 5); a prompt may accompany them."
},
"material": {
"anyOf": [
{
"enum": [
"PBR",
"Shaded",
"All",
"None"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Material type; None gives a white model. Default PBR."
},
"mesh_mode": {
"anyOf": [
{
"enum": [
"Raw",
"Quad"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Raw (triangles) or Quad. Default Quad."
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hyper3D model ID from ark_list_models(kind='3d'). Omit for the default."
},
"prompt": {
"anyOf": [
{
"maxLength": 400,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "English description of the model (max 400 chars). Required when no images are given."
},
"quality_override": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Polygon face count (Raw: 500-1000000, Quad: 1000-200000)."
},
"seed": {
"anyOf": [
{
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Random seed for reproducible output."
},
"subdivision_level": {
"anyOf": [
{
"enum": [
"high",
"medium",
"low"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Polygon count level; ignored when quality_override is set."
},
"ta_pose": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Force a T-Pose/A-Pose bind for humanoid models."
},
"use_original_alpha": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Preserve transparent areas of the input image."
}
},
"type": "object"
},
"MediaSourceKind": {
"description": "Whether a media source is a URL or inline Base64 data.",
"enum": [
"url",
"base64"
],
"type": "string"
},
"Seed3DImageInput": {
"description": "Image input for 3D generation (Hyper3D and Hitem3d).",
"properties": {
"data": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Base64-encoded media data. Required when kind is 'base64'."
},
"kind": {
"$ref": "#/$defs/MediaSourceKind",
"description": "Whether the media is referenced by URL or Base64."
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "MIME type of the media (e.g. image/png, audio/wav)."
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "HTTPS URL of the media. Required when kind is 'url'."
}
},
"required": [
"kind"
],
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"input": {
"$ref": "#/$defs/Hyper3DCreateTaskInput"
}
},
"required": [
"input"
],
"type": "object"
}
Output schema, including nested definitions
{
"description": "Output model for 3D task creation tools.",
"properties": {
"recommended_poll_after_ms": {
"description": "Suggested delay in milliseconds before the first poll.",
"title": "Recommended Poll After Ms",
"type": "integer"
},
"status": {
"const": "queued",
"default": "queued",
"description": "Initial task status.",
"title": "Status",
"type": "string"
},
"task_id": {
"description": "Pass to gen_task_get to poll or gen_task_cancel_or_delete to cancel.",
"title": "Task Id",
"type": "string"
}
},
"required": [
"task_id",
"recommended_poll_after_ms"
],
"title": "Seed3DCreateTaskOutput",
"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.