クイックスタート
まずはAPIキーを作成しましょう
このガイドのすべてのリクエストにはAPIキーが必要です。キーの作成は数秒で完了します。
APIキーを作成するMeshy REST APIを使って最初の3Dモデルを作成するまでの4ステップです。
1APIキーを取得する
Developer PlatformのAPI KeysページからAPIキーを作成してください — この画面を離れると二度と表示できなくなるため、安全な場所に保管してください。すべてのリクエストはAuthorizationヘッダー内のBearerトークンで認証します — 詳しくはAuthenticationを参照してください。
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>"
これはターミナル(macOSならTerminal、Windowsならコマンドプロンプトまたは PowerShell)で実行してください。ブラウザ上では実行できません。
以下の例ではすべてこの写真を使用しています。別のものを試したい場合は、独自の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> は手順2で返されたIDに置き換えてください。典型的な所要時間と待機時間の目安については、Task Lifecycle を参照してください。
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

ファイルは非Enterpriseプランでは3日間保持されます — 詳細はアセット保持期間をご覧ください。
すべてをまとめる
作成・ポーリング・ダウンロードまで、一連の処理を行う1つのスクリプトが欲しいですか?
フルスクリプト
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');
共通ワークフローを見る
ゲーム向けキャラクター
ヒューマノイドメッシュにスケルトンでリギングを行い、Unity や Unreal ですぐにアニメーションできるようにします。
Learn more →ローポリアセット
画像から3D で model_type を smart-topology に設定し、クリーンでゲーム向けのメッシュを作成します。
3D プリントモデル
完成したモデルをマルチカラーの 3MF ファイルに変換し、スライスしてプリントできるようにします。
Learn more →次のステップ
- UIの方がお好みですか? Developer Platform を開いて、Playgroundでリクエストを実行したり、使用状況やリクエストログを確認したり、Webhooksを管理したりできます。
- すべてのエンドポイントについては、APIリファレンス をご覧ください。
- 実際のサンプルから学びましょう:Cookbook のステップバイステップのレシピに従ったり、Developer Blog でチュートリアルや開発ストーリーを読んだりできます。
- 本番環境に移行する前に、料金、レート制限、エラー をご確認ください。
- 更新や不具合修正については 変更履歴 をチェックしてください。
- フィードバックがある、または問題が発生していますか? ぜひ Discord コミュニティにご参加ください。皆様からのご意見をお待ちしております!