Bild zu 3D API

Bild zu 3D API ist eine Funktion, die es Ihnen ermöglicht, Meshy's Bild zu 3D-Fähigkeiten in Ihre eigene Anwendung zu integrieren. In diesem Abschnitt finden Sie alle Informationen, die Sie benötigen, um mit dieser API zu beginnen.

POST/openapi/v1/image-to-3d

Erstellen einer Bild zu 3D Aufgabe

Dieser Endpunkt ermöglicht es Ihnen, eine neue Bild zu 3D Aufgabe zu erstellen. Siehe Das Bild zu 3D Aufgabenobjekt, um zu sehen, welche Eigenschaften beim Bild zu 3D Aufgabenobjekt enthalten sind.

Parameter

Nur einer von input_task_id oder image_url ist erforderlich. Wenn beide angegeben sind, hat input_task_id Vorrang.

Name
input_task_id
Type
string
Erforderlich
Description
Die ID einer abgeschlossenen Bilderstellung, deren Ausgabe als Eingabebild verwendet werden soll. Diese Aufgabe muss eine der folgenden Aufgaben sein: Text zu Bild oder Bild zu Bild. Zusätzlich muss sie über die API ausgeführt worden sein, den Status SUCCEEDED haben und genau ein Bild erzeugen.

Name
image_url
Type
string
Erforderlich
Description
Stellen Sie ein Bild zur Verfügung, das Meshy zur Modellerstellung verwenden soll. Wir unterstützen derzeit die Formate .jpg, .jpeg und .png.
Es gibt zwei Möglichkeiten, das Bild bereitzustellen:
- Öffentlich zugängliche URL: Eine URL, die aus dem öffentlichen Internet zugänglich ist.
- Data URI: Eine base64-codierte Data-URI des Bildes. Beispiel einer Data-URI: data:image/jpeg;base64,<your base64-encoded image data>.

Name
model_type
Type
string
Standard standard
Description
Geben Sie den Typ der 3D-Netzerzeugung an.
Verfügbare Werte:
- standard: Reguläre hochdetaillierte 3D-Netzerzeugung.
- smart-topology: Wählen Sie ein Smart Topology-Modell mit ai_model (meshy-t1 oder meshy-t2).
- lowpoly (veraltet): Erzeugt ein Low-Poly Netz, das für saubere Polygone optimiert ist. Wir empfehlen die Verwendung von smart-topology stattdessen.
Wenn smart-topology ausgewählt ist, werden topology, should_remesh, und save_pre_remeshed_model ignoriert.
Wenn lowpoly ausgewählt ist, werden ai_model, topology, target_polycount, should_remesh, und save_pre_remeshed_model ignoriert.
Name
ai_model
Type
string
Standard latest
Description
ID des Modells, das verwendet werden soll. Die verfügbaren Werte hängen von model_type ab.
Standardgenerierung (model_type: standard):
- meshy-5, meshy-6, meshy-7, latest (Meshy 7)
Smart Topology-Generierung (model_type: smart-topology):
- meshy-t2 (standard, empfohlen): das Smart Topology-Modell — saubere topology, nativ getrennte Teile, Dreiecks-Ausgabe und eine Flächenanzahl, die Sie mit target_polycount einstellen können.
- meshy-t1: das alte Low-Poly-Modell; unterstützt das Einstellen einer Flächenanzahl mit target_polycount nicht.
Name
ultra_mode
Type
boolean
Standard false
Description
Aktiviert die Ultra-Generierung für Geometrie mit höherer Detailtreue und feineren Oberflächendetails.
Wird nur unterstützt, wenn ai_model meshy-7 (oder latest) ist.
Name
should_texture
Type
boolean
Standard true
Description
Bestimmt, ob Texturen erzeugt werden. Wenn es auf false gesetzt ist, wird die Texturphase übersprungen und ein Netz ohne Texturen bereitgestellt.

Gilt nur wenn should_texture = true

Name
enable_pbr
Type
boolean
Standard false
Description
Generieren Sie PBR-Texturen (metallisch, Rauheit, Normal Map) zusätzlich zur Basisfarbe. Eine Emissionskarte wird ebenfalls enthalten, wenn ai_model meshy-6 ist, außer bei texture_resolution: 8k. meshy-7 und latest erzeugen keine Emissionskarte.
Name
texture_resolution
Type
string
Standard 2k
Description
Basisfarbtexturauflösung. Eine von 2k (2048×2048), 4k (4096×4096) oder 8k (8192×8192). Höhere Auflösungen erfassen mehr Oberflächendetails.
4k und 8k sind nicht verfügbar mit ai_model: meshy-5. Bei 8k wird keine Emissionskarte erzeugt.
Name
hd_texture
Type
boolean
⚠ veraltet
Standard false
Description
Verwenden Sie stattdessen texture_resolution — entspricht texture_resolution: "4k". Wenn beide eingestellt sind, hat texture_resolution Vorrang.
Name
texture_prompt
Type
string
Description
Geben Sie einen Text-Prompt an, um den Texturierungsprozess zu führen. Maximal 600 Zeichen.
Name
texture_image_url
Type
string
Description
Stellen Sie ein 2D-Bild bereit, um den Texturierungsprozess zu führen. Wir unterstützen derzeit die Formate .jpg, .jpeg, und .png.
Es gibt zwei Möglichkeiten, das Bild bereitzustellen:
- Öffentlich zugängliche URL: Eine URL, die aus dem öffentlichen Internet zugänglich ist
- Data URI: Eine base64-codierte Data-URI des Bildes. Beispiel einer Data-URI: data:image/jpeg;base64,<your base64-encoded image data>
Die Bildtexturierung funktioniert möglicherweise nicht optimal, wenn es erhebliche Unterschiede in der Geometrie zwischen dem ursprünglichen Asset und dem hochgeladenen Bild gibt. Nur eines von texture_image_url oder texture_prompt kann verwendet werden, um den Texturierungsprozess zu führen. Wenn beide Parameter bereitgestellt werden, wird texture_prompt standardmäßig zur Texturierung des Modells verwendet. Die Texturierung über Text oder Bild kostet 10 Credits pro Aufgabe.

Name
should_remesh
Type
boolean
Standard false (meshy-6, meshy-7), true (andere)
Description
Steuert, ob die Neuvernetzung aktiviert werden soll. Für das qualitativ hochwertigste Modell empfehlen wir, should_remesh auf false zu setzen.

Gilt nur wenn should_remesh = true

Name
topology
Type
string
Standard triangle
Description
Geben Sie die topology des erzeugten Modells an.
Verfügbare Werte:
- quad: Erzeugt ein quadratisches dominantes Netz.
- triangle: Erzeugt ein dezimiertes Dreiecksnetz.
Name
decimation_mode
Type
integer
Description
Aktivieren Sie die adaptive Dezimierung, indem Sie ein Polygonanzahl-Level einstellen. Wenn eingestellt, wird target_polycount ignoriert.
Verfügbare Werte:
- 1: Adaptive — ultra Polygonanzahl.
- 2: Adaptive — hohe Polygonanzahl.
- 3: Adaptive — mittlere Polygonanzahl.
- 4: Adaptive — niedrige Polygonanzahl.
Name
save_pre_remeshed_model
Type
boolean
Standard false
Description
Wenn auf true gesetzt, speichert Meshy zusätzlich eine weitere GLB-Datei, bevor die Neuvernetzungsphase abgeschlossen ist.

Name
target_polycount
Type
integer
Description
Zielanzahl der Polygone (Flächen) in der Ausgabe. Die tatsächliche Anzahl kann von der Zielvorgabe abweichen, abhängig von der Geometrie.
target_polycount tritt in zwei unabhängigen Fällen in Kraft:
- Neuvernetzung — mit should_remesh: true auf einem standard Modell. Das Netz wird bis auf etwa diese Zahl remesht (dezimiert). Bereich 100 bis 300,000, Standard 30,000. Wenn decimation_mode eingestellt ist, hat es Vorrang und target_polycount wird ignoriert.
- Smart Topology — mit model_type: smart-topology und ai_model: meshy-t2. Das Modell wird direkt bei dieser Flächenanzahl erstellt; es erfolgt keine Neuvernetzung und should_remesh ist nicht erforderlich. Bereich 100 bis 15,000, Standard 4,000.

Name
symmetry_mode
Type
string
⚠ veraltet
Standard auto
Description
Veraltet. Dieser Parameter beeinflusst die Ausgabe nicht mehr.
Das Feld symmetry_mode steuert das Verhalten der Symmetrie während des Modellerstellungsprozesses.
Die gültigen Werte sind:
- off: Deaktiviert die Symmetrie.
- auto: Bestimmt und wendet automatisch Symmetrie basierend auf der Eingabegeometrie an.
- on: Erzwingt die Symmetrie während der Erstellung.
Name
pose_mode
Type
string
Standard ""
Description
Geben Sie den Pose-Modus für das erzeugte Modell an.
Verfügbare Werte:
- a-pose: Erzeugt das Modell in einer A-Pose.
- t-pose: Erzeugt das Modell in einer T-Pose.
- "" (leer): Es wird keine spezifische Pose angewandt.
Name
is_a_t_pose
Type
boolean
⚠ veraltet
Standard false
Description
Verwenden Sie stattdessen pose_mode. Ob das Modell in einer A/T-Pose erzeugt werden soll.
Name
image_enhancement
Type
boolean
Standard true
Description
Optimiert das Eingabebild für bessere Ergebnisse. Setzen Sie auf false, um das genaue Erscheinungsbild des Eingabebildes ohne Stilprozessierung zu bewahren.
Wird nur unterstützt, wenn ai_model meshy-6, meshy-7 oder latest ist.
Name
remove_lighting
Type
boolean
Standard true
Description
Entfernt Hervorhebungen und Schatten aus der Basisfarb-Textur, wodurch ein saubereres Ergebnis erzielt wird, das besser unter benutzerdefinierten Lichtverhältnissen funktioniert.
Wird nur unterstützt, wenn ai_model meshy-6 ist.
Name
moderation
Type
boolean
Standard false
Description
Wenn auf true gesetzt, wird der eingehende Inhalt automatisch auf potenziell schädlichen Inhalt überprüft. Wenn schädlicher Inhalt erkannt wird, wird die Aufgabe nicht zur Erstellung fortgesetzt.
Der Inhalt der Eingaben image_url, texture_image_url, und texture_prompt wird überprüft.
Name
target_formats
Type
string[]
Description
Gibt an, welche 3D-Dateiformate in der Ausgabe enthalten sein sollen. Nur die angeforderten Formate werden erzeugt und zurückgegeben, was die Abschlusszeit der Aufgabe verkürzen kann. Wenn weggelassen, sind alle unterstützten Formate enthalten.
Verfügbare Werte: glb, obj, fbx, stl, usdz, 3mf
Wenn weggelassen, werden alle Formate außer 3mf erzeugt. 3mf wird nur eingeschlossen, wenn es ausdrücklich angegeben wird.
Name
auto_size
Type
boolean
Standard false
Description
Wenn auf true gesetzt, verwendet der Dienst AI-Vision, um die reale Höhe des Objekts automatisch zu schätzen und das Modell entsprechend zu skalieren. Der Ursprung wird standardmäßig auf bottom gesetzt, es sei denn, origin_at wird explizit festgelegt.
Name
alpha_thumbnail
Type
boolean
Standard false
Description
Wenn auf true gesetzt, rendert die Aufgabe zusätzlich eine transparente Hintergrundversion (RGBA) der Vorschau und gibt sie als alpha_thumbnail_url in der GET-Antwort zurück. Das bestehende thumbnail_url-Feld bleibt unverändert.
Name
multi_view_thumbnails
Type
boolean
Standard false
Description
Wenn auf true gesetzt, rendert die Aufgabe zusätzlich vier Kardinalansichts-Miniaturansichten (Vorderansicht, rechte Seite, Rückansicht, linke Seite) und gibt sie unter thumbnail_urls in der GET-Antwort zurück. Das bestehende thumbnail_url-Feld bleibt unverändert und verweist weiterhin auf die Vorderansicht, sodass bestehende Clients nicht betroffen sind.
Fügt der Aufgabenlatenz ca. 3 Sekunden hinzu.

Gilt nur wenn auto_size = true

Name
origin_at
Type
string
Standard bottom
Description
Position des Ursprungs, wenn auto_size aktiviert ist.
Verfügbare Werte: bottom, center.

Rückgabe

Die result-Eigenschaft der Antwort enthält die Aufgaben-ID der neu erstellten Bild zu 3D Aufgabe.

Fehlermodi

Name
400 - Bad Request
Description
Die Anfrage war nicht akzeptabel. Häufige Ursachen:
- Fehlender Parameter: Entweder image_url oder input_task_id muss angegeben werden.
- Ungültige Eingabeaufgabe: Die input_task_id muss auf eine SUCCEEDED Text zu Bild oder Bild zu Bild Aufgabe verweisen, die genau ein Bild produziert.
- Ungültiges Bildformat: Die angegebene image_url ist kein unterstütztes Format (.jpg, .jpeg, .png).
- Nicht erreichbare URL: Die image_url konnte nicht heruntergeladen werden (404 oder timeout).
- Ungültiger Data URI: Der base64-String ist unformatiert.
- Ungültige Parameterkombination: enable_pbr wird nur unterstützt, wenn should_texture wahr ist.
Name
401 - Unauthorized
Description
Authentifizierung fehlgeschlagen. Bitte überprüfen Sie Ihren API-Schlüssel.
Name
402 - Payment Required
Description
Nicht genügend Credits, um diese Aufgabe auszuführen.
Name
429 - Too Many Requests
Description
Sie haben Ihre Ratenbegrenzung überschritten.

Anfrage

POST

/openapi/v1/image-to-3d

# Einfache Anfrage mit erforderlichen Parametern
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

# Mit remesh, PBR und A-Pose
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Antwort

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/image-to-3d/:id

Abrufen einer Bild zu 3D Aufgabe

Dieser Endpunkt ermöglicht es Ihnen, eine Bild zu 3D Aufgabe über eine gültige Aufgaben-ID abzurufen. Siehe Das Bild zu 3D Aufgabenobjekt, um zu sehen, welche Eigenschaften beim Bild zu 3D Aufgabenobjekt enthalten sind.

Parameter

Name
id
Type
path
Description
Eindeutiger Bezeichner für die Bild zu 3D Aufgabe zur Abfrage.

Rückgabe

Die Antwort enthält das Bild zu 3D Aufgabenobjekt. Details finden Sie im Abschnitt Das Bild zu 3D Aufgabenobjekt.

Anfrage

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Antwort

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

DELETE/openapi/v1/image-to-3d/:id

Löschen einer Bild zu 3D Aufgabe

Dieser Endpunkt löscht dauerhaft eine Bild zu 3D Aufgabe, einschließlich aller zugehörigen Modelle und Daten. Diese Aktion ist unwiderruflich.

Pfadparameter

Name
id
Type
path
Description
Die ID der Bild zu 3D Aufgabe, die gelöscht werden soll.

Rückgabe

Gibt bei Erfolg 200 OK zurück.

Anfrage

DELETE

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Antwort

// Gibt bei Erfolg 200 Ok zurück.

GET/openapi/v1/image-to-3d

Bild zu 3D Aufgaben auflisten

Dieser Endpunkt ermöglicht es Ihnen, eine Liste mit Bild zu 3D Aufgaben abzurufen.

Parameter

Optionale Attribute

Name
page_num
Type
integer
Description
Seitennummer zur Paginierung. Beginnt und ist standardmäßig 1.
Name
page_size
Type
integer
Description
Seitenlimitgröße. Standard ist 10 Elemente. Maximal erlaubt sind 50 Elemente.
Name
sort_by
Type
string
Description
Feld zum Sortieren. Verfügbare Werte:
- +created_at: Nach Erstellungszeit in aufsteigender Reihenfolge sortieren.
- -created_at: Nach Erstellungszeit in absteigender Reihenfolge sortieren.

Rückgabe

Gibt eine paginierte Liste der Bild zu 3D Aufgabenobjekte zurück.

Anfrage

GET

/openapi/v1/image-to-3d

curl https://api.meshy.ai/openapi/v1/image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Antwort

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-3d",
    "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=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {
      "message": ""
    },
    "consumed_credits": 30
  }
]

GET/openapi/v1/image-to-3d/:id/stream

Streaming einer Bild zu 3D Aufgabe

Dieser Endpunkt streamt Echtzeit-Updates für eine Bild zu 3D Aufgabe unter Verwendung von Server-Sent Events (SSE).

Parameter

Name
id
Type
path
Description
Eindeutiger Bezeichner für die Bild zu 3D Aufgabe zum Streamen.

Rückgabe

Gibt einen Stream der Bild zu 3D Aufgabenobjekte als Server-Sent Events zurück.

Für PENDING oder IN_PROGRESS Aufgaben enthält der Antwortstream nur die erforderlichen progress und status Felder.

Anfrage

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Antwortstream

// Fehlerereignisbeispiel
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Nachrichtenereignisbeispiele illustrieren den Fortschritt der Aufgabe.
// Bei PENDING- oder IN_PROGRESS-Aufgaben enthält der Antwortstream nicht alle Felder.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
  "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
  "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
  "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

Das Bild zu 3D Aufgabenobjekt

Das Bild zu 3D Aufgabenobjekt ist eine Arbeitseinheit, die Meshy zur Erzeugung eines 3D-Modells aus einer Bild-Eingabe verfolgt. Das Objekt hat die folgenden Eigenschaften:

Eigenschaften

Name
id
Type
string
Description
Eindeutiger Bezeichner für die Aufgabe. Während wir eine k-sortierbare UUID für Aufgaben-IDs als Implementierungsdetail verwenden, sollten Sie keine Annahmen über das Format der ID machen.
Name
type
Type
string
Description
Typ der Bild zu 3D Aufgabe. Der Wert ist image-to-3d.
Name
model_urls
Type
object
Description
Herunterladbare URL zur texturierten 3D-Modell-Datei, die von Meshy generiert wurde. Die Eigenschaft für ein Format wird weggelassen, wenn das Format nicht erstellt wird, anstatt einen leeren String zurückzugeben.
- Name
  glb
  Type
  string
  Description
  Herunterladbare URL zur GLB-Datei.
- Name
  fbx
  Type
  string
  Description
  Herunterladbare URL zur FBX-Datei.
- Name
  obj
  Type
  string
  Description
  Herunterladbare URL zur OBJ-Datei.
- Name
  usdz
  Type
  string
  Description
  Herunterladbare URL zur USDZ-Datei.
- Name
  mtl
  Type
  string
  Description
  Herunterladbare URL zur MTL-Datei, die zusammen mit OBJ-Exporten zurückgegeben wird, wenn Texturen vorhanden sind.
- Name
  stl
  Type
  string
  Description
  Herunterladbare URL zur STL-Datei.
- Name
  3mf
  Type
  string
  Description
  Herunterladbare URL zur 3MF-Datei. Nur vorhanden, wenn 3mf über target_formats angefordert wurde.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Herunterladbare URL zur ursprünglichen GLB-Ausgabe vor der Neuvernetzung.
  Nur verfügbar, wenn die Aufgabe mit should_remesh: true und save_pre_remeshed_model: true erstellt wurde.
Name
thumbnail_url
Type
string
Description
Herunterladbare URL zum Miniaturbild der Modell-Datei. Entspricht thumbnail_urls.front, wenn vorhanden, um abwärtskompatibel zu bleiben.
Name
alpha_thumbnail_url
Type
string
Description
Herunterladbare URL zur Version mit transparentem Hintergrund (RGBA) von thumbnail_url. Nur vorhanden, wenn die Aufgabe mit alpha_thumbnail: true erstellt wurde und die transparente Vorschau erfolgreich gerendert wurde; andernfalls wird dieses Feld weggelassen.
Name
thumbnail_urls
Type
object
Description
Herunterladbare URLs für vier Kardinalansichts-Miniaturansichten des generierten 3D-Modells. Jeder Wert ist eine signierte URL zu einem 512×512 PNG, das mit den gleichen Materialien und Beleuchtungen wie thumbnail_url gerendert wurde. Nützlich, um das Modell aus mehreren Winkeln in Batch-Pipelines anzuzeigen, ohne das GLB herunterzuladen.
Nur vorhanden, wenn die Aufgabe mit multi_view_thumbnails: true erstellt wurde und SUCCEEDED erreicht hat. Ältere Aufgaben und Aufgaben, die ohne Opt-in erstellt wurden, enthalten dieses Feld nicht.
- Name
  front
  Type
  string
  Description
  Vorderansicht, 0°-Drehung um die vertikale Achse (entspricht thumbnail_url).
- Name
  right
  Type
  string
  Description
  Rechte Ansicht, 90°-Drehung.
- Name
  back
  Type
  string
  Description
  Rückansicht, 180°-Drehung.
- Name
  left
  Type
  string
  Description
  Linke Ansicht, 270°-Drehung.
Name
texture_prompt
Type
string
Description
Der Text-Prompt, der verwendet wurde, um den Texturierungsprozess zu führen.
Name
texture_image_url
Type
string
Description
Herunterladbare URL zum Texturbild, das verwendet wurde, um den Texturierungsprozess zu führen.
Name
ultra_mode
Type
boolean
Description
Spiegelt den Wert von ultra_mode wider, mit dem die Aufgabe erstellt wurde. Nur vorhanden für meshy-7 (oder latest) Aufgaben, die ultra_mode explizit gesetzt haben; andernfalls wird dieses Feld weggelassen.
Name
progress
Type
integer
Description
Fortschritt der Aufgabe. Wenn die Aufgabe noch nicht gestartet wurde, beträgt dieser Wert 0. Sobald die Aufgabe erfolgreich abgeschlossen ist, wird dieser Wert 100.
Name
started_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe gestartet wurde, in Millisekunden. Wenn die Aufgabe noch nicht gestartet wurde, beträgt dieser Wert 0.
Ein Zeitstempel repräsentiert die Anzahl der Millisekunden, die seit dem 1. Januar 1970 UTC vergangen sind. Dies folgt dem RFC 3339 Standard. Zum Beispiel wird Freitag, der 1. September 2023 12:00:00 PM GMT als 1693569600000 dargestellt. Dies gilt für alle Zeitstempel in der Meshy API.
Name
created_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe erstellt wurde, in Millisekunden.
Name
expires_at
Type
timestamp
Description
Zeitstempel, wann das Arbeitsergebnis abläuft, in Millisekunden.
Name
finished_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe beendet wurde, in Millisekunden. Wenn die Aufgabe noch nicht abgeschlossen ist, beträgt dieser Wert 0.
Name
status
Type
string
Description
Status der Aufgabe. Mögliche Werte sind einer von PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Ein Array von Textur-URL-Objekten, die durch den Auftrag generiert wurden. Normalerweise enthält dies nur eine Textur-URL-Objekt. Jede Textur-URL hat die folgenden Eigenschaften:
- Name
  base_color
  Type
  string
  Description
  Herunterladbare URL zum Basisfarbkartenbild.
- Name
  metallic
  Type
  string
  Description
  Herunterladbare URL zum metallischen Kartenbild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wird, wird diese Eigenschaft weggelassen.
- Name
  normal
  Type
  string
  Description
  Herunterladbare URL zum Normal Map Bild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wird, wird diese Eigenschaft weggelassen.
- Name
  roughness
  Type
  string
  Description
  Herunterladbare URL zum Rauheitskartenbild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wird, wird diese Eigenschaft weggelassen.
- Name
  emission
  Type
  string
  Description
  Herunterladbare URL zum Emissionskartenbild.
  Wenn die Aufgabe mit enable_pbr: false, oder ai_model meshy-5, meshy-7, oder latest ist, wird diese Eigenschaft weggelassen.
Name
preceding_tasks
Type
integer
Description
Die Anzahl der vorausgehenden Aufgaben.
Der Wert dieses Feldes ist nur dann aussagekräftig, wenn der Aufgabenstatus PENDING ist.
Name
task_error
Type
object
Description
Fehlerdetails für fehlgeschlagene Aufgaben. Siehe Fehler für die vollständige task_error-Objektreferenz.
Name
consumed_credits
Type
integer
Description
Die Anzahl der durch diese Aufgabe verbrauchten Credits. Präsent, wenn der Aufgabenstatus PENDING, IN_PROGRESS, oder SUCCEEDED ist. Gibt 0 für FAILED Aufgaben zurück (Credits werden bei einem Fehler zurückerstattet).

Beispiel Bild zu 3D Aufgabenobjekt

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "texture_image_url": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}