⌘K

HI 3D Image to Relief

hi3d_image_to_relief

Generate a relief model or depth image from a single input image.

API Notes

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

The output can be a 3D relief model or an image depth map, depending on format.

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

Value: hi3d_image_to_relief

image string

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

image_url string

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

image_base64 string

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

model_type string

Relief model type.

Options: base, pro
Default: pro

rmbg integer

Whether to remove the background. Options: 0, 1. The default is 1.

height_relief number

Relief height from 0.1 to 50. The default is 1.3.

width number

Output width from 20 to 600. The default is 40.

sculpmode integer

Sculpting mode. Options: 0, 1. The default is 0.

degree_rmbg number

Background removal degree from 0 to 1. Use when rmbg=1.

shape_base integer

Whether to add a base shape. Use when rmbg=0. Options: 0, 1.

thickness_base number

Base thickness from 0.1 to 20. Use when rmbg=0.

format string

Output format.

Options: exr, png, stl, glb, 3mf, bmp
Default: glb

exr, png, and bmp return image results; the other formats return 3D model results.

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