Die Multi-Image-to-3D-API ist eine Funktion, mit der du Meshys Multi-Image-to-3D-Funktionen in deine eigene Anwendung integrieren kannst. In diesem Abschnitt findest du alle Informationen,
die du benötigst, um mit dieser API zu beginnen.
Dieser endpoint ermöglicht es Ihnen, eine neue Multi-Image-to-3D-Aufgabe zu erstellen. Siehe
Das Multi-Image-to-3D-Aufgabenobjekt, um zu sehen, welche
Eigenschaften im Multi-Image-to-3D-Aufgabenobjekt enthalten sind.
Parameter
Nur eines von input_task_id oder image_urls 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 (1–4 Bilder) als Eingabe verwendet werden soll. Diese Aufgabe muss eine der folgenden Aufgaben sein: Text to Image, Image to Image, Text to Image Multi-View oder Image to Image Multi-View. Außerdem muss sie über die API ausgeführt worden sein und den Status SUCCEEDED haben.
Name
image_urls
Type
array
Erforderlich
Description
Stellen Sie 1 bis 4 Bilder bereit, die Meshy zur Modellerstellung verwenden soll. Derzeit unterstützen wir die Formate .jpg, .jpeg und .png. Für beste Ergebnisse sollten alle Bilder dasselbe Objekt aus verschiedenen Winkeln zeigen.
Es gibt zwei Möglichkeiten, jedes Bild bereitzustellen:
Öffentlich zugängliche URL: Eine URL, die über das öffentliche Internet zugänglich ist.
Data URI: Eine base64-codierte Data URI des Bildes. Beispiel für eine Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
ai_model
Type
string
Standard latest
Description
ID des zu verwendenden Modells. Verfügbare Werte: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
Standard true
Description
Bestimmt, ob Texturen generiert werden. Wenn dies auf false gesetzt wird, wird die Texturphase übersprungen und ein Mesh ohne Texturen bereitgestellt.
Gilt nur wenn should_texture = true
Name
enable_pbr
Type
boolean
Standard false
Description
Generiert zusätzlich zur Basisfarbe PBR-Maps (Metallic, Roughness, Normal). Eine Emissions-Map ist ebenfalls enthalten, wenn ai_modelmeshy-6 oder latest ist.
Name
hd_texture
Type
boolean
Standard false
Description
Generiert die Basisfarb-Textur mit 4K-Auflösung (4096×4096) für höhere Detailgenauigkeit.
Nur unterstützt, wenn ai_modelmeshy-6 oder latest ist. PBR-Maps werden immer mit 2K generiert.
Name
texture_prompt
Type
string
Description
Geben Sie einen Text-Prompt an, um den Texturierungsprozess zu steuern. Maximal 600 Zeichen.
Name
texture_image_url
Type
string
Description
Geben Sie ein 2D-Bild an, um den Texturierungsprozess zu steuern. Derzeit unterstützen wir die Formate .jpg, .jpeg und .png.
Es gibt zwei Möglichkeiten, das Bild bereitzustellen:
Öffentlich zugängliche URL: Eine URL, die über das öffentliche Internet zugänglich ist
Data URI: Eine base64-codierte Data URI des Bildes. Beispiel für eine Data URI: data:image/jpeg;base64,<your base64-encoded image data>
Die Bildtexturierung funktioniert möglicherweise nicht optimal, wenn es erhebliche Geometrieunterschiede zwischen dem ursprünglichen Asset und dem hochgeladenen Bild gibt. Nur eines von texture_image_url oder texture_prompt darf verwendet werden, um den Texturierungsprozess zu steuern. Wenn beide Parameter angegeben werden, wird standardmäßig texture_prompt zum Texturieren des Modells verwendet.
Name
should_remesh
Type
boolean
Standard false (meshy-6), true (others)
Description
Steuert, ob die Remesh-Phase aktiviert wird. Wenn dies auf false gesetzt ist, gibt die API das Dreiecks-Mesh mit der höchsten Präzision zurück.
Gilt nur wenn should_remesh = true
Name
topology
Type
string
Standard triangle
Description
Geben Sie die Topologie des generierten Modells an.
Verfügbare Werte:
quad: Generiert ein Quad-dominantes Mesh.
triangle: Generiert ein reduziertes Dreiecks-Mesh.
Name
target_polycount
Type
integer
Standard 30,000
Description
Geben Sie die Zielanzahl von Polygonen im generierten Modell an. Die tatsächliche Anzahl der Polygone kann je nach Komplexität der Geometrie vom Zielwert abweichen.
Der gültige Wertebereich variiert je nach Nutzerstufe:
100 bis 300.000 (einschließlich)
Name
decimation_mode
Type
integer
Description
Aktivieren Sie adaptive Dezimierung, indem Sie eine Polygonanzahl-Stufe festlegen. Wenn gesetzt, wird target_polycount ignoriert.
Verfügbare Werte:
1: Adaptiv — ultra-hohe Polygonanzahl.
2: Adaptiv — hohe Polygonanzahl.
3: Adaptiv — mittlere Polygonanzahl.
4: Adaptiv — niedrige Polygonanzahl.
Name
save_pre_remeshed_model
Type
boolean
Standard false
Description
Wenn dies auf true gesetzt ist, speichert Meshy außerdem eine zusätzliche GLB-Datei, bevor die Remesh-Phase abgeschlossen ist.
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 Symmetrie.
auto: Bestimmt und wendet Symmetrie automatisch basierend auf der Eingabegeometrie an.
on: Erzwingt Symmetrie während der Generierung.
Name
pose_mode
Type
string
Standard ""
Description
Geben Sie den Posenmodus für das generierte Modell an.
Verfügbare Werte:
a-pose: Generiert das Modell in einer A-Pose.
t-pose: Generiert 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 generiert werden soll.
Name
image_enhancement
Type
boolean
Standard true
Description
Optimiert die Eingabebilder für bessere Ergebnisse. Setzen Sie dies auf false, um das exakte Erscheinungsbild der Eingabebilder ohne jegliche Stilbearbeitung beizubehalten.
Nur unterstützt, wenn ai_modelmeshy-6 oder latest ist.
Name
remove_lighting
Type
boolean
Standard true
Description
Entfernt Highlights und Schatten aus der Basisfarb-Textur und erzeugt ein saubereres Ergebnis, das unter benutzerdefinierten Beleuchtungs-Setups besser funktioniert.
Nur unterstützt, wenn ai_modelmeshy-6 oder latest ist.
Name
moderation
Type
boolean
Standard false
Description
Wenn dies auf true gesetzt ist, werden die Eingabeinhalte automatisch auf potenziell schädliche Inhalte geprüft. Wenn schädliche Inhalte erkannt werden, wird die Aufgabe nicht mit der Generierung fortfahren.
Jedes Bild aus image_urls und der Text aus texture_prompt werden geprüft.
Name
target_formats
Type
string[]
Description
Gibt an, welche 3D-Dateiformate in der Ausgabe enthalten sein sollen. Nur die angeforderten Formate werden generiert und zurückgegeben, wodurch die Fertigstellungszeit der Aufgabe reduziert werden kann.
Verfügbare Werte: glb, obj, fbx, stl, usdz, 3mf
Wenn nicht angegeben, werden alle Formate außer 3mf generiert. 3mf ist nur enthalten, wenn es ausdrücklich angegeben wird.
Name
auto_size
Type
boolean
Standard false
Description
Wenn dies auf true gesetzt ist, verwendet der Dienst KI-Vision, um die reale Höhe des Objekts automatisch zu schätzen und die Größe des Modells entsprechend 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 dies auf true gesetzt ist, rendert die Aufgabe zusätzlich eine Version der Vorschau mit transparentem Hintergrund (RGBA) und gibt sie in der GET-Antwort als alpha_thumbnail_url zurück. Das bestehende Feld thumbnail_url bleibt unverändert.
Name
multi_view_thumbnails
Type
boolean
Standard false
Description
Wenn dies auf true gesetzt ist, rendert die Aufgabe zusätzlich vier Thumbnails aus den Hauptrichtungen (vorne, rechts, hinten, links) und gibt sie in der GET-Antwort unter thumbnail_urls zurück. Das bestehende Feld thumbnail_url bleibt unverändert und verweist weiterhin auf die Vorderansicht, sodass bestehende Clients nicht betroffen sind.
Erhöht die Aufgabenlatenz um ungefähr 3 Sekunden.
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 Eigenschaft result der Antwort enthält die Aufgaben-id der neu erstellten Multi-Image-to-3D-Aufgabe.
Fehlermodi
Name
400 - Bad Request
Description
Die Anfrage war nicht akzeptabel. Häufige Ursachen:
Fehlender Parameter: Entweder image_urls oder input_task_id muss angegeben werden.
Ungültige Eingabeaufgabe: Die input_task_id muss auf eine SUCCEEDED Text to Image-, Image to Image- oder Multi-View-Variantenaufgabe verweisen.
Ungültige Bildanzahl: image_urls muss zwischen 1 und 4 Bilder enthalten.
Ungültiges Bildformat: Ein oder mehrere Bilder in image_urls haben nicht unterstützte Formate.
Nicht erreichbare URL: Eine oder mehrere image_urls konnten nicht heruntergeladen werden.
Name
401 - Unauthorized
Description
Authentifizierung fehlgeschlagen. Bitte überprüfen Sie Ihren API key.
Name
402 - Payment Required
Description
Nicht genügend Credits, um diese Aufgabe auszuführen.
Name
429 - Too Many Requests
Description
Sie haben Ihr Ratenlimit überschritten.
Request
POST
/openapi/v1/multi-image-to-3d
# Simple requestcurl https://api.meshy.ai/openapi/v1/multi-image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ] }'# With PBR texturing and GLB formatcurl https://api.meshy.ai/openapi/v1/multi-image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ], "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Dieser endpoint ermöglicht es dir, eine Multi-Image-to-3D-Aufgabe mit einer gültigen Aufgaben-id abzurufen.
Siehe Das Multi-Image-to-3D-Aufgabenobjekt, um zu sehen, welche
Eigenschaften im Multi-Image-to-3D-Aufgabenobjekt enthalten sind.
Parameter
Name
id
Type
path
Description
Eindeutige Kennung der abzurufenden Multi-Image-to-3D-Aufgabe.
Das Multi-Image to 3D Task-Objekt ist eine Arbeitseinheit, die Meshy verfolgt, um ein 3D-Modell aus mehreren Bildern zu erzeugen (einschließlich 1 bis 4). Die Bilder sollten dasselbe Objekt zeigen, idealerweise aus verschiedenen Ansichten oder Winkeln.
Das Objekt hat die folgenden Eigenschaften:
Eigenschaften
Name
id
Type
string
Description
Eindeutige Kennung der Aufgabe. Obwohl wir als Implementierungsdetail eine k-sortierbare UUID für Aufgaben-IDs verwenden,
sollten Sie keine Annahmen über das Format der ID treffen.
Name
type
Type
string
Description
Typ der Multi-Image-to-3D-Aufgabe. Der Wert ist multi-image-to-3d.
Name
model_urls
Type
object
Description
Herunterladbare URL zur von Meshy generierten 3D-Modelldatei mit Texturen. Die Eigenschaft für ein Format wird ausgelassen, wenn das Format nicht generiert wurde, anstatt eine leere Zeichenfolge 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 bei 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 sowohl mit should_remesh: true als auch mit save_pre_remeshed_model: true erstellt wurde.
Name
thumbnail_url
Type
string
Description
Herunterladbare URL zum Vorschaubild der Modelldatei. Entspricht thumbnail_urls.front, sofern 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 ausgelassen.
Name
thumbnail_urls
Type
object
Description
Herunterladbare URLs für Vorschaubilder des generierten 3D-Modells aus vier Hauptrichtungen. Jeder Wert ist eine signierte URL zu einem 512×512-PNG, das mit denselben Materialien und derselben Beleuchtung wie thumbnail_url gerendert wurde. Nützlich, um das Modell in Batch-Pipelines aus mehreren Winkeln in der Vorschau anzuzeigen, ohne die GLB-Datei 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 zur Steuerung des Texturierungsprozesses verwendet wurde.
Name
progress
Type
integer
Description
Fortschritt der Aufgabe. Wenn die Aufgabe noch nicht gestartet wurde, ist diese Eigenschaft 0. Sobald die Aufgabe erfolgreich abgeschlossen wurde, wird sie zu 100.
Name
started_at
Type
timestamp
Description
Zeitstempel des Starts der Aufgabe in Millisekunden. Wenn die Aufgabe noch nicht gestartet wurde, ist diese Eigenschaft 0.
Ein Zeitstempel stellt die Anzahl der Millisekunden dar, die seit dem 1. Januar 1970 UTC vergangen sind, gemäß
dem RFC 3339-Standard.
Beispielsweise wird Freitag, 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 der Erstellung der Aufgabe in Millisekunden.
Name
expires_at
Type
timestamp
Description
Zeitstempel, zu dem das Aufgabenergebnis abläuft, in Millisekunden.
Name
finished_at
Type
timestamp
Description
Zeitstempel der Fertigstellung der Aufgabe in Millisekunden. Wenn die Aufgabe noch nicht abgeschlossen ist, ist diese Eigenschaft 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 aus der Aufgabe generiert werden. 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 Base-Color-Map-Bild.
Name
metallic
Type
string
Description
Herunterladbare URL zum Metallic-Map-Bild.
Wenn die Aufgabe mit enable_pbr: false erstellt wurde, wird diese Eigenschaft ausgelassen.
Name
normal
Type
string
Description
Herunterladbare URL zum Normal-Map-Bild.
Wenn die Aufgabe mit enable_pbr: false erstellt wurde, wird diese Eigenschaft ausgelassen.
Name
roughness
Type
string
Description
Herunterladbare URL zum Roughness-Map-Bild.
Wenn die Aufgabe mit enable_pbr: false erstellt wurde, wird diese Eigenschaft ausgelassen.
Name
emission
Type
string
Description
Herunterladbare URL zum Emission-Map-Bild.
Wenn die Aufgabe mit enable_pbr: false erstellt wurde oder ai_modelmeshy-5 ist, wird diese Eigenschaft ausgelassen.
Name
preceding_tasks
Type
integer
Description
Die Anzahl der vorangehenden Aufgaben.
Der Wert dieses Feldes ist nur 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 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 Fehlschlag erstattet).