Snabbstart

Börja med att skapa din API-nyckel

Varje förfrågan i denna guide behöver en. Att skapa en nyckel tar mindre än en minut.

Skapa din API-nyckel

Fyra steg till din första 3D-modell, med hjälp av Meshy REST API.


1Skaffa din API-nyckel

Skapa en API-nyckel från dina kontoinställningar — du kommer inte att kunna se den igen efter denna skärm, så lagra den någonstans säkert. Varje förfrågan autentiseras med en Bearer token i Authorization header — se Autentisering.

Öppna API-inställningar från API-menyn, skapa sedan din nyckel


2Gör din första Bild-till-3D-förfrågan

Exportera din nyckel, skapa sedan din första uppgift med Bild till 3D. Arbetar du från en textprompt eller flera foton istället? Se Text till 3D eller Flera bilder till 3D.

Exportera din nyckel

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

Varje exempel nedan använder detta foto — byt ut din egen image_url för att prova något annat.

Exempel på fantasykaraktärsillustration som används som Bild till 3D-ingång i denna guide
Exempel på ingång

Förfrågan

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

3Kontrollera uppgiftsstatus

Förfrågningar returnerar ett uppgifts-ID omedelbart. Poll samma endpoint tills status är SUCCEEDED — ersätt <task_id> nedan med ID:t som returnerades i steg 2.

Förfrågan

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

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

4Ladda ner din modell

Hämta modellen från model_urls i svaret ovan. Varje format (GLB, FBX, OBJ, USDZ, STL) är en signerad, tidsbegränsad URL — eller hoppa över kommandoraden och klistra in URL:en direkt i din webbläsares adressfält för att ladda ner den.

Ladda ner

model_urls.glb
curl -L "<model_urls.glb from the response above>" -o model.glb
Den resulterande 3D-modellen genererad från exempelbilden av fantasykaraktären
Ditt resultat

Sätt ihop allt

Föredrar du ett skript som gör allt — skapa, poll, ladda ner?

Fullständigt 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');

Utforska vanliga arbetsflöden


Nästa steg

  • Föredrar du ett användargränssnitt? Prova API Playground — konfigurera en förfrågan, kör den och kopiera den genererade koden.
  • Bläddra i hela API-referensen för varje endpoint.
  • Kontrollera Priser, Hastighetsbegränsningar och Fel innan du går till produktion.
  • Håll koll på ändringsloggen för uppdateringar och buggfixar.
  • Har du feedback eller stöter på problem? Gå med i vår Discord community — vi vill gärna höra från dig!