Introduction to the Tripo API

Tripo3D is an AI-powered 3D generation platform that provides text-to-3D, image-to-3D, rigging, mesh editing, and other capabilities. With the Tripo API, developers can integrate high-quality 3D content generation into their own products.

If you are accessing from China, please visit the China site: developers.tripo3d.com

Base URL

https://openapi.tripo3d.ai/v3

Authentication

All API requests must include an API Key in the request header:

Authorization: Bearer {api_key}

You can create and manage API Keys in the Tripo Console.

Unified Response Format

Success Response

JSON

{
  "code": 0,
  "data": {
    ...
  }
}

Error Response

JSON

{
  "code": 2010,
  "status": "error",
  "message": "You don't have enough credit to create this task",
  "suggestion": "Please purchase more credit",
  "request_id": "req_abc123"
}

Common Fields

Parameter	Type	Description
code	integer	Status code. `0` indicates success, and any non-`0` value indicates an error
status	string	`error` on failure
data	object	Business data, returned only on success
message	string	Error description, returned only on failure
suggestion	string	Suggested fix, returned only on failure
request_id	string	Unique request identifier for troubleshooting, returned on failure

Asynchronous Task Pattern

Most generation APIs use an asynchronous task pattern:

Create a task - Send a POST request to create a task and receive a task_id
Poll for results - Use GET /v3/tasks/{task_id} to query the task status and result

POST /v3/generation/text-to-model  ->  {"code": 0, "data": {"task_id": "task_abc123"}}
                                                |
                                                v
GET  /v3/tasks/task_abc123          ->  {"code": 0, "data": {"status": "running", "progress": 50}}
                                                |
                                                v
GET  /v3/tasks/task_abc123          ->  {"code": 0, "data": {"status": "success", "output": {...}}}

Task Statuses

Status	Description
`queued`	Queued
`running`	Running
`success`	Succeeded
`failed`	Failed
`cancelled`	Cancelled

API Version

Current version: v3

Endpoint Overview

3D Model Generation

Endpoint	Description
`POST /v3/generation/text-to-model`	Generate a 3D model from text
`POST /v3/generation/image-to-model`	Generate a 3D model from an image
`POST /v3/generation/multiview-to-model`	Generate a 3D model from multiview images

Image Generation

Endpoint	Description
`POST /v3/generation/text-to-image`	Generate an image from text
`POST /v3/generation/image-to-image`	Transform an image style
`POST /v3/generation/image-to-multiview`	Generate multiview images
`POST /v3/generation/edit-multiview`	Edit multiview images

Model Processing

Endpoint	Description
`POST /v3/models/texture`	Texture a model
`POST /v3/models/convert`	Convert model format
`POST /v3/mesh/segment`	Semantic segmentation
`POST /v3/mesh/complete`	Mesh completion
`POST /v3/mesh/decimate`	Retopology

Animation

Endpoint	Description
`POST /v3/animations/rig-check`	Check rigging compatibility
`POST /v3/animations/rig`	Rig a model
`POST /v3/animations/retarget`	Retarget an animation

Task Management

Endpoint	Description
`GET /v3/tasks/{task_id}`	Query a task
`POST /v3/tasks/list`	Query tasks in batch

File Management

Endpoint	Description
`POST /v3/files`	Upload a file

Account

Endpoint	Description
`GET /v3/account/balance`	Query account balance