lowpoly は 2026/10/30 に廃止されます。 3D 生成モデルとしての meshy-7 は 2026/12/31 に廃止されます。テクスチャモデルとしては引き続き利用できます。 リクエストエラーを避けるため、これらの日付までにモデルを切り替えてください。 非推奨の一覧を見る

クイックスタート

まずAPIキーを作成しましょう

このガイド内のすべてのリクエストでAPIキーが必要です。キーの作成は数秒で完了します。

APIキーを作成する

APIキーの作成からモデルのダウンロードまで、4つのステップでMeshy REST APIを使って最初の3Dモデルを作成します。


1APIキーを取得する

Developer PlatformのAPI KeysページでAPIキーを作成してください。この画面を離れると再度キーを表示することはできないため、安全な場所に保存してください。すべてのリクエストでAuthorizationヘッダーにBearerトークンとして送信します。詳細は認証をご覧ください。

APIキーの作成と管理には有料プランが必要です。Freeプランでは独自のキーを作成できず、Playgroundはテスト用に組み込みのキーを使用します。

Developer PlatformでAPI Keysページを開き、キーを作成する


2画像から3Dタスクを作成する

画像から3Dに画像を送信します。テキストprompt、または複数の写真から開始したい場合は、代わりにテキストから3Dまたはマルチ画像から3Dをご利用ください。

まず、キーを環境変数に保存します。

Export your key

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

以下の例はすべてこの写真を使用します。別の画像で試すには、image_urlを変更してください。

このガイドで画像から3Dの入力として使用されるファンタジーキャラクターのサンプルイラスト
サンプル入力

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>をステップ2で返されたIDに置き換えてください。リクエストの間は、Retry-Afterヘッダーに示された秒数だけ待機します。

典型的な処理時間、およびどのくらい待ってから諦めるべきかについては、タスクのライフサイクルをご覧ください。

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

タスクが失敗した場合、statusはFAILEDになり、task_errorに理由が示されます。入力を修正するか、別のタスクを作成してください。詳細はエラーをご覧ください。


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
サンプルのファンタジーキャラクター写真から生成された3Dモデルの結果
生成結果

すべてをまとめる

このスクリプトは、タスクを作成し、完了を待ってからモデルをダウンロードします。

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

一般的なワークフローを見る


次のステップ