Швидкий старт
Почніть зі створення вашого API-ключа
Кожен запит у цьому посібнику потребує його. Створення ключа займає лічені секунди.
Створити ваш API-ключЧотири кроки до вашої першої 3D-моделі за допомогою Meshy REST API.
Використовуєте ШІ-асистента для написання коду? Перегляньте нашу сторінку Інтеграція зі ШІ — встановіть Meshy MCP server для доступу через виклик інструментів із Claude Code, Cursor, Windsurf та інших сумісних з MCP інструментів, або налаштуйте звичайного чат-агента на llms.txt.
1Отримайте свій API-ключ
Створіть API-ключ на сторінці API Keys у Developer Platform — після закриття цього екрана переглянути його знову буде неможливо, тож зберігайте його в надійному місці. Кожен запит проходить автентифікацію за допомогою токена Bearer у заголовку Authorization — див. Автентифікація.
Для створення та керування API-ключами потрібен платний план. Безкоштовні акаунти отримують спеціальний вбудований ключ для тестування у Playground, але не можуть створювати чи керувати власними ключами.

Порада з безпеки: уникайте вставляння свого ключа безпосередньо в скрипти — натомість зберігайте його як змінну середовища: export MESHY_API_KEY="msy_...".
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>"
Виконайте це у вашому терміналі (Terminal на macOS, Command Prompt або PowerShell на Windows) — не в браузері.
У кожному прикладі нижче використовується це фото — підставте власний image_url, щоб спробувати щось інше.

Request
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
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": ""
}
}
Опитування не у вашому стилі? Використайте SSE-потокову передачу або webhook, щоб отримувати сповіщення одразу після завершення завдання.
4Завантажте свою модель
Отримайте модель з model_urls у відповіді вище. Кожен формат (GLB, FBX, OBJ, USDZ, STL) — це підписана URL-адреса з обмеженим терміном дії — або пропустіть командний рядок і вставте URL-адресу безпосередньо в адресний рядок браузера, щоб завантажити її.
Download
curl -L "<model_urls.glb from the response above>" -o model.glb

Файли зберігаються протягом 3 днів на тарифних планах, відмінних від Enterprise — див. Зберігання ресурсів.
Зберемо все разом
Хочете один скрипт, що робить усе одразу — створює, опитує, завантажує?
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
Game-ready character
Виконайте rigging гуманоїдної сітки за допомогою скелета, щоб вона була готова до анімації в Unity або Unreal.
Learn more →Lowpoly asset
Встановіть model_type на smart-topology у Зображення у 3D для чистої, готової до гри сітки.
3D print model
Конвертуйте готову модель у багатоколірний файл 3MF, готовий до нарізки та друку.
Learn more →Наступні кроки
- Надаєте перевагу інтерфейсу користувача? Відкрийте Developer Platform — виконуйте запити в Playground, відстежуйте використання та журнали запитів, а також керуйте webhooks.
- Перегляньте повний API reference для кожної кінцевої точки.
- Навчайтеся на робочих прикладах: дотримуйтесь покрокових рецептів у Cookbook та читайте посібники й історії розробки в Developer Blog.
- Перегляньте Ціни, Rate Limits та Помилки, перш ніж переходити до продакшену.
- Стежте за журналом змін щодо оновлень і виправлень помилок.
- Маєте відгуки чи зіткнулися з проблемами? Приєднуйтесь до нашої Discord спільноти — ми будемо раді почути вас!