Generates a 3D Gaussian Splat file in the .splat format from a single image. Gaussian Splatting is a new 3D representation designed for high-quality real-time rendering and photorealistic scene reconstruction. The output .splat file can be loaded by mainstream Gaussian Splat viewers and renderers.
Use this API for real-time rendering or photorealistic scene reconstruction. If you need meshes, textures, or editable 3D assets, use Tripo-Text/Image to 3D.
The API uses asynchronous calls. The process involves two steps: create a task and then poll for the result.
China (Beijing):
China (Beijing):
If the model call fails and returns an error message, see Error messages for solutions.
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-ImageToSplat.input object (Required)The model input.
Properties image string (Required)The source image used to generate the Gaussian Splat. Pass a publicly accessible image URL.Image limits:
object (Optional)The generation parameters.
Properties model_seed integer (Optional)The random seed. Valid range: -2147483648 to 2147483647.The same seed and the same input produce an identical .splat result. If not set, a random seed is used each time. |
|
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: 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 generation results. Returned only when task_status is SUCCEEDED.
Properties model_url stringThe URL of the Gaussian Splat file (.splat format). The URL is a signed temporary link that is valid for 2 hours. Please download it promptly.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 image-to-splat for Image to Gaussian Splat.credits_consumed integerThe credits consumed by the task. Image to Gaussian Splat is billed per task and has no additional billable parameters. |
|