快速开始

第一步:创建您的 API 密钥

本指南中的每个请求都需要一个 API 密钥。创建密钥只需不到一分钟。

创建您的 API 密钥

四个步骤,使用 Meshy REST API 生成您的第一个 3D 模型。


1获取 API 密钥

请从账户设置中创建一个 API 密钥 — 离开该页面后将无法再次查看密钥,请妥善保存。每个请求都通过 Authorization 请求头中的 Bearer 令牌进行身份验证 — 详见身份验证

从 API 菜单中打开 API 设置,然后创建您的密钥


2发出您的第一个 Image-to-3D 请求

先导出您的密钥,然后使用 Image to 3D 创建您的第一个任务。想从文本提示词或多张图片开始?请查看 Text to 3DMulti-Image to 3D

导出您的密钥

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。请轮询同一个端点,直到 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 } = 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. 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');

探索常见工作流


下一步

  • 想先在不写代码的情况下试用?使用 API Playground 配置并运行请求,然后复制生成的代码。
  • 浏览完整的 API 参考,了解所有端点。
  • 在正式上线前,请查看定价速率限制错误码
  • 关注更新日志以获取最新更新和错误修复。
  • 有反馈或遇到问题?加入我们的 Discord 社区 - 我们期待您的声音!