lowpoly будет отключён 30 окт. 2026 г.. Перейдите на другую модель до этих дат, чтобы избежать ошибок в запросах.

Быстрый старт

Начните с создания вашего API-ключа

Каждый запрос в этом руководстве требует его наличия. Создание ключа занимает несколько секунд.

Создать API-ключ

Четыре шага до вашей первой 3D-модели с использованием Meshy REST API.


1Получите API-ключ

Создайте API-ключ на странице API Keys в Developer Platform — после закрытия этого экрана вы больше не сможете его просмотреть, поэтому сохраните его в надёжном месте. Каждый запрос проходит аутентификацию с помощью токена Bearer в заголовке Authorization — см. Authentication.

Откройте страницу API Keys в Developer Platform, затем создайте ключ


2Создайте свой первый запрос Image-to-3D

Экспортируйте свой ключ, а затем создайте свою первую задачу с помощью Image to 3D. Работаете с текстовым prompt или несколькими фотографиями вместо этого? См. Text to 3D или Multi-Image to 3D.

Export your key

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

В каждом из примеров ниже используется это фото — подставьте свой image_url, чтобы попробовать что-то другое.

Sample fantasy character illustration used as the Image to 3D input in this guide
Sample input

Request

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Проверка статуса задачи

Задача выполняется в фоновом режиме и обычно занимает несколько минут. Опрашивайте тот же эндпоинт, пока status не станет SUCCEEDED, FAILED или CANCELED, заменив <task_id> ниже на ID, полученный на шаге 2. Типичные сроки и рекомендации по ожиданию см. в разделе Жизненный цикл задачи.

Request

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}"

Response — 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) представляет собой подписанную ссылку с ограниченным сроком действия — либо, не используя командную строку, просто вставьте ссылку напрямую в адресную строку браузера, чтобы скачать файл.

Download

model_urls.glb
curl -L "<model_urls.glb from the response above>" -o model.glb
The resulting 3D model generated from the sample fantasy character photo
Your result

Соберём всё вместе

Предпочитаете один скрипт, который делает всё целиком — создание, опрос, скачивание?

Full script

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, timeout: 60_000 },
);
const taskId = created.result;

// 2. Poll until it finishes, for up to 60 minutes
const deadline = Date.now() + 60 * 60 * 1000;
let task;
while (true) {
  const { data, headers: resHeaders } = await axios.get(
    `https://api.meshy.ai/openapi/v1/image-to-3d/${taskId}`,
    { headers, timeout: 30_000 },
  );
  task = data;
  if (['SUCCEEDED', 'FAILED', 'CANCELED'].includes(task.status)) break;
  if (Date.now() > deadline) {
    // The task is still running. Check it again later with the same task ID instead of creating a new one.
    throw new Error(`Task ${taskId} is still ${task.status}; check it again later`);
  }
  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');

Explore common workflows


Следующие шаги

  • Предпочитаете интерфейс? Откройте Developer Platform — выполняйте запросы в Playground, отслеживайте использование и журналы запросов, а также управляйте webhooks.
  • Просмотрите полный справочник по API по каждому эндпоинту.
  • Изучайте рабочие примеры: следуйте пошаговым рецептам в Cookbook и читайте руководства и истории разработки в Developer Blog.
  • Перед выходом в продакшн ознакомьтесь с разделами Цены, Rate Limits и Ошибки.
  • Следите за журналом изменений — там публикуются обновления и исправления ошибок.
  • Есть отзывы или возникли проблемы? Присоединяйтесь к нашему сообществу в Discord — будем рады вас услышать!