# Знакомство с Tripo API

Tripo3D — это платформа для создания 3D-изображений на базе AI-, которая обеспечивает преобразование текста в 3D, изображения в 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) | Запрос баланса счета |