Text zu 3D API ist eine Funktion, mit der Sie Meshys Text zu 3D-Fähigkeiten in Ihre eigene Anwendung integrieren können. In diesem Abschnitt finden Sie alle Informationen, die Sie benötigen, um mit dieser API zu beginnen.
Text zu 3D verwendet einen zweistufigen Workflow. Erstellen Sie zunächst eine Vorschau-Aufgabe (mode: "preview"), um ein 3D-Netz ohne Textur zu generieren, damit Sie die Form bewerten können. Dann übergeben Sie die ID der abgeschlossenen Vorschauaufgabe an eine Verfeinerungs-Aufgabe (mode: "refine"), um die Textur auf das Netz anzuwenden. Beide Schritte verwenden denselben Endpunkt.
Dieser Endpunkt erstellt eine Text zu 3D Vorschauaufgabe, die ein untexturiertes 3D-Netz (nur Geometrie) aus einem Textprompt generiert. Dies ist der erste Schritt des zweistufigen Workflows. Sobald die Vorschau erfolgreich ist, verwenden Sie die zurückgegebene Aufgaben-ID, um eine Verfeinerungsaufgabe zu erstellen für die Texturierung. Sehen Sie sich Das Text zu 3D Aufgabenobjekt für das vollständige Antwortschema an.
Parameter
Name
mode
Type
string
Erforderlich
Description
Dieses Feld sollte auf "preview" gesetzt werden, wenn eine Vorschauaufgabe erstellt wird.
Name
prompt
Type
string
Erforderlich
Description
Beschreiben Sie, um welche Art von Objekt es sich beim 3D-Modell handelt. Maximal 600 Zeichen.
lowpoly: Generiert ein Low-Poly-Netz, optimiert für saubere Polygone.
Wenn lowpoly ausgewählt ist, werden ai_model, topology, target_polycount, should_remesh ignoriert.
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_remesh
Type
boolean
Standard false (meshy-6), true (others)
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 Topologie des generierten Modells an.
Verfügbare Werte:
quad: Generiert ein Quadrat-dominantes Netz.
triangle: Generiert ein dezimiertes Dreiecksnetz.
Name
target_polycount
Type
integer
Standard 30,000
Description
Geben Sie die Zielanzahl der Polygone im generierten Modell an. Die tatsächliche Anzahl der Polygone kann je nach Komplexität der Geometrie von der Zielanzahl abweichen.
Der gültige Wertebereich variiert je nach Benutzerstufe:
100 bis 300.000 (einschließlich)
Name
decimation_mode
Type
integer
Description
Aktivieren Sie die adaptive Dezimierung, indem Sie ein Polygonanzahlniveau festlegen. Wenn eingestellt, wird target_polycount ignoriert.
Verfügbare Werte:
1: Adaptiv — Ultra-Polygonanzahl.
2: Adaptiv — Hohe Polygonanzahl.
3: Adaptiv — Mittlere Polygonanzahl.
4: Adaptiv — Niedrige Polygonanzahl.
Name
symmetry_mode
Type
string
⚠ veraltet
Standard auto
Description
Veraltet. Dieser Parameter beeinflusst die Ausgabe nicht mehr.
Das Feld symmetry_mode steuert das Symmetrieverhalten während des Modellierungsprozesses.
Die gültigen Werte sind:
off: Deaktiviert Symmetrie.
auto: Bestimmt und wendet automatisch Symmetrie basierend auf der Eingabegeometrie an.
on: Erzwingt Symmetrie während der Erzeugung.
Name
pose_mode
Type
string
Standard ""
Description
Geben Sie den Pose-Modus 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 spezifische Pose angewendet.
Name
is_a_t_pose
Type
boolean
⚠ veraltet
Standard false
Description
Verwenden Sie pose_mode stattdessen. Gibt an, ob das Modell in einer A-/T-Pose generiert werden soll.
Name
art_style
Type
string
⚠ veraltet
Standard realistic
Description
Nicht unterstützt von Meshy-6. Anfragen, die Meshy-6 verwenden, ignorieren art_style, und einige Kombinationen können Fehler verursachen. Verfügbare Werte: realistic, sculpture.
enable_pbr sollte auf false gesetzt werden, wenn der Skulpturenstil verwendet wird, da der Skulpturenstil ein eigenes Set von PBR-Texturen erzeugt.
Name
moderation
Type
boolean
Standard false
Description
Wenn auf true gesetzt, wird der Eingabeinhalt automatisch auf potenziell schädliche Inhalte überprüft. Wenn schädliche Inhalte erkannt werden, wird die Aufgabe nicht zur Generierung fortgesetzt.
Der Text aus prompt wird geprüft.
Name
target_formats
Type
string[]
Description
Gibt an, welche 3D-Dateiformate in die Ausgabe aufgenommen werden sollen. Nur die angeforderten Formate werden generiert und zurückgegeben, was die Dauer der Aufgabenfertigstellung 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 generiert. 3mf ist nur einschließlich angegeben, wenn es explizit spezifiziert wird.
Name
alpha_thumbnail
Type
boolean
Standard false
Description
Wenn auf true gesetzt, rendert die Aufgabe zusätzlich eine transparente (RGBA) Version der Vorschau und gibt sie als alpha_thumbnail_url in der GET-Antwort zurück. Das bestehende thumbnail_url-Feld bleibt unverändert.
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 zu skalieren. Der Ursprung wird standardmäßig auf unten gesetzt, es sei denn, origin_at ist ausdrücklich festgelegt.
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ückgaben
Die result-Eigenschaft der Antwort enthält die Aufgaben-id der neu erstellten Text zu 3D Aufgabe.
Fehlerprotokolle
Name
400 - Bad Request
Description
Die Anfrage war nicht akzeptabel. Häufige Ursachen:
Fehlender Parameter: Ein erforderlicher Parameter (z. B. prompt, mode) fehlt.
Ungültiger Parameter: art_style ist nicht einer der erlaubten Werte.
Prompt zu lang: Der prompt überschreitet die Zeichenbeschränkung.
Name
401 - Unauthorized
Description
Authentifizierung fehlgeschlagen. Bitte überprüfen Sie Ihren API-Schlüssel.
Name
402 - Payment Required
Description
Unzureichende Credits, um diese Aufgabe durchzuführen.
Name
429 - Too Many Requests
Description
Sie haben Ihr Ratenlimit überschritten.
Request
POST
/openapi/v2/text-to-3d
# Einfache Vorschau nur mit den Pflichtparameterncurlhttps://api.meshy.ai/openapi/v2/text-to-3d \-H'Authorization: Bearer ${YOUR_API_KEY}' \-H'Content-Type: application/json' \-d'{ "mode": "preview", "prompt": "a monster mask"}'# Vorschau mit Neuvernetzung und A-Posecurlhttps://api.meshy.ai/openapi/v2/text-to-3d \-H'Authorization: Bearer ${YOUR_API_KEY}' \-H'Content-Type: application/json' \-d'{ "mode": "preview", "prompt": "a futuristic robot warrior", "should_remesh": true, "target_polycount": 100000, "pose_mode": "a-pose", "target_formats": ["glb"]}'
Dieser Endpunkt erstellt eine Text zu 3D Verfeinerungsaufgabe, die einer abgeschlossenen Vorschau ein Textur verleiht. Sie müssen die preview_task_id von einer erfolgreichen Vorschauaufgabe angeben. Dies ist der zweite Schritt des zweistufigen Workflows.
Parameter
Name
mode
Type
string
Erforderlich
Description
Dieses Feld sollte auf "refine" gesetzt werden, wenn eine Verfeinerungsaufgabe erstellt wird.
Name
preview_task_id
Type
string
Erforderlich
Description
Die entsprechende Vorschauaufgaben-ID.
Der Status der angegebenen Vorschauaufgabe muss SUCCEEDED sein.
Name
enable_pbr
Type
boolean
Standard false
Description
Erstellt PBR-Texturen (metallisch, Rauigkeit, Normal Map) zusätzlich zur Basisfarbe. Eine Emissionskarte wird ebenfalls enthalten, wenn ai_modelmeshy-6 oder latest ist, außer bei texture_resolution: 8k (keine Emissionskarte wird erzeugt).
Name
texture_resolution
Type
string
Standard 2k
Description
Basisfarbentextur-Auflösung. Eine von 2k (2048×2048), 4k (4096×4096) oder 8k (8192×8192). Höhere Auflösungen erfassen mehr Oberflächendetails. Gilt nur für den refine-Modus.
4k und 8k erfordern ai_modelmeshy-6 oder latest. Bei 8k wird keine Emissionskarte erzeugt.
Name
hd_texture
Type
boolean
⚠ veraltet
Standard false
Description
Verwenden Sie stattdessen texture_resolution — äquivalent zu texture_resolution: "4k". Wenn beide festgelegt sind, hat texture_resolution Vorrang.
Name
texture_prompt
Type
string
Description
Geben Sie einen zusätzlichen Textprompt an, um den Texturierungsprozess zu leiten. Maximal 600 Zeichen.
Name
texture_image_url
Type
string
Description
Geben Sie ein 2D-Bild an, um den Texturierungsprozess zu leiten. Wir unterstützen derzeit .jpg, .jpeg und .png Formate.
Es gibt zwei Möglichkeiten, das Bild bereitzustellen:
Öffentlich zugängliche URL: Eine URL, die vom öffentlichen Internet aus 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 Geometrieunterschiede zwischen dem Original-Asset und dem hochgeladenen Bild gibt. Nur eines von texture_image_url oder texture_prompt kann verwendet werden, um den Texturierungsprozess zu leiten. Wenn beide Parameter angegeben werden, wird standardmäßig texture_prompt verwendet, um das Modell zu texturieren.
Name
ai_model
Type
string
Standard latest
Description
ID des zu verwendenden Modells für die Verfeinerung. Verfügbare Werte: meshy-5, meshy-6, latest (Meshy 6).
Name
moderation
Type
boolean
Standard false
Description
Wenn auf true gesetzt, wird der Eingabeinhalt automatisch auf potenziell schädliche Inhalte überprüft. Wenn schädliche Inhalte erkannt werden, wird die Aufgabe nicht zur Generierung fortgesetzt.
Sowohl der Text aus texture_prompt als auch das Bild aus texture_image_url werden überprüft.
Name
remove_lighting
Type
boolean
Standard true
Description
Entfernt Hervorhebungen und Schatten von der Basisfarbtextur, was zu einem saubereren Ergebnis führt, das besser unter benutzerdefinierten Beleuchtungseinstellungen funktioniert.
Nur unterstützt, wenn ai_modelmeshy-6 oder latest ist.
Name
target_formats
Type
string[]
Description
Gibt an, welche 3D-Dateiformate in die Ausgabe aufgenommen werden sollen. Nur die angeforderten Formate werden generiert und zurückgegeben, was die Dauer der Aufgabenfertigstellung 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 generiert. 3mf ist nur einschließlich angegeben, wenn es explizit spezifiziert wird.
Name
alpha_thumbnail
Type
boolean
Standard false
Description
Wenn auf true gesetzt, rendert die Aufgabe zusätzlich eine transparente (RGBA) Version der Vorschau und gibt sie als alpha_thumbnail_url in der GET-Antwort zurück. Das bestehende thumbnail_url-Feld bleibt unverändert.
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 zu skalieren. Der Ursprung wird standardmäßig auf unten gesetzt, es sei denn, origin_at ist ausdrücklich festgelegt.
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ückgaben
Die result-Eigenschaft der Antwort enthält die Aufgaben-id der neu erstellten Text zu 3D Aufgabe.
Fehlerprotokolle
Name
400 - Bad Request
Description
Die Anfrage war nicht akzeptabel. Häufige Ursachen:
Ungültige Aufgaben-ID: Die preview_task_id ist ungültig oder existiert nicht.
Aufgabe noch nicht bereit: Die Vorschauaufgabe war noch nicht erfolgreich.
Modelldiskrepanz: Das AI-Modell der Vorschauaufgabe ist mit dem angeforderten Verfeinerungsmodell nicht kompatibel.
Name
401 - Unauthorized
Description
Authentifizierung fehlgeschlagen. Bitte überprüfen Sie Ihren API-Schlüssel.
Name
402 - Payment Required
Description
Unzureichende Credits, um diese Aufgabe durchzuführen.
Name
404 - Not Found
Description
Die in preview_task_id angegebene Vorschauaufgabe wurde nicht gefunden.
Mit diesem Endpunkt können Sie eine Text zu 3D Aufgabe mit einer gültigen Aufgaben-id abrufen.
Sehen Sie sich Das Text zu 3D Aufgabenobjekt an, um zu sehen, welche
Eigenschaften im Text zu 3D Aufgabenobjekt enthalten sind.
Dieser Endpunkt funktioniert sowohl für Vorschau- als auch für Verfeinerungsaufgaben.
Parameter
Name
id
Type
path
Description
Eindeutiger Identifikator für die abzurufende Text zu 3D Aufgabe.
Das Text zu 3D Aufgabenobjekt ist eine Arbeitseinheit, die von Meshy zur Erstellung eines 3D-Modells aus einem Text-Eingabewert verfolgt wird. Es gibt zwei Stufen der Text zu 3D API, preview und refine. Die Vorschauphase dient der Erstellung eines 3D-Modells nur mit Netz, und die Verfeinerungsphase dient der Erstellung eines texturierten 3D-Modells basierend auf dem Ergebnis der Vorschauphase.
Das Objekt hat folgende Eigenschaften:
Eigenschaften
Name
id
Type
string
Description
Eindeutiger Identifikator 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 treffen.
Name
type
Type
string
Description
Typ der Text zu 3D Aufgabe. Mögliche Werte sind text-to-3d-preview für Vorschauaufgaben und text-to-3d-refine für Verfeinerungsaufgaben.
Name
model_urls
Type
object
Description
Herunterladbare URL zur vom Meshy generierten texturierten 3D-Modell-Datei. Die Eigenschaft für ein Format wird weggelassen, wenn das Format nicht generiert wurde, und gibt keinen leeren String zurück.
Name
glb
Type
string
Description
Herunterladbare URL zur GLB-Datei.
Name
fbx
Type
string
Description
Herunterladbare URL zur FBX-Datei.
Name
usdz
Type
string
Description
Herunterladbare URL zur USDZ-Datei.
Name
obj
Type
string
Description
Herunterladbare URL zur OBJ-Datei.
Name
mtl
Type
string
Description
Herunterladbare URL zur MTL-Datei.
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
prompt
Type
string
Description
Dies ist der unmodifizierte prompt, der zur Erstellung der Aufgabe verwendet wurde.
Name
negative_prompt
Type
string
⚠ veraltet
Description
Beibehalten für die Abwärtskompatibilität. Dieses Feld hat keine funktionale Auswirkung auf generierte Modelle.
Name
art_style
Type
string
⚠ veraltet
Description
Der unmodifizierte art_style, der zur Erstellung der Vorschauaufgabe verwendet wurde. Nicht unterstützt von Meshy-6.
Name
texture_richness
Type
string
⚠ veraltet
Description
Beibehalten für die Rückwärtskompatibilität. Dieses Feld hat keine funktionale Auswirkung auf generierte Modelle.
Name
texture_prompt
Type
string
Description
Zusätzlicher Textprompt, der bereitgestellt wird, um den Texturierungsprozess während der Verfeinerungsphase zu leiten.
Name
texture_image_url
Type
string
Description
Herunterladbare URL zum Texturbild, das zur Führung des Texturierungsprozesses verwendet wurde.
Name
thumbnail_url
Type
string
Description
Herunterladbare URL zum Miniaturbild der Modella datei.
Name
alpha_thumbnail_url
Type
string
Description
Herunterladbare URL zu einer transparenten (RGBA)-Version 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
video_url
Type
string
⚠ veraltet
Description
Herunterladbare URL zum Vorschauvideo. Wird in einer zukünftigen Version entfernt.
Name
progress
Type
integer
Description
Fortschritt der Aufgabe. Wenn die Aufgabe noch nicht gestartet wurde, beträgt diese Eigenschaft 0. Sobald die Aufgabe erfolgreich abgeschlossen wurde, beträgt sie 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 Eigenschaft 0.
Ein Zeitstempel repräsentiert die Anzahl der seit dem 1. Januar 1970 UTC verstrichenen Millisekunden, entsprechend dem RFC 3339 Standard. Zum Beispiel wird Freitag, der 1. September 2023 12:00:00 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
finished_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe abgeschlossen wurde, in Millisekunden. Wenn die Aufgabe noch nicht abgeschlossen ist, beträgt diese Eigenschaft 0.
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 werden. Normalerweise enthält dies nur ein Textur-URL-Objekt. Jede Textur-URL hat folgende Eigenschaften:
Name
base_color
Type
string
Description
Herunterladbare URL zum Basisfarbentexturbild.
Name
metallic
Type
string
Description
Herunterladbare URL zum metallischen Texturbild.
Wenn die Aufgabe mit enable_pbr: false erstellt wurde, wird diese Eigenschaft weggelassen.
Name
normal
Type
string
Description
Herunterladbare URL zur Normal Map Texturbild.
Wenn die Aufgabe mit enable_pbr: false erstellt wurde, wird diese Eigenschaft weggelassen.
Name
roughness
Type
string
Description
Herunterladbare URL zum Rauigkeitstexturbild.
Wenn die Aufgabe mit enable_pbr: false erstellt wurde, wird diese Eigenschaft weggelassen.
Name
emission
Type
string
Description
Herunterladbare URL zum Emissionskartentexturbild.
Wenn die Aufgabe mit enable_pbr: false erstellt wurde oder ai_modelmeshy-5 ist, wird diese Eigenschaft weggelassen.
Name
preceding_tasks
Type
integer
Description
Die Anzahl der vorhergehenden Aufgaben.
Der Wert dieses Feldes ist nur dann bedeutungsvoll, wenn der Aufgabenstatus PENDING ist.
Name
task_error
Type
object
Description
Fehlerdetails für fehlgeschlagene Aufgaben. Siehe Fehler für die vollständige Referenz des task_error-Objekts.
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).
Example Text to 3D Task Object
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"text-to-3d-preview","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=***","usdz":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***","obj":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***","mtl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***","stl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***" },"prompt":"a monster mask","texture_prompt":"green slimy skin with scales and warts","texture_image_url":"","thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","progress":100,"started_at":1692771667037,"created_at":1692771650657,"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":20}