Швидкий старт

Чотири кроки до вашої першої 3D-моделі за допомогою Meshy REST API.

1Отримайте свій API-ключ

Створіть API-ключ на сторінці API Keys у Платформі для розробників — після цього екрана ви не зможете переглянути його знову, тому зберігайте його в надійному місці. Кожен запит автентифікується за допомогою Bearer-токена в заголовку Authorization — див. Автентифікація.

2Зробіть свій перший запит Зображення у 3D

Експортуйте свій ключ, а потім створіть своє перше завдання за допомогою Зображення у 3D. Працюєте з текстовим prompt або кількома фотографіями замість цього? Перегляньте Текст у 3D або Мульти-зображення у 3D.

export MESHY_API_KEY="<your-api-key>"

У кожному прикладі нижче використовується це фото — підставте власний image_url, щоб спробувати щось інше.

Copy image URL

curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${MESHY_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://docs.meshy.ai/images/api/quick-start/source-photo.webp"
  }'

3Перевірте статус завдання

Запити одразу повертають ID завдання. Опитуйте ту саму кінцеву точку, доки status не стане SUCCEEDED — замініть <task_id> нижче на ID, отриманий на кроці 2.

curl https://api.meshy.ai/openapi/v1/image-to-3d/<task_id> \
  -H "Authorization: Bearer ${MESHY_API_KEY}"

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "status": "SUCCEEDED",
  "progress": 100,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "task_error": {
    "message": ""
  }
}

4Завантажте свою модель

Отримайте модель з model_urls у наведеній вище відповіді. Кожен формат (GLB, FBX, OBJ, USDZ, STL) — це підписане, обмежене в часі URL-посилання — або пропустіть командний рядок і вставте URL-адресу безпосередньо в адресний рядок браузера, щоб завантажити файл.

curl -L "<model_urls.glb from the response above>" -o model.glb

Зберіть усе разом

Віддаєте перевагу одному скрипту, який робить усе одразу — створення, опитування, завантаження?

import axios from 'axios';
import fs from 'fs';

const headers = { Authorization: `Bearer ${process.env.MESHY_API_KEY}` };
const imageUrl = 'https://docs.meshy.ai/images/api/quick-start/source-photo.webp';

// 1. Create the task
const { data: created } = await axios.post(
  'https://api.meshy.ai/openapi/v1/image-to-3d',
  { image_url: imageUrl },
  { headers },
);
const taskId = created.result;

// 2. Poll until it finishes
let task;
while (true) {
  const { data, headers: resHeaders } = await axios.get(`https://api.meshy.ai/openapi/v1/image-to-3d/${taskId}`, { headers });
  task = data;
  if (task.status === 'SUCCEEDED' || task.status === 'FAILED') break;
  const waitSeconds = Number(resHeaders['retry-after']) || 5;
  await new Promise((resolve) => setTimeout(resolve, waitSeconds * 1000));
}

// 3. Download the result (only if the task succeeded)
if (task.status !== 'SUCCEEDED') {
  throw new Error(`Task ${task.status}: ${task.task_error?.message || 'unknown error'}`);
}
const { data: model } = await axios.get(task.model_urls.glb, { responseType: 'arraybuffer' });
fs.writeFileSync('model.glb', model);
console.log('Saved model.glb');

Дослідіть типові робочі процеси

Наступні кроки

• Віддаєте перевагу інтерфейсу? Відкрийте Платформу для розробників — виконуйте запити у Playground, відстежуйте використання та журнали запитів, а також керуйте webhooks.
• Перегляньте повний довідник API для кожної кінцевої точки.
• Навчайтеся на робочих прикладах: дотримуйтесь покрокових рецептів у Cookbook і читайте навчальні матеріали та історії розробки у блозі для розробників.
• Перегляньте Ціни, Обмеження швидкості та Помилки перед переходом у продакшн.
• Слідкуйте за журналом змін щодо оновлень та виправлень помилок.
• Маєте відгук або стикаєтеся з проблемами? Приєднуйтесь до нашої спільноти у Discord — ми будемо раді почути вас!