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

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

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

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

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


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

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

Open API Settings from the API menu, then create your key


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.ai/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.ai/images/api/quick-start/source-photo.webp';

// 1. Створіть завдання
const { data: created } = await axios.post(
  'https://api.meshy.ai/openapi/v1/image-to-3d',
  { image_url: imageUrl },
  { headers },
);
const taskId = created.result;

// 2. Запитуйте, поки не завершиться
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. Завантажте результат
const { data: model } = await axios.get(task.model_urls.glb, { responseType: 'arraybuffer' });
fs.writeFileSync('model.glb', model);
console.log('Збережено model.glb');

Вивчіть загальні робочі процеси


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

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