# Meshy 7 API

Полный справочник API моделей генерации 3D-объектов Meshy 7.

## Варианты моделей

| Модель                      | Описание                                        |
| -------------------------- | -------------------------------------------------- |
| `meshy-v7-text-to-3d`      | Генерация 3D-модели по текстовому описанию        |
| `meshy-v7-image-to-3d`     | Генерация 3D-модели по одному изображению            |
| `meshy-v7-multiview-to-3d` | Генерация 3D-модели по нескольким референсным изображениям |

## Конечные точки

```text
POST /api/v1/3d/task
GET /api/v1/3d/{task_id}
```

## Meshy 7: 3D-модель по тексту

### Обязательные параметры

| Параметр    | Тип   | Описание                                  |
| ------------ | ------ | -------------------------------------------- |
| `model_name` | string | Должно быть `meshy-v7-text-to-3d`                |
| `prompt`     | string | Текстовое описание 3D-модели для генерации. 1–600 символов |

### Необязательные параметры

| Параметр          | Тип    | Описание                                                            |
| ------------------ | ------- | ---------------------------------------------------------------------- |
| `topology`         | string  | Топология после перестроения сетки: `triangle` или `quad`. По умолчанию: `triangle` |
| `target_polycount` | integer | Целевое количество полигонов после перестроения сетки. Диапазон: 100–300000. По умолчанию: 30000                                   |
| `remesh`           | boolean | Нужно ли заново генерировать сетку. По умолчанию: `true`                     |
| `symmetry_mode`    | string  | Режим симметрии: `off`, `auto` или `on`. По умолчанию: `auto`              |
| `pose_mode`        | string  | Поза человекоподобной модели: `a-pose` или `t-pose`. По умолчанию поза не задана                                    |
| `pbr`              | boolean | Нужно ли генерировать текстуры материалов PBR. По умолчанию: `false`         |
| `texture_prompt`   | string  | Текстовое описание, задающее направление генерации текстур. Не более 600 символов                      |
| `texture_image`    | string  | URL референсного изображения для управления генерацией текстур                   |
| `seed`             | integer | Начальное значение генератора случайных чисел. По умолчанию: `-1`, что даёт случайный результат         |

### Пример запроса

```javascript
const response = await fetch('https://api.flaq.ai/api/v1/3d/task', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model_name: 'meshy-v7-text-to-3d',
    prompt: 'A stylized red panda explorer wearing a small canvas backpack',
    topology: 'quad',
    remesh: true,
    symmetry_mode: 'auto',
    pose_mode: 'a-pose',
    pbr: true,
    texture_prompt: 'Hand-painted fur and weathered canvas with warm autumn colors',
    texture_image: 'https://example.com/red-panda-texture.png',
  }),
});

const { data } = await response.json();
const taskId = data.task_id;
```

## Meshy 7: 3D-модель по изображению

### Обязательные параметры

| Параметр    | Тип   | Описание                                |
| ------------ | ------ | ------------------------------------------ |
| `model_name` | string | Должно быть `meshy-v7-image-to-3d`             |
| `image_url`  | string | Общедоступный URL входного изображения |

### Необязательные параметры

| Параметр          | Тип    | Описание                                                            |
| ------------------ | ------- | ---------------------------------------------------------------------- |
| `topology`         | string  | Топология после перестроения сетки: `triangle` или `quad`. По умолчанию: `triangle` |
| `target_polycount` | integer | Целевое количество полигонов после перестроения сетки. Диапазон: 100–300000. По умолчанию: 30000                                   |
| `remesh`           | boolean | Нужно ли заново генерировать сетку. По умолчанию: `true`                     |
| `symmetry_mode`    | string  | Режим симметрии: `off`, `auto` или `on`. По умолчанию: `auto`              |
| `pose_mode`        | string  | Поза человекоподобной модели: `a-pose` или `t-pose`. По умолчанию: `a-pose`              |
| `pbr`              | boolean | Нужно ли генерировать текстуры материалов PBR. По умолчанию: `false`         |
| `texture_prompt`   | string  | Текстовое описание, задающее направление генерации текстур. Не более 600 символов                      |
| `texture_image`    | string  | URL референсного изображения для управления генерацией текстур                   |

### Пример запроса

```javascript
const response = await fetch('https://api.flaq.ai/api/v1/3d/task', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model_name: 'meshy-v7-image-to-3d',
    image_url: 'https://example.com/ceramic-lamp.png',
    topology: 'triangle',
    remesh: true,
    symmetry_mode: 'auto',
    pose_mode: 'a-pose',
    pbr: true,
    texture_prompt: 'Glazed blue ceramic with subtle gold details',
    texture_image: 'https://example.com/ceramic-reference.png',
  }),
});

const { data } = await response.json();
const taskId = data.task_id;
```

## Meshy 7: 3D-модель по нескольким ракурсам

### Обязательные параметры

| Параметр    | Тип     | Описание                                      |
| ------------ | -------- | ------------------------------------------------ |
| `model_name` | string   | Должно быть `meshy-v7-multiview-to-3d`               |
| `images`     | string[] | От 1 до 4 URL референсных изображений. Порядок ракурсов не имеет значения |

### Необязательные параметры

| Параметр          | Тип    | Описание                                                            |
| ------------------ | ------- | ---------------------------------------------------------------------- |
| `topology`         | string  | Топология после перестроения сетки: `triangle` или `quad`. По умолчанию: `triangle` |
| `target_polycount` | integer | Целевое количество полигонов после перестроения сетки. Диапазон: 100–300000. По умолчанию: 30000                                   |
| `remesh`           | boolean | Нужно ли заново генерировать сетку. По умолчанию: `true`                     |
| `symmetry_mode`    | string  | Режим симметрии: `off`, `auto` или `on`. По умолчанию: `auto`              |
| `pose_mode`        | string  | Поза человекоподобной модели: `a-pose` или `t-pose`. По умолчанию поза не задана                                    |
| `pbr`              | boolean | Нужно ли генерировать текстуры материалов PBR. По умолчанию: `false`         |
| `texture_prompt`   | string  | Текстовое описание, задающее направление генерации текстур. Не более 600 символов                      |
| `texture_image`    | string  | URL референсного изображения для управления генерацией текстур                   |

### Пример запроса

```javascript
const response = await fetch('https://api.flaq.ai/api/v1/3d/task', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model_name: 'meshy-v7-multiview-to-3d',
    images: [
      'https://example.com/chair-front.png',
      'https://example.com/chair-side.png',
      'https://example.com/chair-back.png',
    ],
    topology: 'quad',
    remesh: true,
    symmetry_mode: 'auto',
    pbr: true,
    texture_prompt: 'Natural walnut wood and woven cream fabric',
    texture_image: 'https://example.com/chair-material-reference.png',
  }),
});

const { data } = await response.json();
const taskId = data.task_id;
```

## Формат ответа

### Отправка задачи

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "task_id": "{task_id}",
    "response_url": "https://api.flaq.ai/api/v1/3d/{task_id}",
    "task_status": "submitted"
  }
}
```

### Проверка статуса задачи

```javascript
const response = await fetch('https://api.flaq.ai/api/v1/3d/{task_id}', {
  headers: { Authorization: 'Bearer YOUR_API_KEY' },
});

const { data } = await response.json();
console.log(data.task_status);
```

### Завершённая задача

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "task_id": "{task_id}",
    "response_url": "https://api.flaq.ai/api/v1/3d/{task_id}",
    "task_status": "succeed",
    "task_status_msg": null,
    "task_result": {
      "credit": 0.2,
      "files": [{ "url": "https://example.com/generated-model.glb" }]
    }
  }
}
```

### Значения статуса задачи

- `submitted`: Задача отправлена.
- `processing`: Задача обрабатывается.
- `succeed`: Задача успешно завершена.
- `failed`: Задача завершилась с ошибкой.