⌘K

HI 3D Image to 3D

hi3d_image_to_3d

Generate a 3D asset from a single image with selectable geometry, texture, quality, and export format options.

API Notes

hi3d_image_to_3d accepts exactly one of image, image_url, or image_base64.

This is an asynchronous model. Submit a request first, then poll the returned task ID until the task reaches a terminal status.

Authentication

All APIs require authentication via Bearer Token.

Get API Key:

Visit API Key Management Page to get your API Key.

Usage:

Add to request header:

Authorization: Bearer YOUR_API_KEY

model string required

Model ID to use for the request.

Value: hi3d_image_to_3d

image string

Input image. Provide exactly one of image, image_url, or image_base64.

image_url string

Publicly accessible input image URL. Supported image formats are PNG, JPEG, and WebP.

image_base64 string

Base64-encoded input image. Supported image formats are PNG, JPEG, and WebP.

model_version string

HI 3D model version.

Options: hitem3dv1.5, hitem3dv2.0, hitem3dv2.1, hi3dv3.0

Default: hi3dv3.0

request_type integer

Output mode: 1 for geometry only or 3 for geometry with texture.

Default: 3

resolution string

Output resolution. Available values depend on model_version: 512, 1024, 1536, 1536pro, 1536fast, 2048quality, or 2048master.

For hi3dv3.0, the default is 2048quality.

pbr integer

Whether to generate PBR materials.

Options: 0, 1
Default: 1

rmbg integer

Whether to remove the image background.

Options: 0, 1
Default: 1

face integer

Target face count, from 100000 to 5000000.

shading number

Shading value from 0 to 1. The default is 0.5.

format string

Output file format.

Options: obj, glb, stl, fbx, usdz, 3mf
Default: glb

Some PBR options are ignored when using version hitem3dv1.5 or geometry-only output.

Polling

Since result generation takes time, you need to poll the task status after creating the task.

The initial response only returns information such as the task ID and initial status. The final result must be obtained by polling the task status endpoint using the task ID.

See the examples on the right for polling requests and responses.

Response Format

error object

Error information, only present when status is failed

code string

Error code

message string

Detailed error message

output array

Generation results, only present when status is completed

content array

List of generated resource content

type string

Resource type

Value: image｜video

url string

Processed resource URL

jobId string

Remote task ID

usage object

Usage statistics, only present when status is completed

cost string

Total cost in USD

discount number

Discount amount

metadata object

Metadata information