lowpoly bude vyřazen 30. 10. 2026. Před těmito daty přejděte na jiný model, abyste předešli chybám požadavků.

Rychlý start

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

Každý požadavek v tomto průvodci jej vyžaduje. Vytvoření klíče zabere pár vteřin.

Vytvořit 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íč na stránce API Keys v Developer Platform — po opuštění této obrazovky si ho už nebudete moct znovu zobrazit, proto si ho bezpečně uložte. Každý požadavek se autentizuje pomocí tokenu Bearer v hlavičce Authorization — viz Authentication.

Otevřete stránku API Keys v Developer Platform a poté vytvořte svůj klíč


2Vytvořte svůj první požadavek Image to 3D

Exportujte svůj klíč a poté vytvořte svůj první úkol pomocí Image to 3D. Pracujete místo toho s textovým promptem nebo více fotografiemi? Podívejte se na Text to 3D nebo Multi-Image to 3D.

Export your key

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

Každý příklad níže používá tuto fotografii — pro vyzkoušení něčeho jiného nahraďte vlastní image_url.

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

3Zkontrolujte stav úlohy

Úloha běží na pozadí a obvykle trvá několik minut. Dotazujte se opakovaně na stejný koncový bod, dokud status nebude SUCCEEDED, FAILED nebo CANCELED, přičemž níže nahraďte <task_id> ID vráceným v kroku 2. Typické časy a doporučenou dobu čekání najdete v Životním cyklu úlohy.

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

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 adresa — nebo můžete vynechat příkazovou řádku a vložit URL adresu přímo do adresního řádku prohlížeče ke stažení.

Download

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

Dejte to všechno dohromady

Preferujete jeden skript, který zvládne celý postup — vytvoření, dotazování, stažení?

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, timeout: 60_000 },
);
const taskId = created.result;

// 2. Poll until it finishes, for up to 60 minutes
const deadline = Date.now() + 60 * 60 * 1000;
let task;
while (true) {
  const { data, headers: resHeaders } = await axios.get(
    `https://api.meshy.ai/openapi/v1/image-to-3d/${taskId}`,
    { headers, timeout: 30_000 },
  );
  task = data;
  if (['SUCCEEDED', 'FAILED', 'CANCELED'].includes(task.status)) break;
  if (Date.now() > deadline) {
    // The task is still running. Check it again later with the same task ID instead of creating a new one.
    throw new Error(`Task ${taskId} is still ${task.status}; check it again later`);
  }
  const waitSeconds = Number(resHeaders['retry-after']) || 5;
  await new Promise((resolve) => setTimeout(resolve, waitSeconds * 1000));
}

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

Explore common workflows


Další kroky

  • Preferujete uživatelské rozhraní? Otevřete Developer Platform — spouštějte požadavky v Playgroundu, sledujte využití a protokoly požadavků a spravujte webhooky.
  • Prohlédněte si kompletní API reference pro každý koncový bod.
  • Učte se z praktických příkladů: postupujte podle krok za krokem receptů v Cookbook a čtěte tutoriály a příběhy o vývoji na Developer Blog.
  • Před nasazením do produkce si prostudujte Ceny, Rate Limits a Chyby.
  • Sledujte Changelog s aktualizacemi a opravami chyb.
  • Máte zpětnou vazbu nebo narazili jste na problémy? Připojte se k naší komunitě na Discord — rádi si vás vyslechneme!