Quickstart

Magsimula sa pamamagitan ng paglikha ng iyong API key

Kailangan ng bawat kahilingan sa gabay na ito. Ang paglikha ng key ay tumatagal ng mas mababa sa isang minuto.

Lumikha ng iyong API key

Apat na hakbang patungo sa iyong unang 3D na modelo, gamit ang Meshy REST API.

Gumagamit ng AI coding assistant? Tingnan ang aming AI Integration na pahina — i-install ang Meshy MCP server para sa tool-calling access mula sa Claude Code, Cursor, Windsurf, at iba pang MCP-compatible na mga tool, o ituro ang isang plain chat agent sa llms.txt.

1Kunin ang iyong API key

Lumikha ng isang API key mula sa iyong account settings — hindi mo na ito makikita muli pagkatapos ng screen na ito, kaya't itago ito sa isang ligtas na lugar. Ang bawat kahilingan ay nag-a-authenticate gamit ang isang Bearer token sa Authorization header — tingnan ang Authentication.

Buksan ang API Settings mula sa API menu, pagkatapos ay lumikha ng iyong key

Tip sa seguridad: iwasang i-paste ang iyong key direkta sa mga script — itago ito bilang isang environment variable: export MESHY_API_KEY="msy_...".

2Gawin ang iyong unang Image-to-3D na kahilingan

I-export ang iyong key, pagkatapos ay lumikha ng iyong unang gawain gamit ang Image to 3D. Nagtatrabaho mula sa isang text prompt o maramihang mga larawan? Tingnan ang Text to 3D o Multi-Image to 3D.

I-export ang iyong key

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

Patakbuhin ito sa iyong terminal (Terminal sa macOS, Command Prompt o PowerShell sa Windows) — hindi sa isang browser.

Ang bawat halimbawa sa ibaba ay gumagamit ng larawang ito — palitan ng iyong sariling image_url upang subukan ang iba pa.

Sample fantasy character illustration na ginamit bilang Image to 3D input sa gabay na ito
Sample input

Kahilingan

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

3Suriin ang status ng gawain

Ang mga kahilingan ay agad na nagbabalik ng task ID. I-poll ang parehong endpoint hanggang ang status ay SUCCEEDED — palitan ang <task_id> sa ibaba ng ID na ibinalik sa hakbang 2.

Kahilingan

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

Hindi mo gusto ang polling? Gamitin ang SSE streaming o isang webhook upang ma-notify kaagad kapag natapos ang isang gawain.

4I-download ang iyong modelo

Kunin ang modelo mula sa model_urls sa tugon sa itaas. Ang bawat format (GLB, FBX, OBJ, USDZ, STL) ay isang signed, time-limited URL — o laktawan ang command line at i-paste ang URL direkta sa address bar ng iyong browser upang i-download ito.

I-download

model_urls.glb
curl -L "<model_urls.glb from the response above>" -o model.glb
Ang nagresultang 3D na modelo na nabuo mula sa sample na fantasy character na larawan
Ang iyong resulta

Ang mga file ay pinapanatili sa loob ng 3 araw sa mga non-Enterprise na plano — tingnan ang Asset Retention.

Pagsamahin ang lahat

Mas gusto mo ba ang isang script na gumagawa ng lahat — lumikha, mag-poll, mag-download?

Buong script

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');

Suriin ang mga karaniwang workflow

Game-ready character

I-rig ang isang humanoid mesh gamit ang isang skeleton upang ito ay handa nang i-animate sa Unity o Unreal.

Learn more →

Lowpoly asset

Itakda ang model_type sa lowpoly sa Image to 3D para sa isang malinis, game-ready na mesh.

Learn more →

3D print model

I-convert ang isang natapos na modelo sa isang multi-color na 3MF file, handa nang i-slice at i-print.

Learn more →

Mga susunod na hakbang

  • Mas gusto mo ba ang isang UI? Subukan ang API Playground — i-configure ang isang kahilingan, patakbuhin ito, at kopyahin ang nabuo na code.
  • Suriin ang buong API reference para sa bawat endpoint.
  • Suriin ang Pricing, Rate Limits, at Errors bago ka pumunta sa production.
  • Bantayan ang Changelog para sa mga update at pag-aayos ng bug.
  • May feedback o nakakaranas ng mga isyu? Sumali sa aming Discord na komunidad — nais naming marinig mula sa iyo!