meshy-5 将于 2026年10月10日 下线。 lowpoly 将于 2026年10月30日 下线。 请在这些日期前切换模型,以免请求报错。

快速开始

从创建你的 API key 开始

本指南中的每个请求都需要用到它。创建一个 key 只需几秒钟。

创建你的 API key

使用 Meshy REST API,只需四个步骤即可生成你的第一个 3D 模型。


1获取你的 API key

在 Developer Platform 的 API Keys 页面创建一个 API key——离开该页面后你将无法再次查看它,因此请妥善保存。每个请求都通过 Authorization 请求头中的 Bearer 令牌进行 authentication——参见 Authentication。

在 Developer Platform 中打开 API Keys 页面,然后创建你的 key


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>"

下方所有示例都使用这张照片——你可以替换为自己的 image_url 来尝试其他内容。

用作本指南中 Image to 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。轮询同一个 endpoint,直到 status 变为 SUCCEEDED——请将下方的 <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. 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');

探索常见工作流程


后续步骤

  • 更喜欢 UI?打开 Developer Platform——在 Playground 中运行请求、跟踪用量和请求日志,并管理 webhook。
  • 浏览完整的 API reference,了解每一个 endpoint。
  • 从可运行的示例中学习:跟随 Cookbook 中的分步教程操作,并阅读 Developer Blog 上的教程和开发故事。
  • 在投入生产环境之前,请查看 Pricing、Rate Limits 和 Errors。
  • 关注 更新日志,了解更新和错误修复情况。
  • 有反馈或遇到问题?欢迎加入我们的 Discord community——我们很乐意听到你的声音!