Schnellstart

Beginnen Sie mit der Erstellung Ihres API-Schlüssels

Jede Anfrage in diesem Leitfaden benötigt einen. Die Erstellung eines Schlüssels dauert weniger als eine Minute.

Erstellen Sie Ihren API-Schlüssel

Vier Schritte zu Ihrem ersten 3D-Modell, mit der Meshy REST API.


1Holen Sie sich Ihren API-Schlüssel

Erstellen Sie einen API-Schlüssel aus Ihren Kontoeinstellungen — Sie können ihn nach diesem Bildschirm nicht mehr einsehen, speichern Sie ihn also an einem sicheren Ort. Jede Anfrage authentifiziert sich mit einem Bearer-Token im Authorization-Header — siehe Authentifizierung.

Öffnen Sie die API-Einstellungen aus dem API-Menü und erstellen Sie dann Ihren Schlüssel


2Machen Sie Ihre erste Bild-zu-3D-Anfrage

Exportieren Sie Ihren Schlüssel und erstellen Sie dann Ihre erste Aufgabe mit Bild zu 3D. Arbeiten Sie stattdessen mit einem Text-prompt oder mehreren Fotos? Siehe Text zu 3D oder Multi-Bild zu 3D.

Exportieren Sie Ihren Schlüssel

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

Jedes Beispiel unten verwendet dieses Foto — tauschen Sie Ihre eigene image_url ein, um etwas anderes auszuprobieren.

Beispiel einer Fantasy-Charakterillustration, die als Bild-zu-3D-Eingabe in diesem Leitfaden verwendet wird
Beispiel-Eingabe

Anfrage

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

3Überprüfen Sie den Aufgabenstatus

Anfragen geben sofort eine Aufgaben-ID zurück. Abfragen Sie denselben Endpunkt, bis status SUCCEEDED ist — ersetzen Sie <task_id> unten durch die in Schritt 2 zurückgegebene ID.

Anfrage

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

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

4Laden Sie Ihr Modell herunter

Holen Sie sich das Modell aus model_urls in der obigen Antwort. Jedes Format (GLB, FBX, OBJ, USDZ, STL) ist eine signierte, zeitlich begrenzte URL — oder überspringen Sie die Befehlszeile und fügen Sie die URL direkt in die Adressleiste Ihres Browsers ein, um sie herunterzuladen.

Download

model_urls.glb
curl -L "<model_urls.glb from the response above>" -o model.glb
Das resultierende 3D-Modell, das aus dem Beispiel-Fantasy-Charakterfoto generiert wurde
Ihr Ergebnis

Alles zusammenfügen

Bevorzugen Sie ein Skript, das alles erledigt — erstellen, abfragen, herunterladen?

Vollständiges Skript

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

Erkunden Sie gängige Workflows


Nächste Schritte

  • Bevorzugen Sie eine Benutzeroberfläche? Probieren Sie den API-Playground — konfigurieren Sie eine Anfrage, führen Sie sie aus und kopieren Sie den generierten Code.
  • Durchsuchen Sie die vollständige API-Referenz für jeden Endpunkt.
  • Überprüfen Sie Preise, Ratenlimits und Fehler, bevor Sie in die Produktion gehen.
  • Beobachten Sie das Changelog für Updates und Fehlerbehebungen.
  • Haben Sie Feedback oder Probleme? Treten Sie unserer Discord Community bei — wir würden gerne von Ihnen hören!