Quickstart

Magsimula sa paggawa ng iyong API key

Kailangan ito ng bawat request sa gabay na ito. Ilang segundo lang ang paggawa ng key.

Gumawa ng iyong API key

Apat na hakbang papunta sa iyong unang 3D model, gamit ang Meshy REST API.

Gumagamit ng AI coding assistant? Tingnan ang aming AI Integration page — 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

Gumawa ng API key mula sa API Keys page sa Developer Platform — hindi mo na ito makikita ulit pagkatapos ng screen na ito, kaya itago ito sa isang ligtas na lugar. Bawat request ay nag-a-authenticate gamit ang Bearer token sa Authorization header — tingnan ang Authentication.

Ang paggawa at pamamahala ng mga API key ay nangangailangan ng paid plan. Ang mga Free account ay may dedikadong, built-in na key para sa pagsubok sa Playground, ngunit hindi maaaring gumawa o mamahala ng sarili nilang mga key.

Buksan ang API Keys page sa Developer Platform, pagkatapos ay gawin ang iyong key

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

2Gawin ang iyong unang Image-to-3D request

I-export ang iyong key, pagkatapos ay gumawa ng iyong unang task gamit ang Image to 3D. Gumagawa ka ba mula sa isang text prompt o maraming litrato sa halip? Tingnan ang Text to 3D o Multi-Image to 3D.

Export your 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.

Ginagamit ng bawat halimbawa sa ibaba ang litratong ito — palitan ng sarili mong image_url para subukan ang iba.

Sample fantasy character illustration used as the Image to 3D input in this guide
Sample input

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

3Suriin ang status ng task

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

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

Hindi mo gusto ang polling? Gamitin ang SSE streaming o isang webhook para maabisuhan sa sandaling matapos ang isang task.

4I-download ang iyong model

Kunin ang model mula sa model_urls sa tugon sa itaas. Ang bawat format (GLB, FBX, OBJ, USDZ, STL) ay isang naka-sign, may-time-limit na URL — o laktawan ang command line at i-paste nang direkta ang URL sa address bar ng iyong browser para i-download ito.

Download

model_urls.glb
curl -L "<model_urls.glb from the response above>" -o model.glb
The resulting 3D model generated from the sample fantasy character photo
Your result

Ang mga file ay pinapanatili nang 3 araw sa mga hindi-Enterprise na plano — tingnan ang Asset Retention.

Pagsamahin ang lahat

Mas gusto ang isang script na gumagawa ng buong proseso — gumawa, mag-poll, mag-download?

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

Galugarin ang mga karaniwang workflow

Character na handa sa laro

I-rig ang isang humanoid mesh gamit ang isang skeleton para handa na itong i-animate sa Unity o Unreal.

Learn more →

Lowpoly asset

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

Learn more →

3D print model

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

Learn more →

Mga susunod na hakbang

  • Mas gusto ang UI? Buksan ang Developer Platform — magpatakbo ng mga request sa Playground, subaybayan ang paggamit at mga log ng request, at pamahalaan ang mga webhook.
  • I-browse ang buong API reference para sa bawat endpoint.
  • Tingnan ang Pricing, Rate Limits, at Errors bago magpunta sa production.
  • Bantayan ang Changelog para sa mga update at pag-aayos ng bug.
  • May feedback o may naranasang problema? Sumali sa aming Discord na komunidad — nais naming marinig mula sa iyo!