Schnellstart

Beginnen Sie mit der Erstellung Ihres API-Schlüssels

Jede Anfrage in diesem Leitfaden benötigt einen. Die Erstellung eines Schlüssels dauert nur wenige Sekunden.

API-Schlüssel erstellen

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 auf der Seite API Keys in der Developer Platform – Sie können ihn nach diesem Bildschirm nicht erneut einsehen, bewahren Sie ihn also an einem sicheren Ort auf. Jede Anfrage authentifiziert sich mit einem Bearer-Token im Authorization-Header – siehe Authentifizierung.

Öffnen Sie die Seite „API Keys“ in der Developer Platform und erstellen Sie dann Ihren Schlüssel


2Stellen 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.

Export your key

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

Jedes Beispiel unten verwendet dieses Foto – tauschen Sie es gegen Ihre eigene image_url aus, um etwas anderes auszuprobieren.

Beispielhafte Fantasy-Charakter-Illustration, die in diesem Leitfaden als Bild-zu-3D-Eingabe verwendet wird
Beispieleingabe

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

3Aufgabenstatus prüfen

Anfragen liefern sofort eine Task-ID zurück. Fragen Sie denselben Endpunkt ab, bis status gleich SUCCEEDED ist – ersetzen Sie unten <task_id> durch die in Schritt 2 zurückgegebene ID.

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

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 Kommandozeile 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 Beispielfoto des Fantasy-Charakters generiert wurde
Ihr Ergebnis

Alles zusammenfügen

Bevorzugen Sie ein einziges Skript, das den gesamten Vorgang übernimmt – erstellen, abfragen, herunterladen?

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

Gängige Workflows erkunden


Nächste Schritte

  • Bevorzugen Sie eine Benutzeroberfläche? Öffnen Sie die Developer Platform – führen Sie Anfragen im Playground aus, verfolgen Sie die Nutzung und Anfrageprotokolle und verwalten Sie Webhooks.
  • Durchsuchen Sie die vollständige API-Referenz für jeden Endpunkt.
  • Prüfen Sie Preise, Rate Limits und Fehler, bevor Sie in den Produktivbetrieb gehen.
  • Behalten Sie den Changelog für Updates und Fehlerbehebungen im Blick.
  • Haben Sie Feedback oder Probleme? Treten Sie unserer Discord-Community bei – wir freuen uns, von Ihnen zu hören!