クイックスタート
まずはAPIキーを作成しましょう
このガイドのすべてのリクエストにAPIキーが必要です。キーの作成は数秒で完了します。
APIキーを作成するMeshy REST APIを使って最初の3Dモデルを作成するまでの4ステップ。
1APIキーを取得する
Developer PlatformのAPI KeysページからAPIキーを作成してください。この画面を閉じると再度表示できないため、安全な場所に保管してください。すべてのリクエストはAuthorizationヘッダー内のBearerトークンで認証します。詳しくは認証をご覧ください。
APIキーの作成・管理には有料プランが必要です。無料アカウントにはPlaygroundでのテスト用に専用の組み込みキーが提供されますが、独自のキーを作成・管理することはできません。
セキュリティのヒント: キーを直接スクリプトに貼り付けるのは避け、代わりに環境変数として保存してください: export MESHY_API_KEY="msy_..."。
2最初の画像から3Dリクエストを送信する
キーをエクスポートしてから、画像から3Dで最初のタスクを作成しましょう。テキストprompt、あるいは複数の写真から作成したい場合は、テキストから3Dまたはマルチ画像から3Dをご覧ください。
キーをエクスポート
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タスクのステータスを確認する
リクエストを送信するとすぐにタスクIDが返されます。statusがSUCCEEDEDになるまで同じエンドポイントをポーリングしてください。以下の<task_id>はステップ2で返されたIDに置き換えてください。
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つのスクリプトがお好みですか？
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, headers: resHeaders } = await axios.get(`https://api.meshy.ai/openapi/v1/image-to-3d/${taskId}`, { headers });
task = data;
if (task.status === 'SUCCEEDED' || task.status === 'FAILED') break;
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');
一般的なワークフローを見る
ゲーム向けキャラクター
ヒューマノイドメッシュにスケルトンでrigを付け、UnityやUnrealですぐにアニメーションできるようにします。
Learn more →ローポリアセット
画像から3Dでmodel_typeをsmart-topologyに設定すると、クリーンでゲーム向けのメッシュが得られます。
3Dプリントモデル
完成したモデルをマルチカラーの3MFファイルに変換し、スライス・プリントできる状態にします。
Learn more →