Quickstart

Simulan sa paglikha ng iyong API key

Ang bawat kahilingan sa gabay na ito ay nangangailangan ng isa. Ang paggawa ng key ay tumatagal ng wala pang isang minuto.

Lumikha ng iyong API key

Apat na hakbang sa iyong unang 3D na modelo, 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 tools, o ituro ang isang plain chat agent sa llms.txt.

1Kunin ang iyong API key

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

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

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

2Gumawa ng 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 ito ng iyong sariling image_url upang subukan ang ibang bagay.

Halimbawang larawan ng pusa na ginamit bilang input sa gabay na ito para sa Image to 3D
Halimbawang 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.ai/images/api/quick-start/source-photo.webp"
  }'

3Suriin ang katayuan ng gawain

Ang mga kahilingan ay agad na bumabalik ng task ID. I-poll ang parehong endpoint hanggang ang status ay SUCCEEDED — palitan ang <task_id> sa ibaba ng ID na bumalik 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}"

Tugon — 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 pagpo-poll? Gamitin ang SSE streaming o isang webhook upang maabisuhan kaagad na 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 nakapirma, time-limited URL — o i-skip ang command line at i-paste ang URL nang direkta sa address bar ng iyong browser upang ma-download ito.

I-download

model_urls.glb
curl -L "<model_urls.glb mula sa tugon sa itaas>" -o model.glb
Ang resultang 3D na modelo na ginawa mula sa halimbawang larawan ng pusa
Ang iyong resulta

Nananatili ang mga file sa loob ng 3 araw sa hindi pang-Enterprise na mga plano — tingnan ang Asset Retention.

Pagsama-samang gawin

Mas gusto ang isang script na gumagawa ng buong proseso — lumikha, i-poll, i-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.ai/images/api/quick-start/source-photo.webp';

// 1. Lumikha ng gawain
const { data: created } = await axios.post(
  'https://api.meshy.ai/openapi/v1/image-to-3d',
  { image_url: imageUrl },
  { headers },
);
const taskId = created.result;

// 2. I-poll hanggang matapos
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. I-download ang resulta
const { data: model } = await axios.get(task.model_urls.glb, { responseType: 'arraybuffer' });
fs.writeFileSync('model.glb', model);
console.log('Nai-save na model.glb');

Galugarin ang mga karaniwang workflow

Game-ready character

I-rig ang isang humanoid mesh na may skeleton para 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 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 ang isang UI? Subukan ang API Playground — i-configure ang isang kahilingan, patakbuhin ito, at kopyahin ang nabuo na code.
  • Silipin ang buong API reference para sa bawat endpoint.
  • Tingnan ang Pricing, Rate Limits, at Errors bago magtungo sa produksyon.
  • Panoorin ang changelog para sa mga update at pag-ayos ng bug.
  • May feedback o may kinakaharap na isyu? Sumali sa aming komunidad sa Discord — gusto naming marinig mula sa'yo!