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

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

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

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

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


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

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

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


2Отправьте первый запрос Изображение в 3D

Экспортируйте ваш ключ, затем создайте вашу первую задачу с помощью Изображение в 3D. Работаете с текстовым prompt или несколькими фотографиями вместо этого? См. Текст в 3D или Мульти-изображение в 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
Пример входных данных

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

Запросы немедленно возвращают ID задачи. Опрашивайте тот же эндпоинт, пока status не станет SUCCEEDED — замените <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) представляет собой подписанный URL с ограниченным сроком действия — или пропустите командную строку и вставьте URL напрямую в адресную строку вашего браузера, чтобы скачать его.

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
Ваш результат

Соберите всё воедино

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

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 },
);
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');

Изучите распространённые рабочие процессы


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

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