เริ่มต้นอย่างรวดเร็ว

เริ่มต้นด้วยการสร้าง API คีย์ของคุณ

ทุกคำขอในคู่มือนี้ต้องการคีย์ การสร้างคีย์ใช้เวลาน้อยกว่าหนึ่งนาที

สร้าง API คีย์ของคุณ

สี่ขั้นตอนสู่โมเดล 3D แรกของคุณ โดยใช้ Meshy REST API.


1รับ API คีย์ของคุณ

สร้าง API คีย์ จากการตั้งค่าบัญชีของคุณ — คุณจะไม่สามารถดูมันอีกหลังจากหน้าจอนี้ ดังนั้นเก็บมันไว้ในที่ปลอดภัย ทุกคำขอจะยืนยันตัวตนด้วยโทเค็น Bearer ในหัวข้อ Authorization — ดู การยืนยันตัวตน.

เปิดการตั้งค่า API จากเมนู API แล้วสร้างคีย์ของคุณ


2ทำการร้องขอ รูปภาพเป็น 3D ครั้งแรกของคุณ

ส่งออกคีย์ของคุณ จากนั้นสร้างงานแรกของคุณด้วย รูปภาพเป็น 3D. ทำงานจากข้อความ prompt หรือหลายรูปแทน? ดู ข้อความเป็น 3D หรือ หลายรูปเป็น 3D.

ส่งออกคีย์ของคุณ

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

ทุกตัวอย่างด้านล่างใช้รูปนี้ — เปลี่ยน image_url ของคุณเองเพื่อทดลองสิ่งอื่น.

ภาพประกอบตัวละครแฟนตาซีตัวอย่างที่ใช้เป็นอินพุต รูปภาพเป็น 3D ในคู่มือนี้
อินพุตตัวอย่าง

คำขอ

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.cn/images/api/quick-start/source-photo.webp"
  }'

3ตรวจสอบสถานะงาน

คำขอจะคืนค่า task ID ทันที ตรวจสอบเอนด์พอยต์เดิมจนกว่า status จะเป็น SUCCEEDED — แทนที่ <task_id> ด้านล่างด้วย ID ที่คืนค่าในขั้นตอนที่ 2.

คำขอ

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

การตอบกลับ — 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 ลงในแถบที่อยู่ของเบราว์เซอร์ของคุณเพื่อดาวน์โหลด.

ดาวน์โหลด

model_urls.glb
curl -L "<model_urls.glb from the response above>" -o model.glb
โมเดล 3D ที่ได้จากภาพตัวละครแฟนตาซีตัวอย่าง
ผลลัพธ์ของคุณ

รวมทุกอย่างเข้าด้วยกัน

ชอบสคริปต์เดียวที่ทำทุกอย่าง — สร้าง, ตรวจสอบ, ดาวน์โหลด?

สคริปต์เต็ม

import axios from 'axios';
import fs from 'fs';

const headers = { Authorization: `Bearer ${process.env.MESHY_API_KEY}` };
const imageUrl = 'https://docs.meshy.cn/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');

สำรวจเวิร์กโฟลว์ทั่วไป


ขั้นตอนถัดไป