### Balance Response Example

Source: https://developers.tripo3d.ai/en/docs/account

Example JSON response for the account balance endpoint, showing available and frozen credits.

```json
{
  "code": 0,
  "data": {
    "balance": 10000,
    "frozen": 200
  }
}
```

--------------------------------

### Usage Response Example

Source: https://developers.tripo3d.ai/en/docs/account

Example JSON response for the account usage endpoint, detailing task consumption history.

```json
{
  "code": 0,
  "data": [
    {
      "task_id": "task_abc123",
      "type": "text_to_model",
      "credits_consumed": 100,
      "created_at": "2025-01-01T00:00:00Z"
    }
  ]
}
```

--------------------------------

### balance.low Event Example

Source: https://developers.tripo3d.ai/en/docs/webhooks

This is an example of the JSON payload received when the account balance drops below a certain threshold.

```APIDOC
## Event: balance.low

### Description
This event is triggered when your account balance falls below a predefined threshold, indicating a need for replenishment.

### Data Structure
```json
{
  "id": "evt_balance_low:balance.low",
  "type": "balance.low",
  "created_at": "2026-05-06T12:00:00Z",
  "data": {
    "balance": 1200,
    "threshold": 5000
  }
}
```
```

--------------------------------

### Task Result Response Example

Source: https://developers.tripo3d.ai/en/docs/animations-rig-check

Example response showing the result of a completed Riggability Check task.

```json
{
  "code": 0,
  "data": {
    "task_id": "task_def456",
    "status": "success",
    "output": {
      "riggable": true,
      "rig_type": "biped"
    },
    "credits_consumed": 0
  }
}
```

--------------------------------

### Webhook Signature Header Example

Source: https://developers.tripo3d.ai/en/docs/webhooks

Example of the Tripo-Webhook-Signature header format, containing the timestamp and signature.

```http
Tripo-Webhook-Signature: t=1714992000,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8f9
```

--------------------------------

### P Series Request Body Example

Source: https://developers.tripo3d.ai/en/docs/generation-text-to-model/p

Example JSON payload for generating a 3D model from a text prompt using the P Series. Includes prompt, model version, face limit, and texture/PBR settings.

```json
{
  "prompt": "A cat wearing a spacesuit",
  "model": "P1-20260311",
  "face_limit": 3000,
  "texture": true,
  "pbr": true
}
```

--------------------------------

### task.completed Event Example

Source: https://developers.tripo3d.ai/en/docs/webhooks

This is an example of the JSON payload received when a task is successfully completed.

```APIDOC
## Event: task.completed

### Description
This event is triggered when a task, such as model generation, has finished successfully.

### Data Structure
```json
{
  "id": "task_abc123:task.completed",
  "type": "task.completed",
  "created_at": "2026-05-06T12:00:00Z",
  "data": {
    "task_id": "task_abc123",
    "type": "text_to_model",
    "status": "success",
    "output": {
      "model_url": "https://cdn.tripo3d.ai/output/model_pbr.glb"
    }
  }
}
```
```

--------------------------------

### Task Result Response Example

Source: https://developers.tripo3d.ai/en/docs/animations-rig

Example response when querying the status of an auto-rigging task. Shows success status and the output model URL.

```json
{
  "code": 0,
  "data": {
    "task_id": "task_def456",
    "status": "success",
    "output": {
      "model_url": "https://cdn.tripo3d.ai/output/rigged.glb"
    },
    "credits_consumed": 30
  }
}
```

--------------------------------

### Riggability Check Request Body Example

Source: https://developers.tripo3d.ai/en/docs/animations-rig-check

Example of a request body for the Riggability Check endpoint using a task ID.

```json
{
  "input": "task_abc123"
}
```

--------------------------------

### Asynchronous Task Pattern Example

Source: https://developers.tripo3d.ai/en/docs

Illustrates the asynchronous task pattern: creating a task, polling for status, and retrieving results.

```text
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": {...}}}
```

--------------------------------

### Auto Rig Request Body Example

Source: https://developers.tripo3d.ai/en/docs/animations-rig

Example JSON request body for the Auto Rig API. Specify input, rigging model version, rig type, specification, and output format.

```json
{
  "input": "task_abc123",
  "model": "v2.5-20260210",
  "rig_type": "biped",
  "spec": "mixamo",
  "out_format": "glb"
}
```

--------------------------------

### Model Generation with Texture Prompt

Source: https://developers.tripo3d.ai/en/docs/models-texture

Example JSON payload for generating a model with a specific texture prompt, detailing the desired texture appearance.

```json
{
  "input": "task_abc123",
  "model": "v3.0-20250812",
  "texture_prompt": {
    "text": "worn leather with scratches"},
  "texture_quality": "detailed"}
```

--------------------------------

### Riggability Check cURL Request

Source: https://developers.tripo3d.ai/en/docs/animations-rig-check

Example cURL command to perform a Riggability Check using the API.

```curl
curl --request POST \
  --url https://openapi.tripo3d.ai/v3/animations/rig-check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ \
  "input": "task_abc123"
}'
```

--------------------------------

### cURL Request for Texture Generation

Source: https://developers.tripo3d.ai/en/docs/models-texture

Example cURL command to initiate texture generation for a model, specifying model version and quality.

```curl
curl --request POST \
  --url https://openapi.tripo3d.ai/v3/models/texture \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ \
  "input": "task_abc123", \
  "model": "v2.5-20250123", \
  "texture_quality": "detailed", \
  "pbr": true \
}'
```

--------------------------------

### Basic Model Generation (v2.5)

Source: https://developers.tripo3d.ai/en/docs/models-texture

Example JSON payload for generating a model using the v2.5 model with detailed texture quality and PBR enabled.

```json
{
  "input": "task_abc123",
  "model": "v2.5-20250123",
  "texture_quality": "detailed",
  "pbr": true
}
```

--------------------------------

### Model Generation (v3.x)

Source: https://developers.tripo3d.ai/en/docs/models-texture

Example JSON payload for generating a model using a v3.x model with detailed texture quality and PBR enabled.

```json
{
  "input": "task_abc123",
  "model": "v3.0-20250812",
  "texture_quality": "detailed",
  "pbr": true
}
```

--------------------------------

### v2.0 Smart Retopology Request

Source: https://developers.tripo3d.ai/en/docs/mesh-decimate

Example of a request body for the v2.0 Smart Retopology algorithm. This mode preserves topology and details.

```json
{
  "input": "task_abc123",
  "model": "v2.0",
  "face_limit": 5000,
  "quad": false,
  "bake": true
}
```

--------------------------------

### Webhook Signature Header

Source: https://developers.tripo3d.ai/en/docs/webhooks

Example of the `Tripo-Webhook-Signature` header used for verifying webhook requests.

```APIDOC
## Webhook Signature Header

### Description
This header is included in all webhook requests sent by Tripo3D. It contains a timestamp and a signature that can be used to verify the request's authenticity.

### Header Format
`Tripo-Webhook-Signature: t=<timestamp>,v1=<signature>`

### Example
```
Tripo-Webhook-Signature: t=1714992000,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8f9
```
```

--------------------------------

### Basic Image to Multiview Request

Source: https://developers.tripo3d.ai/en/docs/generation-image-to-multiview

A basic example of a request body to generate multiview images from a provided image URL.

```json
{
  "input": "https://example.com/character.png"
}
```

--------------------------------

### Convert Model to GLTF

Source: https://developers.tripo3d.ai/en/docs/models-convert

Example request body for converting a model to GLTF format. Includes texture size and enables texture baking.

```json
{
  "input": "task_abc123",
  "format": "GLTF",
  "texture_size": 4096,
  "bake": true
}
```

--------------------------------

### Task Result Response

Source: https://developers.tripo3d.ai/en/docs/generation-image-to-image

Example JSON response detailing the status and output of a completed image generation task.

```json
{
  "code": 0,
  "data": {
    "task_id": "task_abc123",
    "type": "generate_image",
    "status": "success",
    "progress": 100,
    "output": {
      "generated_image": "https://cdn.tripo3d.ai/output/image.png",
      "size": "2048x2048"},
    "credits_consumed": 20,
    "created_at": "2026-04-28T12:00:00Z",
    "completed_at": "2026-04-28T12:00:08Z"
  }
}
```

--------------------------------

### Text to Image Request with banana_pro

Source: https://developers.tripo3d.ai/en/docs/generation-text-to-image

Example JSON payload for generating an image using the banana_pro model. Demonstrates specifying a custom size in pixels.

```json
{
  "prompt": "A cinematic product render of a glass sneaker on a dark stage.",
  "model": "banana_pro",
  "size": "1536x1024",
  "output_format": "png"}
```

--------------------------------

### Create Task Response Example

Source: https://developers.tripo3d.ai/en/docs/generation-edit-multiview

This JSON object represents a successful response from a task creation, including the unique task ID.

```json
{
  "code": 0,
  "data": {
    "task_id": "task_abc123"}
}
```

--------------------------------

### Multiview to 3D Model cURL Request

Source: https://developers.tripo3d.ai/en/docs/generation-multiview-to-model

Example cURL command to send a multiview-to-model generation request with image URLs.

```curl
curl --request POST \
  --url https://openapi.tripo3d.ai/v3/generation/multiview-to-model \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ \
  "inputs": [ \
    { "front": "https://example.com/front.png"}, \
    { "back": "https://example.com/back.png"}, \
    { "right": "https://example.com/right.png"} \
  ], \
  "model": "v3.1-20260211", \
  "texture": false, \
  "geometry_quality": "detailed"}'
```

--------------------------------

### Convert Model to FBX

Source: https://developers.tripo3d.ai/en/docs/models-convert

Example request body for converting a model to FBX format. Specifies texture size, format, pivot settings, and FBX preset.

```json
{
  "input": "task_abc123",
  "format": "FBX",
  "texture_size": 2048,
  "texture_format": "PNG",
  "pivot_to_center_bottom": true,
  "fbx_preset": "blender"
}
```

--------------------------------

### Image to Multiview cURL Request

Source: https://developers.tripo3d.ai/en/docs/generation-image-to-multiview

Example of how to make an Image to Multiview request using cURL, including the API endpoint, authorization token, and request body.

```curl
curl --request POST \
  --url https://openapi.tripo3d.ai/v3/generation/image-to-multiview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ \
  "input": "https://example.com/character.png"}'
```

--------------------------------

### task.failed Event Example

Source: https://developers.tripo3d.ai/en/docs/webhooks

This is an example of the JSON payload received when a task fails during execution.

```APIDOC
## Event: task.failed

### Description
This event is triggered when a task, such as model generation, encounters an error and fails to complete.

### Data Structure
```json
{
  "id": "task_abc123:task.failed",
  "type": "task.failed",
  "created_at": "2026-05-06T12:00:05Z",
  "data": {
    "task_id": "task_abc123",
    "type": "text_to_model",
    "status": "failed",
    "error": {
      "code": "task_failed",
      "message": "Generation failed"
    }
  }
}
```
```

--------------------------------

### Text to 3D Generation Request Setup

Source: https://developers.tripo3d.ai/en

Sets up the URL, headers, and payload for a text-to-3D generation request using the Tripo API. This snippet is for setting up the request parameters.

```python
import requests

url = "https://openapi.tripo3d.ai/v3/generation/text-to-model"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer {api_key}"
}
payload = {
    "prompt": "A cat wearing a spacesuit",
    "model": "v3.1-20260211",
    "texture": True,
    "pbr": True,
    "texture_quality": "detailed"
}
```

--------------------------------

### Basic Text-to-Model Request

Source: https://developers.tripo3d.ai/en/docs/generation-text-to-model

Use this snippet to generate a 3D model with basic texture and PBR settings.

```json
{
  "prompt": "A cat wearing a spacesuit",
  "model": "v3.1-20260211",
  "texture": true,
  "pbr": true,
  "texture_quality": "detailed"
}
```

--------------------------------

### Multiview to 3D Model - View-key with file_tokens

Source: https://developers.tripo3d.ai/en/docs/generation-multiview-to-model/standard

Generates a 3D model using file tokens for input images. This is an alternative to using direct URLs.

```APIDOC
## POST /v3/generation/multiview-to-model

### Description
Generates a 3D model using file tokens as input for the images.

### Method
POST

### Endpoint
/v3/generation/multiview-to-model

### Parameters
#### Request Body
- **inputs** (array) - Required - An array of objects, where each object specifies an input image with a key (e.g., "front", "back", "right") and its corresponding file token.
- **model** (string) - Required - The model version to use (e.g., "v3.1-20260211").
- **texture** (boolean) - Optional - Whether to generate textures for the model.
- **geometry_quality** (string) - Optional - The desired quality of the generated geometry (e.g., "detailed").

### Request Example
```json
{
  "inputs": [
    {
      "front": "3154b4b0-4647-4032-aa82-827441ae92ef"},
    {
      "back": "58ea3eab-6a08-4deb-98f9-e60f1802954d"},
    {
      "right": "584b0e07-8576-4eb4-bf49-2e149e0252f6"}
  ],
  "model": "v3.1-20260211",
  "texture": false,
  "geometry_quality": "detailed"
}
```

### Response
#### Success Response (200)
- **code** (integer) - Indicates the success of the operation.
- **data** (object) - Contains task information.
  - **task_id** (string) - The ID of the generated task.

#### Response Example
```json
{
  "code": 0,
  "data": {
    "task_id": "task_abc123"
  }
}
```
```

--------------------------------

### Single Animation Retargeting Request

Source: https://developers.tripo3d.ai/en/docs/animations-retarget

Example JSON payload for retargeting a single animation.

```json
{
  "input": "task_abc123",
  "animation": "preset:walk",
  "out_format": "glb",
  "bake_animation": true
}
```

--------------------------------

### Batch Animation Retargeting Request

Source: https://developers.tripo3d.ai/en/docs/animations-retarget

Example JSON payload for retargeting multiple animations in a batch.

```json
{
  "input": "task_abc123",
  "animations": [
    "preset:idle",
    "preset:walk",
    "preset:run"],
  "out_format": "fbx"}
```

--------------------------------

### cURL Request for Animation Retargeting

Source: https://developers.tripo3d.ai/en/docs/animations-retarget

Example cURL command to perform single or batch animation retargeting.

```curl
curl --request POST \
  --url https://openapi.tripo3d.ai/v3/animations/retarget \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ \
  "input": "task_abc123", \
  "animation": "preset:walk", \
  "out_format": "glb", \
  "bake_animation": true \
}'
```

--------------------------------

### GET /v3/account/balance

Source: https://developers.tripo3d.ai/en/docs

Queries the current account balance. This endpoint provides information about available credits or usage.

```APIDOC
## GET /v3/account/balance

### Description
Queries the current account balance. This endpoint provides information about available credits or usage.

### Method
GET

### Endpoint
/v3/account/balance

### Response
#### Success Response (200)
(Schema not provided in source)
```json
{
  "code": 0,
  "data": {
    ...
  }
}
```
```

--------------------------------

### Low Balance Webhook Example

Source: https://developers.tripo3d.ai/en/docs/webhooks

This JSON object represents a webhook payload indicating a low balance alert.

```json
{
  "id": "evt_balance_low:balance.low",
  "type": "balance.low",
  "created_at": "2026-05-06T12:00:00Z",
  "data": {
    "balance": 1200,
    "threshold": 5000
  }
}
```

--------------------------------

### Multiview to 3D Model - View-key with URLs

Source: https://developers.tripo3d.ai/en/docs/generation-multiview-to-model/standard

Generates a 3D model using URLs for input images. The input images can be specified with keys like 'front', 'back', and 'right'.

```APIDOC
## POST /v3/generation/multiview-to-model

### Description
Generates a 3D model from multiple input images provided via URLs.

### Method
POST

### Endpoint
/v3/generation/multiview-to-model

### Parameters
#### Request Body
- **inputs** (array) - Required - An array of objects, where each object specifies an input image with a key (e.g., "front", "back", "right") and its corresponding URL.
- **model** (string) - Required - The model version to use (e.g., "v3.1-20260211").
- **texture** (boolean) - Optional - Whether to generate textures for the model.
- **geometry_quality** (string) - Optional - The desired quality of the generated geometry (e.g., "detailed").

### Request Example
```json
{
  "inputs": [
    {
      "front": "https://example.com/front.png"},
    {
      "back": "https://example.com/back.png"},
    {
      "right": "https://example.com/right.png"}
  ],
  "model": "v3.1-20260211",
  "texture": false,
  "geometry_quality": "detailed"
}
```

### Response
#### Success Response (200)
- **code** (integer) - Indicates the success of the operation.
- **data** (object) - Contains task information.
  - **task_id** (string) - The ID of the generated task.

#### Response Example
```json
{
  "code": 0,
  "data": {
    "task_id": "task_abc123"
  }
}
```
```

--------------------------------

### Get Account Usage

Source: https://developers.tripo3d.ai/en/docs/account

Query account balance and usage details. Usage returns per-task consumption history.

```APIDOC
## GET /v3/account/usage

### Description
Query account balance and usage details. Usage returns per-task consumption history.

### Method
GET

### Endpoint
/v3/account/usage

### Parameters
#### Query Parameters
This endpoint does not have query parameters.

#### Request Body
This endpoint does not have a request body.

### Request Example
```
curl -s \
  -H "Authorization: Bearer YOUR_API_KEY" \
  https://openapi.tripo3d.ai/v3/account/usage
```

### Response
#### Success Response (200)
- **task_id** (string) - Description of the task.
- **type** (string) - Type of the task.
- **credits_consumed** (integer) - Credits consumed by the task.
- **created_at** (string) - Timestamp when the task was created.

#### Response Example
```json
{
  "code": 0,
  "data": [
    {
      "task_id": "task_abc123",
      "type": "text_to_model",
      "credits_consumed": 100,
      "created_at": "2025-01-01T00:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Get Account Balance

Source: https://developers.tripo3d.ai/en/docs/account

Query account balance and usage details. Balance returns available and frozen credits.

```APIDOC
## GET /v3/account/balance

### Description
Query account balance and usage details. Balance returns available and frozen credits.

### Method
GET

### Endpoint
/v3/account/balance

### Parameters
#### Query Parameters
This endpoint does not have query parameters.

#### Request Body
This endpoint does not have a request body.

### Request Example
```
curl -s \
  -H "Authorization: Bearer YOUR_API_KEY" \
  https://openapi.tripo3d.ai/v3/account/balance
```

### Response
#### Success Response (200)
- **balance** (integer) - Required - Available credit balance.
- **frozen** (integer) - Required - Frozen credits reserved for in-progress tasks.

#### Response Example
```json
{
  "code": 0,
  "data": {
    "balance": 10000,
    "frozen": 200
  }
}
```
```

--------------------------------

### Task Failed Webhook Example

Source: https://developers.tripo3d.ai/en/docs/webhooks

This JSON object represents a webhook payload for a failed task, including error details.

```json
{
  "id": "task_abc123:task.failed",
  "type": "task.failed",
  "created_at": "2026-05-06T12:00:05Z",
  "data": {
    "task_id": "task_abc123",
    "type": "text_to_model",
    "status": "failed",
    "error": {
      "code": "task_failed",
      "message": "Generation failed"
    }
  }
}
```

--------------------------------

### cURL Request for v2.0 Smart Retopology

Source: https://developers.tripo3d.ai/en/docs/mesh-decimate

Example cURL command to send a POST request for v2.0 Smart Retopology. Ensure to replace <token> with your actual API key.

```bash
curl --request POST \
  --url https://openapi.tripo3d.ai/v3/mesh/decimate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ \
  "input": "task_abc123", \
  "model": "v2.0", \
  "face_limit": 5000, \
  "quad": false, \
  "bake": true \
}'
```

--------------------------------

### Task Completed Webhook Example

Source: https://developers.tripo3d.ai/en/docs/webhooks

This JSON object represents a webhook payload for a completed task, including output details.

```json
{
  "id": "task_abc123:task.completed",
  "type": "task.completed",
  "created_at": "2026-05-06T12:00:00Z",
  "data": {
    "task_id": "task_abc123",
    "type": "text_to_model",
    "status": "success",
    "output": {
      "model_url": "https://cdn.tripo3d.ai/output/model_pbr.glb"
    }
  }
}
```

--------------------------------

### Text to 3D Model - Basic

Source: https://developers.tripo3d.ai/en/docs/generation-text-to-model/standard

Generates a 3D model from a text prompt with basic settings, including texture and PBR quality.

```APIDOC
## POST /v3/generation/text-to-model

### Description
Generates a 3D model from a text prompt with basic settings, including texture and PBR quality.

### Method
POST

### Endpoint
https://openapi.tripo3d.ai/v3/generation/text-to-model

### Parameters
#### Request Body
- **prompt** (string) - Required - The text description of the model to generate.
- **model** (string) - Required - The model version to use (e.g., "v3.1-20260211").
- **texture** (boolean) - Optional - Whether to generate textures.
- **pbr** (boolean) - Optional - Whether to generate Physically Based Rendering materials.
- **texture_quality** (string) - Optional - The quality of the generated textures (e.g., "detailed").

### Request Example
{
  "prompt": "A cat wearing a spacesuit",
  "model": "v3.1-20260211",
  "texture": true,
  "pbr": true,
  "texture_quality": "detailed"
}

### Response
#### Success Response (200)
- **code** (integer) - Indicates the success of the operation.
- **data** (object) - Contains task-related information.
  - **task_id** (string) - The ID of the generated task.

#### Response Example
{
  "code": 0,
  "data": {
    "task_id": "task_abc123"
  }
}
```

--------------------------------

### Mesh Semantic Segmentation cURL Request

Source: https://developers.tripo3d.ai/en/docs/mesh-segment

Example cURL command to perform mesh semantic segmentation using the API.

```bash
curl --request POST \
  --url https://openapi.tripo3d.ai/v3/mesh/segment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ \
  "input": "task_abc123"}'
```

--------------------------------

### Batch Task Query Response Example

Source: https://developers.tripo3d.ai/en/docs/task-batch-query

This JSON object shows a successful response for a batch task query, detailing the status and progress of each requested task. It includes a map of tasks and a list of any missed task IDs.

```json
{
  "code": 0,
  "data": {
    "tasks": {
      "task_abc123": {
        "task_id": "task_abc123",
        "type": "text_to_model",
        "status": "success",
        "progress": 100,
        "credits_consumed": 100
      },
      "task_def456": {
        "task_id": "task_def456",
        "type": "image_to_model",
        "status": "running",
        "progress": 60
      }
    },
    "missed": []
  }
}
```

--------------------------------

### GET /v3/tasks/{task_id}

Source: https://developers.tripo3d.ai/en/docs

Queries the status and result of a specific task. This is used to poll for results after initiating an asynchronous operation.

```APIDOC
## GET /v3/tasks/{task_id}

### Description
Queries the status and result of a specific task. This is used to poll for results after initiating an asynchronous operation.

### Method
GET

### Endpoint
/v3/tasks/{task_id}

### Parameters
#### Path Parameters
- **task_id** (string) - Required - The ID of the task to query.

### Response
#### Success Response (200)
(Example response structure provided in source, actual data varies)
```json
{
  "code": 0,
  "data": {
    "status": "running",
    "progress": 50
  }
}
```

#### Success Response (200) - Task Completed
```json
{
  "code": 0,
  "data": {
    "status": "success",
    "output": {...}
  }
}
```
```