Rychlý start

Začněte vytvořením svého API klíče

Každý požadavek v tomto průvodci jej potřebuje. Vytvoření klíče trvá méně než minutu.

Vytvořit svůj API klíč

Čtyři kroky k vašemu prvnímu 3D modelu pomocí Meshy REST API.


1Získejte svůj API klíč

Vytvořte API klíč z nastavení vašeho účtu — po této obrazovce jej nebudete moci znovu zobrazit, proto jej uložte na bezpečné místo. Každý požadavek se autentizuje pomocí Bearer tokenu v hlavičce Authorization — viz Autentizace.

Otevřete nastavení API z menu API, poté vytvořte svůj klíč


2Proveďte svůj první požadavek Obrázek na 3D

Exportujte svůj klíč, poté vytvořte svůj první úkol s Obrázek na 3D. Pracujete raději s textovým promptem nebo více fotografiemi? Viz Text na 3D nebo Více obrázků na 3D.

Exportujte svůj klíč

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

Každý příklad níže používá tuto fotografii — nahraďte ji svým vlastním image_url, abyste vyzkoušeli něco jiného.

Ukázková ilustrace fantasy postavy použitá jako vstup Obrázek na 3D v tomto průvodci
Ukázkový vstup

Požadavek

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

3Zkontrolujte stav úkolu

Požadavky okamžitě vrátí ID úkolu. Dotazujte stejný koncový bod, dokud status není SUCCEEDED — nahraďte <task_id> níže ID vráceným v kroku 2.

Požadavek

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

Odpověď — 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": ""
  }
}

4Stáhněte si svůj model

Získejte model z model_urls v odpovědi výše. Každý formát (GLB, FBX, OBJ, USDZ, STL) je podepsaný, časově omezený URL — nebo přeskočte příkazový řádek a vložte URL přímo do adresního řádku prohlížeče pro stažení.

Stáhnout

model_urls.glb
curl -L "<model_urls.glb from the response above>" -o model.glb
Výsledný 3D model generovaný z ukázkové fotografie fantasy postavy
Váš výsledek

Dejte to všechno dohromady

Preferujete jeden skript, který udělá vše — vytvoří, dotazuje, stáhne?

Celý skript

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

Prozkoumejte běžné pracovní postupy


Další kroky

  • Preferujete uživatelské rozhraní? Vyzkoušejte API Playground — nakonfigurujte požadavek, spusťte jej a zkopírujte vygenerovaný kód.
  • Projděte si plnou API referenci pro každý koncový bod.
  • Zkontrolujte Ceny, Limity sazeb a Chyby předtím, než půjdete do produkce.
  • Sledujte Changelog pro aktualizace a opravy chyb.
  • Máte zpětnou vazbu nebo čelíte problémům? Připojte se k naší Discord komunitě — rádi vás uslyšíme!