# Tripo API の紹介

Tripo3D は、テキストから 3D、画像から 3D、リギング、メッシュ編集などの機能を提供する、AI- 搭載の 3D 生成プラットフォームです。 Tripo API を使用すると、開発者は高品質の 3D コンテンツ生成を自社の製品に統合できます。

> 中国からアクセスしている場合は、中国サイト [developers.tripo3d.com](https://developers.tripo3d.com) にアクセスしてください。

## ベース URL

```baseurl
https://openapi.tripo3d.ai/v3
```

## 認証

すべての API リクエストには、リクエスト ヘッダーに API Key が含まれている必要があります。

```apikey
Authorization: Bearer {api_key}
```

API Keys は [Tripo コンソール](/en/keys) で作成および管理できます。

## 統一された応答フォーマット

### 成功の応答

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

### エラー応答

```json
{
  "code": 2010,
  "message": "Insufficient credits",
  "suggestion": "Please top up your account"
}
```

### 共通フィールド

| パラメータ | 種類 | 説明 |
| :-: | :-: | :-: |
| code | 整数 | ステータスコード。 `0` は成功を示し、`0` 以外の値はエラーを示します |
| data | オブジェクト | ビジネス データ。成功した場合にのみ返されます。 |
| message | 文字列 | エラーの説明。失敗した場合にのみ返されます。 |
| suggestion | 文字列 | 提案された修正。失敗した場合にのみ返されます |

## 非同期タスクのパターン

ほとんどの世代の API は、非同期タスク パターンを使用します。

1. **タスクの作成** - POST リクエストを送信してタスクを作成し、`task_id` を受信します
2. **結果のポーリング** - `GET /v3/tasks/{task_id}` を使用してタスクのステータスと結果をクエリします

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

### タスクのステータス

| ステータス | 説明 |
| :-: | :-: |
| `queued` | キューに入れられました |
| `running` | ランニング |
| `success` | 成功しました |
| `failed` | 失敗しました |
| `cancelled` | キャンセルされました |

## API バージョン

現在のバージョン: **v3**

## エンドポイントの概要

### 3Dモデルの生成

| エンドポイント | 説明 |
| :-: | :-: |
| [`POST /v3/generation/text-to-model`](/en/docs/generation-text-to-model) | テキストから 3D モデルを生成する |
| [`POST /v3/generation/image-to-model`](/en/docs/generation-image-to-model) | 画像から3Dモデルを生成する |
| [`POST /v3/generation/multiview-to-model`](/en/docs/generation-multiview-to-model) | 多視点画像から3Dモデルを生成 |

### 画像生成

| エンドポイント | 説明 |
| :-: | :-: |
| [`POST /v3/generation/text-to-image`](/en/docs/generation-text-to-image) | テキストから画像を生成する |
| [`POST /v3/generation/image-to-image`](/en/docs/generation-image-to-image) | 画像スタイルを変換する |
| [`POST /v3/generation/image-to-multiview`](/en/docs/generation-image-to-multiview) | マルチビュー画像の生成 |
| [`POST /v3/generation/edit-multiview`](/en/docs/generation-edit-multiview) | マルチビュー画像の編集 |

### モデル処理

| エンドポイント | 説明 |
| :-: | :-: |
| [`POST /v3/models/texture`](/en/docs/models-texture) | モデルにテクスチャを付ける |
| [`POST /v3/models/convert`](/en/docs/models-convert) | モデル形式の変換 |
| [`POST /v3/mesh/segment`](/en/docs/mesh-segment) | セマンティックセグメンテーション |
| [`POST /v3/mesh/complete`](/en/docs/mesh-complete) | メッシュの完成 |
| [`POST /v3/mesh/decimate`](/en/docs/mesh-decimate) | リトポロジー |

### アニメーション

| エンドポイント | 説明 |
| :-: | :-: |
| [`POST /v3/animations/rig-check`](/en/docs/animations-rig-check) | リギングの互換性を確認する |
| [`POST /v3/animations/rig`](/en/docs/animations-rig) | モデルをリグする |
| [`POST /v3/animations/retarget`](/en/docs/animations-retarget) | アニメーションのターゲットを変更する |

### タスク管理

| エンドポイント | 説明 |
| :-: | :-: |
| [`GET /v3/tasks/{task_id}`](/en/docs/task-query) | タスクをクエリする |
| [`POST /v3/tasks/list`](/en/docs/task-batch-query) | タスクをバッチでクエリする |

### ファイル管理

| エンドポイント | 説明 |
| :-: | :-: |
| [`POST /v3/files`](/en/docs/files) | ファイルをアップロードする |

### アカウント

| エンドポイント | 説明 |
| :-: | :-: |
| [`GET /v3/account/balance`](/en/docs/account) | アカウント残高の照会 |