Bild zu 3D API

Die Bild zu 3D API ist eine Funktion, die es Ihnen ermöglicht, Meshys 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

Eine Bild-zu-3D-Aufgabe erstellen

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 im Bild-zu-3D-Aufgabenobjekt enthalten sind.

Parameter

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

Name
input_task_id
Type
string
Erforderlich
Description
Die ID einer abgeschlossenen Bildgenerierungsaufgabe, deren Ausgabe als Eingabebild verwendet werden soll. Diese Aufgabe muss eine der folgenden 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 Meshy ein Bild zur Verfügung, das bei der Modellerstellung verwendet werden 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 erreichbar ist.
- Data URI: Ein base64-kodierter Data URI des Bildes. Beispiel für einen Data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Name
model_type
Type
string
Standard standard
Description
Geben Sie die Art 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-t2).
- lowpoly (veraltet): Erzeugt ein Low-Poly-Netz, das für sauberere Polygone optimiert ist. Wir empfehlen stattdessen die Verwendung von smart-topology.
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 zu verwendenden Modells. Die verfügbaren Werte hängen von model_type ab.
Standarderzeugung (model_type: standard):
- meshy-5, meshy-6, meshy-7, latest (Meshy 7)
Smart-Topology-Erzeugung (model_type: smart-topology):
- meshy-t2 (Standard): das Smart-Topology-Modell — sauberere topology, nativ getrennte Teile, Dreiecksausgabe und eine Flächenanzahl, die Sie mit target_polycount festlegen können.
Name
ultra_mode
Type
boolean
Standard false
Description
Aktiviert die Ultra-Generierung für höherwertige Geometrie mit feineren Oberflächendetails.
Nur unterstützt, wenn ai_model den Wert meshy-7 (oder latest) hat.
Name
should_texture
Type
boolean
Standard true
Description
Bestimmt, ob Texturen erzeugt werden. Wenn dies auf false gesetzt wird, wird die Texturphase übersprungen, wodurch ein Netz ohne Texturen entsteht.

Gilt nur wenn should_texture = true

Name
enable_pbr
Type
boolean
Standard false
Description
Erzeugt zusätzlich zur Basisfarbe PBR-Texturen (Metallic, Roughness, Normal). Eine Emission Map wird ebenfalls einbezogen, wenn ai_model den Wert meshy-6 hat, außer bei texture_resolution: 8k. meshy-7 und latest erzeugen keine Emission Map.
Name
texture_resolution
Type
string
Standard 2k
Description
Auflösung der Basisfarbtextur. Eine von 2k (2048×2048), 4k (4096×4096) oder 8k (8192×8192). Höhere Auflösungen erfassen mehr Oberflächendetails.
4k und 8k sind bei ai_model: meshy-5 nicht verfügbar. Bei 8k wird keine Emission Map erzeugt.
Name
hd_texture
Type
boolean
⚠ veraltet
Standard false
Description
Verwenden Sie stattdessen texture_resolution — entspricht texture_resolution: "4k". Wenn beide gesetzt sind, hat texture_resolution Vorrang.
Name
texture_prompt
Type
string
Description
Geben Sie einen Text-prompt an, um den Texturierungsprozess zu steuern. Maximal 800 Zeichen.
Name
texture_image_url
Type
string
Description
Stellen Sie ein 2D-Bild bereit, um den Texturierungsprozess zu steuern. 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 erreichbar ist
- Data URI: Ein base64-kodierter Data URI des Bildes. Beispiel für einen Data URI: data:image/jpeg;base64,<your base64-encoded image data>
Die Bildtexturierung funktioniert möglicherweise nicht optimal, wenn erhebliche Geometrieunterschiede zwischen dem ursprünglichen Asset und dem hochgeladenen Bild bestehen. Nur eines von texture_image_url oder texture_prompt kann verwendet werden, um den Texturierungsprozess zu steuern. Wenn beide Parameter angegeben werden, wird standardmäßig texture_prompt zur Texturierung des Modells verwendet. Die Texturierung per Text oder Bild kostet 10 Credits pro Aufgabe.

Name
should_remesh
Type
boolean
Standard false (meshy-6, meshy-7), true (others)
Description
Steuert, ob die Neuvernetzungsphase aktiviert wird. 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 überwiegend aus Quads bestehendes Netz.
- triangle: Erzeugt ein dezimiertes Dreiecksnetz.
Name
decimation_mode
Type
integer
Description
Aktiviert die adaptive Dezimierung durch Festlegen einer Polygonanzahl-Stufe. Wenn gesetzt, wird target_polycount ignoriert.
Verfügbare Werte:
- 1: Adaptiv — Ultra-Polygonanzahl.
- 2: Adaptiv — hohe Polygonanzahl.
- 3: Adaptiv — mittlere Polygonanzahl.
- 4: Adaptiv — 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 je nach Geometrie vom Zielwert abweichen.
target_polycount wirkt sich in zwei unabhängigen Fällen aus:
- Neuvernetzung — mit should_remesh: true bei einem standard-Modell. Das Netz wird auf ungefähr diese Anzahl neu vernetzt (dezimiert). Bereich 100 bis 300.000, Standard 30.000. Wenn decimation_mode gesetzt ist, hat dies Vorrang und target_polycount wird ignoriert.
- Smart Topology — mit model_type: smart-topology und ai_model: meshy-t2. Das Modell wird direkt mit dieser Flächenanzahl erzeugt; es findet keine Neuvernetzung statt, 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 wirkt sich nicht mehr auf die Ausgabe aus.
Das Feld symmetry_mode steuert das Symmetrieverhalten während des Modellerzeugungsprozesses.
Die gültigen Werte sind:
- off: Deaktiviert die Symmetrie.
- auto: Bestimmt und wendet Symmetrie automatisch basierend auf der Eingabegeometrie an.
- on: Erzwingt Symmetrie während der Erzeugung.
Name
pose_mode
Type
string
Standard ""
Description
Geben Sie den pose_mode 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.
- "" (leerer String): Keine bestimmte Pose angewendet.
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 den Wert auf false, um das exakte Erscheinungsbild des Eingabebilds ohne jegliche Stilverarbeitung beizubehalten.
Nur unterstützt, wenn ai_model den Wert meshy-6, meshy-7 oder latest hat.
Name
remove_lighting
Type
boolean
Standard true
Description
Entfernt Glanzlichter und Schatten aus der Basisfarbtextur, wodurch ein saubereres Ergebnis entsteht, das unter individuellen Beleuchtungseinstellungen besser funktioniert.
Nur unterstützt, wenn ai_model den Wert meshy-6 hat.
Name
moderation
Type
boolean
Standard false
Description
Wenn auf true gesetzt, wird der Eingabeinhalt automatisch auf potenziell schädliche Inhalte überprüft. Wird schädlicher Inhalt erkannt, wird die Aufgabe nicht zur Erzeugung 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 Bearbeitungszeit der Aufgabe verkürzen kann. Wenn dieser Parameter weggelassen wird, werden alle unterstützten Formate einbezogen.
Verfügbare Werte: glb, obj, fbx, stl, usdz, 3mf
Wenn dieser Parameter weggelassen wird, werden alle Formate außer 3mf erzeugt. 3mf wird nur einbezogen, wenn es ausdrücklich angegeben wird.
Name
auto_size
Type
boolean
Standard false
Description
Wenn auf true gesetzt, verwendet der Dienst KI-Vision, um die reale Höhe des Objekts automatisch zu schätzen und das Modell entsprechend in der Größe anzupassen. Der Ursprung wird standardmäßig auf bottom gesetzt, sofern origin_at nicht ausdrücklich festgelegt ist.
Name
alpha_thumbnail
Type
boolean
Standard false
Description
Wenn auf true gesetzt, rendert die Aufgabe zusätzlich eine Vorschauversion mit transparentem Hintergrund (RGBA) und gibt diese als alpha_thumbnail_url in der GET-Antwort zurück. Das bestehende Feld thumbnail_url bleibt unverändert.
Name
multi_view_thumbnails
Type
boolean
Standard false
Description
Wenn auf true gesetzt, rendert die Aufgabe zusätzlich vier Kardinalansichts-Miniaturbilder (vorne, rechts, hinten, links) und gibt diese unter thumbnail_urls in der GET-Antwort zurück. Das bestehende Feld thumbnail_url bleibt unverändert und verweist weiterhin auf die Frontansicht, sodass bestehende Clients nicht betroffen sind.
Fügt der Aufgabenlatenz etwa 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ückgabewerte

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

Fehlerarten

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

Request

POST

/openapi/v1/image-to-3d

# Simple request with required params
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>"
  }'

# With remesh, PBR, and 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"]
  }'

Response

{
  "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 abzurufen, wenn eine gültige Aufgaben-id angegeben wird. Siehe Das Bild zu 3D Aufgabenobjekt, um zu sehen, welche Eigenschaften im Bild zu 3D Aufgabenobjekt enthalten sind.

Parameter

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

Rückgabe

Die Antwort enthält das Bild zu 3D Aufgabenobjekt. Überprüfen Sie den Abschnitt Das Bild zu 3D Aufgabenobjekt für Details.

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ückgaben

Gibt 200 OK bei Erfolg 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

// Returns 200 Ok on success.

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

Bild zu 3D Aufgaben auflisten

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

Parameter

Optionale Attribute

Name
page_num
Type
integer
Description
Seitennummer für die Paginierung. Beginnt und standardmäßig auf 1.
Name
page_size
Type
integer
Description
Begrenzung der Seitengröße. Standardmäßig auf 10 Elemente. Maximal erlaubt sind 50 Elemente.
Name
sort_by
Type
string
Description
Feld zum Sortieren. Verfügbare Werte:
- +created_at: Sortierung nach Erstellungszeit in aufsteigender Reihenfolge.
- -created_at: Sortierung nach Erstellungszeit in absteigender Reihenfolge.

Rückgaben

Gibt eine paginierte Liste von Die Bild zu 3D Aufgaben Objekte 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

Streamen 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ückgaben

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

Für PENDING oder IN_PROGRESS Aufgaben wird der Antwortstream nur die notwendigen progress und status Felder enthalten.

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

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

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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 verfolgt, um ein 3D-Modell aus einem Bild-Eingang zu generieren. 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 generiert 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 dem Remeshing.
  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, und wird aus Gründen der Abwärtskompatibilität beibehalten.
Name
alpha_thumbnail_url
Type
string
Description
Herunterladbare URL zu einer Version von thumbnail_url mit transparentem Hintergrund (RGBA). 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-Miniaturen des generierten 3D-Modells. Jeder Wert ist eine signierte URL zu einem 512×512 PNG, das mit denselben Materialien und Beleuchtung wie thumbnail_url gerendert wurde. Nützlich, um das Modell aus mehreren Blickwinkeln in Batch-Pipelines zu betrachten, 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 leiten.
Name
texture_image_url
Type
string
Description
Herunterladbare URL zum Texturbild, das verwendet wurde, um den Texturierungsprozess zu leiten.
Name
ultra_mode
Type
boolean
Description
Gibt den ultra_mode-Wert wieder, mit dem die Aufgabe erstellt wurde. Nur vorhanden für meshy-7 (oder latest) Aufgaben, die ultra_mode explizit gesetzt haben; andernfalls weggelassen.
Name
progress
Type
integer
Description
Fortschritt der Aufgabe. Wenn die Aufgabe noch nicht gestartet ist, wird diese Eigenschaft 0 sein. Sobald die Aufgabe erfolgreich abgeschlossen ist, wird dies 100 sein.
Name
started_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe gestartet wurde, in Millisekunden. Wenn die Aufgabe noch nicht gestartet ist, wird diese Eigenschaft 0 sein.
Ein Zeitstempel stellt die Anzahl der Millisekunden dar, die seit dem 1. Januar 1970 UTC vergangen sind, gemäß dem RFC 3339-Standard. Zum Beispiel wird Freitag, der 1. September 2023, 12:00:00 Uhr 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 Ergebnis der Aufgabe abläuft, in Millisekunden.
Name
finished_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe abgeschlossen wurde, in Millisekunden. Wenn die Aufgabe noch nicht abgeschlossen ist, wird diese Eigenschaft 0 sein.
Name
status
Type
string
Description
Status der Aufgabe. Mögliche Werte sind PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Ein Array von Textur-URL-Objekten, die aus der Aufgabe generiert wurden. Normalerweise enthält dies nur ein Textur-URL-Objekt. Jede Textur-URL hat die folgenden Eigenschaften:
- Name
  base_color
  Type
  string
  Description
  Herunterladbare URL zum Basisfarb-Kartenbild.
- Name
  metallic
  Type
  string
  Description
  Herunterladbare URL zum metallischen Kartenbild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wurde, wird diese Eigenschaft weggelassen.
- Name
  normal
  Type
  string
  Description
  Herunterladbare URL zum Normal Map-Bild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wurde, wird diese Eigenschaft weggelassen.
- Name
  roughness
  Type
  string
  Description
  Herunterladbare URL zum Rauheitskartenbild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wurde, wird diese Eigenschaft weggelassen.
- Name
  emission
  Type
  string
  Description
  Herunterladbare URL zum Emissionskartenbild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wurde oder ai_model meshy-5, meshy-7 oder latest ist, wird diese Eigenschaft weggelassen.
Name
preceding_tasks
Type
integer
Description
Die Anzahl der vorhergehenden Aufgaben.
Der Wert dieses Feldes ist nur sinnvoll, 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 von dieser Aufgabe verbrauchten Credits. Vorhanden, 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
}