Rychlý start

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

Každý požadavek v této příručce jej vyžaduje. Vytvoření klíče trvá jen 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 jej již nebudete moci znovu zobrazit, takže si 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 stránku API Keys v Developer Platform a poté vytvořte svůj klíč


2Vytvořte první požadavek Obrázek na 3D

Exportujte svůj klíč a poté vytvořte svou první úlohu pomocí Obrázek na 3D. Pracujete raději s textovým promptem nebo více fotografiemi? Podívejte se na Text na 3D nebo Více obrázků na 3D.

Export your key

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

Každý níže uvedený příklad používá tuto fotografii — nahraďte vlastním image_url, pokud chcete vyzkoušet něco jiného.

Ukázková ilustrace fantasy postavy použitá jako vstup pro Obrázek na 3D v této příručce
Ukázkový vstup

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

Požadavky okamžitě vrátí ID úlohy. Dotazujte se na stejný koncový bod, dokud status nebude SUCCEEDED — nahraďte <task_id> níže ID vráceným v kroku 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": ""
  }
}

4Stáhněte si svůj model

Model získáte z model_urls v odpovědi výše. Každý formát (GLB, FBX, OBJ, USDZ, STL) je podepsaná, časově omezená URL adresa — nebo si nemusíte pouštět příkazovou řádku a stačí vložit URL adresu přímo do adresního řádku prohlížeče, abyste ji stáhli.

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ý proces — 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 },
);
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í? Otevřete Developer Platform — spouštějte požadavky v Playground, sledujte využití a protokoly požadavků a spravujte webhooky.
  • Projděte si kompletní referenci API pro všechny koncové body.
  • Než přejdete do produkce, podívejte se na Ceny, Rate Limits a Chyby.
  • Sledujte Changelog s aktualizacemi a opravami chyb.
  • Máte zpětnou vazbu nebo narazili jste na problém? Připojte se k naší komunitě na Discordu — rádi si vás poslechneme!