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

Почніть з створення вашого API-ключа

Кожен запит у цьому посібнику потребує його. Створення ключа займає менше хвилини.

Створити ваш API-ключ

Чотири кроки до вашої першої 3D моделі, використовуючи Meshy REST API.


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

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

Відкрийте налаштування API з меню API, потім створіть ваш ключ


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

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

Експортуйте ваш ключ

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

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

Зразок ілюстрації фантастичного персонажа, використаний як вхідні дані Зображення у 3D у цьому посібнику
Зразок вхідних даних

Запит

POST
/openapi/v1/image-to-3d
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.cn/images/api/quick-start/source-photo.webp"
  }'

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

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

Запит

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

Відповідь — SUCCEEDED

{
  "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 безпосередньо в адресний рядок вашого браузера, щоб завантажити його.

Завантажити

model_urls.glb
curl -L "<model_urls.glb from the response above>" -o model.glb
Отримана 3D модель, згенерована з зразка фото фантастичного персонажа
Ваш результат

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

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

Повний скрипт

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

const headers = { Authorization: `Bearer ${process.env.MESHY_API_KEY}` };
const imageUrl = 'https://docs.meshy.cn/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 } = await axios.get(`https://api.meshy.ai/openapi/v1/image-to-3d/${taskId}`, { headers });
  task = data;
  if (task.status === 'SUCCEEDED' || task.status === 'FAILED') break;
  await new Promise((resolve) => setTimeout(resolve, 5000));
}

// 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');

Досліджуйте загальні робочі процеси


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

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