快速開始
從建立你的 API key 開始
本指南中的每個請求都需要用到它。建立一個 key 只需幾秒鐘。
建立你的 API key使用 Meshy REST API,只需四個步驟即可產生你的第一個 3D 模型。
1取得你的 API key
在 Developer Platform 的 API Keys 頁面建立一個 API key——離開該頁面後你將無法再次檢視它,因此請妥善保存。每個請求都透過 Authorization 請求標頭中的 Bearer 權杖進行 authentication——參見 Authentication。
建立和管理 API key 需要付費方案。免費帳戶可取得一個專用的內建 key,用於在 Playground 中測試,但無法建立或管理自己的 key。

安全提示: 避免將你的 key 直接貼到腳本中——而應將其儲存為環境變數:export MESHY_API_KEY="msy_..."。
2發起你的第一個 Image-to-3D 請求
匯出你的 key,然後使用 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檢查任務狀態
請求會立即傳回一個任務 ID。輪詢同一個 endpoint,直到 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 streaming 或 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 天——參見 資產保留期。
整合到一起
更想要一個能完成全部流程的腳本——建立、輪詢、下載?
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');
探索常見工作流程
遊戲就緒角色
為類人 mesh 添加骨骼,使其可以直接在 Unity 或 Unreal 中進行動畫製作。
Learn more →低多邊形資產
在 Image to 3D 中將 model_type 設定為 smart-topology,即可取得乾淨、可直接用於遊戲的 mesh。
3D 列印模型
將完成的模型轉換為多色 3MF 檔案,可直接用於切片和列印。
Learn more →後續步驟
- 更喜歡 UI?開啟 Developer Platform——在 Playground 中執行請求、追蹤用量和請求紀錄,並管理 webhook。
- 瀏覽完整的 API reference,瞭解每一個 endpoint。
- 從可執行的範例中學習:跟隨 Cookbook 中的逐步教學操作,並閱讀 Developer Blog 上的教學和開發故事。
- 在投入正式環境之前,請查看 Pricing、Rate Limits 和 Errors。
- 關注 更新日誌,瞭解更新和錯誤修正情況。
- 有意見回饋或遇到問題?歡迎加入我們的 Discord community——我們很樂意聽到你的聲音!