Skip to main content
POST
  1. Submit the request with VIDGO_API_KEY. A task_id is returned immediately. Keep it until the task reaches finished or failed.
  2. Use Query Task Status to retrieve the result. If you provide a callback_url, Vidgo sends the result to your webhook when the task finishes or fails.

Hunyuan 3D v3.1 Pro Text to 3D

Generate 3D objects from text with Hunyuan 3D v3.1 Pro, with control over mesh complexity and geometry-only output.

Available Models

  • hunyuan-3d/v3.1/pro/text-to-3d - Generate a 3D model from a text prompt.

Output Options

Generate Type

  • generate_type: Optional. Choose Normal for a textured model or Geometry for a geometry-only white model.

Face Count

  • face_count: Optional. Set the target face count. Integer from 40000 to 1500000. Default: 500000.

Key Features

  • Generate a 3D model from a text prompt.
  • Retrieve model assets and available previews or supporting files from the task result.

Advanced Parameters

Set model and optional callback_url at the request root. Place all workflow parameters, including output options, inside input. Use the input parameters listed below.

Prompt

  • prompt: Required. Describe the desired 3D object. Length: 1-1,024 characters.
  • Use a nonblank string when providing this parameter.

PBR

  • enable_pbr: Optional. Set true to generate PBR materials in textured mode. Geometry-only generation takes precedence over this setting.

Output Files

  • Read every item in the returned files array.
  • Model assets use file_type: "3d"; previews use file_type: "image".
  • Additional artifacts may use file_type: "other". Retain returned textures, material files, and file metadata.

Authorizations

Authorization
string
header
required

Use VIDGO_API_KEY.

Body

application/json

Place model and callback_url at the request root and generation parameters inside input.

model
string
required
Example:

"hunyuan-3d/v3.1/pro/text-to-3d"

input
object
required
callback_url
string | null

Optional public HTTP(S) endpoint for task completion notifications. HTTPS is recommended. Omit, use null, or use an empty string to disable callbacks.

Response

Task submitted

code
enum<integer>
required
Available options:
200
data
object
required