Tripo Smart Segmentation provides an end-to-end segmentation pipeline. It takes an image or a 3D model in GLB format as input and outputs a segmented 3D model. Unlike Mesh Segmentation, which only segments existing models, Smart Segmentation includes automatic modeling.
Prerequisites
- Enable the service: Go to the Alibaba Cloud Model Studio console, search for "Tripo", find the Tripo model card, and click Enable Now. In the dialog box, confirm the authorization.
- Configure your API key: Select a region, get an API key, and then configure the API key as an environment variable.
HTTP calls
The API uses asynchronous calls. The process involves two steps: create a task and then poll for the result.
Step 1: Create a task
China (Beijing): POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/video-generation/3d-generation
Replace {WorkspaceId} with your actual workspace ID.
- After the task is created, use the returned
task_idto query the result. Thetask_idis valid for 24 hours. Do not create duplicate tasks. Instead, use polling to retrieve the result. - For guidance for beginners, see Call APIs with Postman or cURL.
Request parametersRequest headersContent-Typestring (Required)The content type of the request. Must be application/json.Authorization string (Required)Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.X-DashScope-Async string (Required)Enables asynchronous processing. HTTP requests support only asynchronous calls. Must be enable.Request bodymodelstring (Required)The model name. Fixed value: Tripo/Tripo-SmartSegmentation.input object (Required)The model input.
Properties seg_type string (Required)The input type. Valid values:
string (Conditionally required)The public URL of the input image. PNG, JPEG, and WebP formats are supported. The image cannot exceed 20 MB. The resolution is not limited. Required only when seg_type is image.model_url string (Conditionally required)The public URL of the model file. Only the GLB format is supported. A non-GLB file returns a 400 error. The file cannot exceed 150 MB. Required only when seg_type is model.object (Optional)The segmentation parameters.
Properties granularity string (Optional)The segmentation granularity. Valid values:
string (Optional)A prompt that helps identify the parts to segment. The length and language are not limited. Keep it short and clear, for example, "separate the cup body from the lid".transform array[number] (Conditionally required)A 4×4 column-major transformation matrix that must consist of exactly 16 floating-point numbers. The element values are not limited. Required only when seg_type is model.If this parameter is not passed or does not contain exactly 16 elements, a 400 error is returned. This parameter is ignored when seg_type is image.Example of an identity matrix: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]. |
|
Response parametersoutputobjectThe task output information.
Properties task_id stringThe task ID. Valid for queries for 24 hours.task_status stringThe status of the task.
Enumeration values
stringUnique request identifier for tracing and troubleshooting.code stringError code. Returned only for failed requests. See Error codes.message stringDetailed error message. Returned only for failed requests. See Error codes. |
Save the task_id to query the task status and result. |
Step 2: Query the task result
China (Beijing): GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/tasks/{task_id}
- Polling recommendation: Smart segmentation may take several minutes. We recommend using a polling mechanism: query 10 seconds after submitting the task, and then every 15 to 30 seconds.
- Task status flow: PENDING (queued) → RUNNING (processing) → SUCCEEDED (successful) / FAILED (failed).
- Task ID validity: The task ID is valid for 24 hours. After this period, you can no longer query the result, and the API returns the task status as
UNKNOWN. - RPS limit: The default RPS for the query API is 20. For higher-frequency queries or event notifications, we recommend that you configure asynchronous task callbacks.
- More operations: To query tasks in batches or cancel a task, see Manage Asynchronous Tasks.
Request parametersRequest headersAuthorizationstring (Required)Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.Path parameterstask_idstring (Required)The ID of the task. |
Replace {task_id} with the task_id value returned by the previous API call. The task_id is valid for queries for 24 hours. Replace {WorkspaceId} with your actual workspace ID. |
Response parametersoutputobjectThe task output information.
Properties task_id stringThe task ID. Valid for queries for 24 hours.task_status stringThe status of the task.
Enumeration values
stringThe time when the task was submitted. Format: YYYY-MM-DD HH:mm:ss.SSS.scheduled_time stringThe time when the task started running. Format: YYYY-MM-DD HH:mm:ss.SSS.end_time stringThe time when the task was completed. Format: YYYY-MM-DD HH:mm:ss.SSS.results arrayThe list of segmentation results. Returned only when task_status is SUCCEEDED. Each URL is a signed temporary link that is valid for 2 hours. Please download it promptly.
Properties seg_model_url stringThe URL of the segmented 3D model.mask_url stringThe URL of the 2D segmentation mask image.prompt stringThe names of the identified parts, separated by commas.model_task_id stringThe ID of the internal 3D model subtask. When seg_type is image, it is an image-to-3D subtask. When seg_type is model, it is a model import subtask. It can be used as the original_model_task_id of models such as Tripo-Texturing, Tripo-Retopology, and Tripo-Auto Rigging under the same account.seg_task_id stringThe ID of the internal mesh segmentation subtask. It can be used as the original_model_task_id of Tripo-Mesh Completion under the same account, or used together with part_names in Tripo-Texturing and Tripo-Retopology.stringError code. Returned only for failed requests. See Error codes.message stringDetailed error message. Returned only for failed requests. See Error codes.objectThe output statistics. Returned only when the task succeeds.
Properties 3d_task_type stringThe task type. Fixed to smart-segmentation for smart segmentation.credits_consumed integerThe credits consumed by the task, which equal seg_type.seg_type integerThe credits consumed by smart segmentation, calculated based on the input type (image or model). |
|