Mula pantas

Mulakan dengan mencipta kunci API anda

Setiap permintaan dalam panduan ini memerlukan satu. Mencipta kunci mengambil masa kurang dari satu minit.

Cipta kunci API anda

Empat langkah kepada model 3D pertama anda, menggunakan Meshy REST API.


1Dapatkan kunci API anda

Cipta kunci API dari tetapan akaun anda — anda tidak akan dapat melihatnya semula selepas skrin ini, jadi simpan di tempat yang selamat. Setiap permintaan mengesahkan dengan token Bearer dalam header Authorization — lihat Pengesahan.

Buka Tetapan API dari menu API, kemudian cipta kunci anda


2Buat permintaan Imej-ke-3D pertama anda

Eksport kunci anda, kemudian buat tugasan pertama anda dengan Imej ke 3D. Bekerja dari prompt teks atau berbilang foto sebaliknya? Lihat Teks ke 3D atau Berbilang Imej ke 3D.

Eksport kunci anda

export MESHY_API_KEY="<kunci-api-anda>"

Setiap contoh di bawah menggunakan foto ini — tukar image_url anda sendiri untuk mencuba sesuatu yang lain.

Contoh foto kucing yang digunakan sebagai input Imej ke 3D dalam panduan ini
Input contoh

Permintaan

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

3Periksa status tugasan

Permintaan mengembalikan ID tugasan dengan segera. Polling endpoint yang sama sehingga status adalah SUCCEEDED — gantikan <task_id> di bawah dengan ID yang dikembalikan dalam langkah 2.

Permintaan

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

Respons — 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": ""
  }
}

4Muat turun model anda

Ambil model dari model_urls dalam respons di atas. Setiap format (GLB, FBX, OBJ, USDZ, STL) adalah URL yang ditandatangani, terhad masa — atau lewati baris perintah dan tampal URL secara langsung ke bar alamat pelayar anda untuk memuat turunnya.

Muat turun

model_urls.glb
curl -L "<model_urls.glb dari respons di atas>" -o model.glb
Model 3D yang dihasilkan dari foto kucing contoh
Hasil anda

Gabungkan semuanya

Lebih suka satu skrip yang melakukan semuanya — mencipta, mengundi, memuat turun?

Skrip penuh

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. Cipta tugasan
const { data: created } = await axios.post(
  'https://api.meshy.ai/openapi/v1/image-to-3d',
  { image_url: imageUrl },
  { headers },
);
const taskId = created.result;

// 2. Mengundi sehingga ia selesai
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. Muat turun hasilnya
const { data: model } = await axios.get(task.model_urls.glb, { responseType: 'arraybuffer' });
fs.writeFileSync('model.glb', model);
console.log('Saved model.glb');

Terokai aliran kerja biasa


Langkah seterusnya

  • Lebih suka UI? Cuba API Playground — konfigurasikan permintaan, jalankan, dan salin kod yang dihasilkan.
  • Semak rujukan penuh API untuk setiap endpoint.
  • Semak Harga, Had Kadar, dan Ralat sebelum anda pergi ke produksi.
  • Tonton log perubahan untuk kemas kini dan pembetulan pepijat.
  • Mempunyai maklum balas atau menghadapi masalah? Sertai komuniti Discord kami — kami ingin mendengar daripada anda!