クイックスタート

APIキーを作成することから始めてください

このガイドのすべてのリクエストには必要です。キーの作成には1分もかかりません。

APIキーを作成する

Meshy REST APIを使用した、初めての3Dモデル作成の4つのステップ。


1APIキーを取得する

APIキーを作成し、アカウント設定から作成します。この画面以降は表示できないので、安全な場所に保存してください。すべてのリクエストは、AuthorizationヘッダーのBearerトークンで認証されます — 認証を参照してください。

APIメニューからAPI設定を開き、キーを作成する


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タスクステータスを確認する

リクエストはすぐにタスクIDを返します。statusSUCCEEDEDになるまで同じendpointにポーリングします — 以下の<task_id>をステップ2で返されたIDに置き換えてください。

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
サンプルの猫の写真から生成された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. タスクを作成
const { data: created } = await axios.post(
  'https://api.meshy.ai/openapi/v1/image-to-3d',
  { image_url: imageUrl },
  { headers },
);
const taskId = created.result;

// 2. 完了までポーリング
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. 結果をダウンロード
const { data: model } = await axios.get(task.model_urls.glb, { responseType: 'arraybuffer' });
fs.writeFileSync('model.glb', model);
console.log('Saved model.glb');

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


次のステップ

  • UIを好みますか? APIプレイグラウンドを試してみてください — リクエストを設定し、実行し、生成されたコードをコピーします。
  • 各エンドポイントのAPIリファレンス全体を参照してください。
  • 本番環境に移行する前に料金レート制限、およびエラーを確認してください。
  • 更新やバグ修正については変更履歴を確認してください。
  • フィードバックや問題がありますか?私たちのDiscordコミュニティに参加してください — 皆様からのご意見をお待ちしています!