Image to model (Turbo-v1.0-20250506)
This page lists all supported parameters for image_to_model when using model_version Turbo-v1.0-20250506.
When to use Turbo-v1.0
- Choose Turbo-v1.0 when latency is the top priority and you want the fastest turnaround.
- If you need higher fidelity controls, use
H3orP1instead.
Endpoint
Parameters
Required parameters
type: This field must be set to image_to_model.
file: Specifies the image input.
type: Indicates the file type. Although currently not validated, specifying the correct file type is strongly advised.file_token: The identifier you get from upload, please refer to part of Upload directly. Mutually exclusive withurlandobject.url: A direct URL to the image. Supports JPEG and PNG formats with a maximum size of 20MB. Mutually exclusive withfile_tokenandobject.object(Strongly Recommended): The information you get from upload, please refer to Upload in STS. Mutually exclusive withurlandfile_token.bucket: Normally it always will betripo-data.key: Theresource_urifrom returns.
model_version: Set to Turbo-v1.0-20250506.
Common parameters
model_seed: An integer value chosed randomly if not set. This is the random seed for model generation. For model_version>=v2.0-20240919 or Turbo-v1.0-20250506, the seed controls the geometry generation process, ensuring identical models when the same seed is used.
enable_image_autofix: A bool value to determine if optimize the input image to get better generation result. It will take longer time when request. The default value is false.
texture: A bool value to enable texturing, set false to get a base model without any textures. The default value is true. This will cost 10 less credits when set to false, this will not work for version v1.4-20240625.
Advanced parameters
texture_seed: An integer value chosed randomly if not set. This is the random seed for texture generation for model_version>=v2.0-20240919 or Turbo-v1.0-20250506. Using the same seed will produce identical textures. If you want a model with different textures, please use same model_seed and different texture_seed.
texture_quality: A text value to control the texture quality. Can be set to standard, detailed, or extreme. detailed provides high-resolution textures, resulting in more refined and realistic representation of intricate parts. extreme provides the highest texture resolution and visual fidelity. The default value is standard. Additional credits: standard 10, detailed 20, extreme 30.
Combination rules when texture_quality is detailed or extreme:
texture=false,pbr=false: Upscales the texture to 4K. PBR material will be removed. Only available forv3.0-20250812.texture=false,pbr=true: Generates PBR with the current texture.texture=true,pbr=false: Regenerates HD texture without PBR.texture=true,pbr=true: Regenerates HD texture with PBR.
WARNING
Setting texture_quality=standard with both texture=false and pbr=false is not allowed.
pbr: A bool value to enable pbr, set false to get a model without pbr. The default value is true.
TIP
If this option is set to true, value of texture will be ignored and set to true.
quad: A bool value, set true to enable quad mesh output. If quad=true and face_limit is not set, face_limit will default to 10000. Recommended not to exceed 150,000. This will cost 5 additional credits when set to true.
TIP
Enabling this option will force the output to be an FBX model.
face_limit: An integer value which limits the number of faces on the output model. If this option is not set, the face limit will be adaptively determined. The face limit is up to 50,000.
Quad face limit (quad=true): recommended not to exceed 50,000.
auto_size: A bool value to automatically scale the model to real-world dimensions with the unit in meters. The default value is false.
TIP
This can only be used in textured model.
orientation: A text value. When set orientation=align_image, it will automatically rotate the model to align the original image. The default value is default. This parameter only takes effect when texture=true.
compress: A text value to specify the compression type to apply to the texture. Set to geometry to apply geometry-based compression to optimize the output. By Default we use meshopt compression.
generate_parts: Generate segmented 3D models and make each part editable. The default value is false. This will cost 20 additional credits when set to true.
TIP
Generate_parts is not compatible with texture=true or pbr=true, if you want to generate parts, please set texture=false and pbr=false;
Generate_parts is also not compatible with quad=true, if you want to generate parts, please set quad=false.
export_uv: A bool value to control whether UV unwrapping is performed during generation. The default value is true.
TIP
When set to false, generation speed is significantly improved and model size is reduced. UV unwrapping will be handled during the texturing stage.
Returns
task_id: The identifier for the successfully submitted task.