# tripo3d/convert

> Tripo3D Convert converts a 3D model to GLTF, FBX, USDZ, OBJ, STL or 3MF, with optional remeshing and export settings. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

## Overview

- **Endpoint**: `https://api.wavespeed.ai/api/v3/tripo3d/convert`
- **Polling/result URL**: `https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result`
- **Model ID**: `tripo3d/convert`
- **Category**: image-to-3d

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
The API is asynchronous: submit a prediction, then poll its result URL until it completes.

### Input Schema

The API accepts the following input parameters:

- **`model`** (`string`, _required_):
  The 3D model to process (GLB, GLTF, FBX, OBJ or STL, up to 150 MB).

- **`format`** (`string`, _required_):
  Target format: GLTF (web), FBX (game engines, DCC tools), USDZ (Apple AR), OBJ, STL or 3MF (3D printing).
  - Default: `"FBX"`
  - Options: "GLTF", "FBX", "USDZ", "OBJ", "STL", "3MF"

- **`quad`** (`boolean`, _optional_):
  Remesh to quads (forces FBX). Without a face_limit it targets 10,000 faces.
  - Default: `false`

- **`face_limit`** (`integer`, _optional_):
  Maximum number of faces. Omit to keep the original count.
  - Range: at least `48`

- **`texture_size`** (`integer`, _optional_):
  Diffuse texture size in pixels.
  - Default: `4096`
  - Range: `128` to `8192`

- **`texture_format`** (`string`, _optional_):
  Texture image format.
  - Default: `"JPEG"`
  - Options: "JPEG", "PNG", "WEBP"

- **`pivot_to_center_bottom`** (`boolean`, _optional_):
  Move the pivot to the bottom center.
  - Default: `false`

- **`scale_factor`** (`number`, _optional_):
  Scale factor for the exported model.
  - Default: `1`

- **`flatten_bottom`** (`boolean`, _optional_):
  Flatten the bottom of the model.
  - Default: `false`

- **`export_orientation`** (`string`, _optional_):
  Forward axis of the export.
  - Default: `"+x"`
  - Options: "+x", "-x", "+y", "-y"

- **`fbx_preset`** (`string`, _optional_):
  FBX compatibility preset.
  - Default: `"blender"`
  - Options: "blender", "3dsmax", "mixamo", "bake_scale"

- **`bake`** (`boolean`, _optional_):
  Bake advanced materials into base textures.
  - Default: `true`

- **`with_animation`** (`boolean`, _optional_):
  Keep skeleton and animation data.
  - Default: `true`

- **`animate_in_place`** (`boolean`, _optional_):
  Play animations in place, without root motion.
  - Default: `false`



**Required Parameters Example**:

```json
{
  "model": "example",
  "format": "FBX"
}
```

**Full Example**:

```json
{
  "model": "example",
  "format": "FBX",
  "quad": false,
  "face_limit": 48,
  "texture_size": 4096,
  "texture_format": "JPEG",
  "pivot_to_center_bottom": false,
  "scale_factor": 1,
  "flatten_bottom": false,
  "export_orientation": "+x",
  "fbx_preset": "blender",
  "bake": true,
  "with_animation": true,
  "animate_in_place": false
}
```

### Result Data Schema

The `data` object returned by the API has the following fields:

- **`created_at`** (`string (date-time)`, _optional_):
  ISO timestamp of when the request was created (e.g., "2023-04-01T12:34:56.789Z").

- **`id`** (`string`, _optional_):
  Unique identifier for the prediction, the ID of the prediction to get.

- **`model`** (`string`, _optional_):
  Model ID used for the prediction.

- **`outputs`** (`array of string | object`, _optional_):
  Array of generated outputs (empty when status is not completed). Items are usually URL strings, but may be text strings or structured result objects, depending on the model.

- **`status`** (`string`, _optional_):
  Status of the task: created, processing, completed, or failed.

- **`urls`** (`object`, _optional_):
  Object containing related API endpoints.



**Example `data` Object**:

```json
{
  "created_at": "example",
  "id": "example",
  "model": "example",
  "outputs": [],
  "status": "example",
  "urls": {}
}
```

## Usage Examples

The examples use `jq` to read JSON. Set your API key first:

```bash
set -euo pipefail
export WAVESPEED_API_KEY="your-api-key"
```

### 1. Submit a prediction

```bash
REQUEST_BODY=$(cat <<'JSON'
{
  "model": "example",
  "format": "FBX"
}
JSON
)

SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  --request POST \
  --url https://api.wavespeed.ai/api/v3/tripo3d/convert \
  --header "Authorization: Bearer ${WAVESPEED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data "${REQUEST_BODY}")

printf '%s\n' "${SUBMIT_RESPONSE}" | jq .
```

The response contains the prediction ID in `data.id`.

### 2. Poll until complete and read `outputs`

```bash
PREDICTION_ID=$(printf '%s' "${SUBMIT_RESPONSE}" | jq -r '.data.id')
if [ -z "${PREDICTION_ID}" ] || [ "${PREDICTION_ID}" = "null" ]; then
  printf 'Submission response did not contain data.id\n' >&2
  exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"

while true; do
  RESPONSE=$(curl --silent --show-error --fail-with-body \
    --request GET \
    --url "${RESULT_URL}" \
    --header "Authorization: Bearer ${WAVESPEED_API_KEY}")

  RESULT=$(printf '%s' "${RESPONSE}" | jq -e '.data')
  STATUS=$(printf '%s' "${RESULT}" | jq -er '.status')
  case "${STATUS}" in
    completed)
      # Generated files are returned in the outputs array.
      printf '%s\n' "${RESULT}" | jq '.outputs'
      break
      ;;
    failed|cancelled|timeout|deleted)
      printf '%s\n' "${RESULT}" | jq '{status, error, code}'
      exit 1
      ;;
    *)
      sleep 2
      ;;
  esac
done
```

## Additional Resources

### Documentation

- [Model Playground](https://wavespeed.ai/models/tripo3d/convert)
- [API Documentation](https://wavespeed.ai/docs/docs-api/tripo3d/tripo3d-convert)