Verwandeln Sie ein Quellfoto in zwei Phasen in eine 3D-Figur eines Vinyl-Sammlerstücks mit großem Kopf: Prototyp erzeugt ein stilisiertes Konzeptbild aus Ihrem Eingabefoto, dann verwandelt Build dieses Konzeptbild in ein texturiertes 3D-Modell. Die beiden Phasen sind über input_task_id verbunden.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Erzeuge ein Konzeptbild im Vinylfiguren-Stil aus dem Quellfoto. Die zurückgegebene Aufgaben-ID ist das, was Sie als input_task_id an das Build-Endpunkt übergeben. Weitere Informationen zur Antwortstruktur finden Sie unter Das Vinyl Figure Prototype Task Objekt.
Parameter
Name
image_url
Type
string
Erforderlich
Description
Quellfoto für Meshy, um es als großköpfige Vinylfigur zu stilisieren. Wir unterstützen derzeit die Formate .jpg, .jpeg, .png und .webp.
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-kodierte Data URI des Bildes. Beispiel einer Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Optionaler Aufgabenname für Anzeigezwecke. Maximal 100 Zeichen.
Rückgabewerte
Die result-Eigenschaft der Antwort enthält die Aufgaben-id der neu erstellten Vinylfigurenprototyp-Aufgabe. Fragen Sie das Hole eine Aufgabe-Endpunkt ab oder abonnieren Sie den Stream, bis die Aufgabe den Status SUCCEEDED erreicht, und übergeben Sie dann diese ID an das Build-Endpunkt als input_task_id.
Fehlerfälle
Name
400 - Bad Request
Description
Die Anfrage war nicht akzeptabel. Häufige Ursachen:
Fehlender Parameter: image_url ist erforderlich.
Ungültiges Bildformat: Das angegebene image_url ist kein unterstütztes Format (.jpg, .jpeg, .png, .webp).
Bildmaße außerhalb des zulässigen Bereichs: Das Bild ist zu klein, überschreitet die maximale Dateigröße oder die maximale Pixelanzahl.
Nicht erreichbare URL: Die image_url konnte nicht heruntergeladen werden (404 oder timeout).
Ungültige Data URI: Die base64-Zeichenkette ist fehlerhaft.
Inhalt gekennzeichnet: Das Eingabebild wurde durch NSFW oder geistiges Eigentums-Moderation gekennzeichnet.
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 Ihre Ratenbegrenzung überschritten.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Stufe 1: Erzeugen eines Konzeptbildes im Vinylfiguren-Stilcurl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype \ -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>" }'
Response
{"result":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Generieren Sie die endgültige, mit Texturen versehene 3D-Vinylfigur aus einer gelungenen Prototyp-Aufgabe. Der Bauvorgang verwendet dasselbe Bild-zu-3D-Pipeline wie
Bild zu 3D, sodass das Format des Antwortobjekts und die Liste der Ausgabe-URLs exakt übereinstimmen. Lesen Sie
Das Vinylfigur-Bauaufgaben-Objekt
für die Form der Antwort.
Parameter
Name
input_task_id
Type
string
Erforderlich
Description
Die Aufgaben-ID einer Prototyp-Aufgabe, die über denselben OpenAPI-Endpunkt erstellt wurde. Der Prototyp muss mit demselben API-Schlüssel erstellt worden sein, muss den Status SUCCEEDED erreicht haben und genau ein Kandidatenbild erzeugt haben.
Prototyp-Aufgaben, die über die Webanwendung erstellt wurden, werden nicht akzeptiert – der Bau-Endpunkt akzeptiert nur Prototyp-Aufgaben, die durch POST /openapi/creative-lab/vinyl-figure/v1/prototype erstellt wurden, und lehnt jede andere Quelle mit 404 ab.
Name
name
Type
string
Description
Optionaler Aufgabenname für Anzeigezwecke. Maximal 100 Zeichen.
Rückgaben
Die result Eigenschaft der Antwort enthält die Aufgaben-id der neu erstellten Vinylfigur-Bauaufgabe. Abfragen Sie den Eine Aufgabe abrufen Endpunkt oder abonnieren Sie den stream, bis die Aufgabe den Status SUCCEEDED erreicht, und laden Sie dann die mit Texturen versehene GLB von model_urls.glb herunter (oder das OBJ + MTL-Paar von model_urls.obj und model_urls.mtl, wenn Ihre nachgelagerte Pipeline OBJ bevorzugt).
Fehlerfälle
Name
400 - Bad Request
Description
Die Anfrage war nicht akzeptabel. Häufige Ursachen:
Fehlender Parameter: input_task_id ist erforderlich.
Ungültige UUID: Die input_task_id ist keine gültige UUID.
Elternteil nicht erfolgreich: Die referenzierte Prototyp-Aufgabe hat den Status SUCCEEDED noch nicht erreicht.
Kein Kandidat: Die Prototyp-Aufgabe war erfolgreich, hat aber kein Kandidatenbild produziert.
Name
401 - Unauthorized
Description
Authentifizierung fehlgeschlagen. Bitte überprüfen Sie Ihren API-Schlüssel.
Name
402 - Payment Required
Description
Nicht ausreichende Credits, um diese Aufgabe durchzuführen.
Name
404 - Not Found
Description
Die referenzierte Prototyp-Aufgabe existiert nicht, gehört einem anderen Benutzer oder wurde über die Webanwendung erstellt (nur API-Modus-Prototyp-Aufgaben werden in der Baukette fortgesetzt).
Name
429 - Too Many Requests
Description
Sie haben Ihre Ratenbegrenzung überschritten.
Anfrage
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Stufe 2: Bauvorgang aus einer gelungenen Prototyp-Aufgabe verkettencurl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de" }'
Abrufen einer Prototyp- oder Bauaufgabe anhand einer gültigen Aufgaben-id. Der URL-Pfad
muss der Phase der Aufgabe entsprechen — eine Bauaufgabe, die über
/prototype/:id abgerufen wird, gibt 404 zurück und umgekehrt.
Abbrechen einer Vinylfigur-Aufgabe. Wenn die Aufgabe noch PENDING ist, werden die bei der Erstellung verbrauchten Credits zurückerstattet. Aufgaben, die bereits IN_PROGRESS sind, werden ohne Rückerstattung abgebrochen (der Bearbeiter könnte bereits Ressourcen verbrauchen). Aufgaben, die bereits einen Endzustand erreicht haben (SUCCEEDED, FAILED, CANCELED), können nicht abgebrochen werden.
Der URL-Pfad muss dem Stadium der Aufgabe entsprechen — DELETE auf
/prototype/:buildId gibt 404 zurück.
Pfadparameter
Name
id
Type
path
Description
Eindeutiger Bezeichner für die zu stornierende Vinylfigur-Aufgabe.
Rückgaben
Gibt bei Erfolg 204 No Content mit einem leeren Körper zurück.
Fehlermodi
Name
400 - Bad Request
Description
Die Aufgabe befindet sich bereits in einem Endzustand und kann nicht abgebrochen werden.
Name
404 - Not Found
Description
Die Aufgabe existiert nicht, gehört zu einem anderen Benutzer oder ihr Stadium stimmt nicht mit dem URL-Pfad überein.
Streamen Sie Echtzeit-Updates für eine Vinylfigur-Aufgabe über Server-Sent Events
(SSE). Der URL-Pfad muss dem Stadium der Aufgabe entsprechen – das Öffnen eines Streams unter
/prototype/:buildId/stream sendet ein einzelnes event: error Payload mit
status_code: 404 und schließt den Stream.
Parameter
Name
id
Type
path
Description
Eindeutiger Bezeichner für die Vinylfigur-Aufgabe, die gestreamt werden soll.
Rückgaben
Gibt einen Stream von Vinylfigur-Prototyp
oder Vinylfigur-Build Aufgabenobjekten
als Server-Sent Events zurück. Für PENDING oder IN_PROGRESS Aufgaben enthält der Antwort-Stream nur die notwendigen progress und status Felder.
Abrufen einer paginierten Liste Ihrer Vinyl Figure Aufgaben für eine einzelne Phase.
Der URL-Pfad wählt die Phase — /prototype gibt Prototyp-Aufgaben zurück;
/build gibt Build-Aufgaben zurück. Aufgaben aus der anderen Phase sind
in keiner der Antworten enthalten.
Pfadparameter
Name
stage
Type
path
Erforderlich
Description
Entweder prototype oder build. Die Sammlung gibt nur Aufgaben
zurück, deren Phase mit der URL übereinstimmt — das Abrufen von /prototype
gibt niemals Build-Aufgaben zurück und umgekehrt.
Abfrageparameter
Name
page_num
Type
integer
Standard 1
Description
Seitennummer für die Paginierung.
Name
page_size
Type
integer
Standard 10
Description
Seitenbegrenzung. Maximal erlaubt sind 50 Elemente.
Name
sort_by
Type
string
Standard -created_at
Description
Feld, nach dem sortiert werden soll. Verfügbare Werte:
+created_at: Nach Erstellungszeit in aufsteigender Reihenfolge sortieren.
-created_at: Nach Erstellungszeit in absteigender Reihenfolge sortieren.
Das Vinylfigur-Prototyp-Task-Objekt ist eine Arbeitseinheit, die Meshy verfolgt,
um ein Vinylfiguren-Stil Konzeptbild aus einem Quellfoto zu erstellen.
Das Ergebnis dieser Phase wird über input_task_id in die
die Aufbauphase eingebunden.
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 treffen.
Name
type
Type
string
Description
Typ der Aufgabe. Der Wert ist creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
Der bei der Erstellung der Aufgabe angegebene Aufgabenname. Leerer String, falls kein Name angegeben wurde.
Name
status
Type
string
Description
Status der Aufgabe. Mögliche Werte sind einer von PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Fortschritt der Aufgabe. Wenn die Aufgabe noch nicht begonnen wurde, hat diese Eigenschaft den Wert 0. Sobald die Aufgabe erfolgreich abgeschlossen ist, wird diese Eigenschaft 100 sein.
Name
created_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe erstellt wurde, in Millisekunden.
Ein Zeitstempel repräsentiert die Anzahl der Millisekunden, die seit dem 1. Januar 1970 UTC vergangen sind, gemäß dem RFC 3339 Standard. Zum Beispiel wird Freitag, der 1. September 2023 um 12:00:00 GMT als 1693569600000 dargestellt. Dies gilt für alle Zeitstempel in der Meshy API.
Name
started_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe begonnen wurde, in Millisekunden. Wenn die Aufgabe noch nicht begonnen wurde, hat diese Eigenschaft den Wert 0.
Name
finished_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe beendet wurde, in Millisekunden. Wenn die Aufgabe noch nicht abgeschlossen ist, hat diese Eigenschaft den Wert 0.
Name
expires_at
Type
timestamp
Description
Zeitstempel, wann das Ergebnis der Aufgabe abläuft, in Millisekunden.
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 Referenz des task_error Objekts.
Name
consumed_credits
Type
integer
Description
Die Anzahl der Credits, die für diese Aufgabe verbraucht wurden. Vorhanden, wenn der Aufgabenstatus PENDING, IN_PROGRESS oder SUCCEEDED ist. Gibt 0 für FAILED Aufgaben zurück (Credits werden bei Misserfolg zurückerstattet).
Name
image_urls
Type
array of strings
Description
Herunterladbare URLs für die von dieser Prototyp-Aufgabe generierten Konzeptbild-Kandidaten. Derzeit liefert die API immer genau einen Kandidaten zurück; das Feld ist ein Array, sodass zukünftige Revisionen mehrere Kandidaten ohne eine Änderung an der Schnittstelle ermöglichen können.
Das Vinylfigur-Erstellungsaufgaben-Objekt ist eine Arbeitseinheit, die Meshy verfolgt,
um eine texturierte 3D-Vinylfigur aus einer erfolgreich abgeschlossenen Prototyp-Aufgabe zu generieren.
Es nutzt die gleiche Bild-zu-3D-Pipeline wie Bild zu 3D,
daher spiegeln die Ausgabefelder den Aufgabenobjekt dieses Endpunkts wider.
Eigenschaften
Name
id
Type
string
Description
Eindeutiger Bezeichner für die Aufgabe.
Name
type
Type
string
Description
Typ der Aufgabe. Der Wert ist creative-lab-vinyl-figure-build.
Name
name
Type
string
Description
Der bei der Erstellung der Aufgabe angegebene Aufgabenname. Leer, wenn kein Name angegeben wurde.
Name
status
Type
string
Description
Status der Aufgabe. Mögliche Werte sind einer von PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Fortschritt der Aufgabe. Wenn die Aufgabe noch nicht gestartet wurde, ist dieser Wert 0. Sobald die Aufgabe abgeschlossen ist, wird er 100.
Name
created_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe erstellt wurde, in Millisekunden.
Name
started_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe gestartet wurde, in Millisekunden.
Name
finished_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe abgeschlossen wurde, in Millisekunden.
Name
expires_at
Type
timestamp
Description
Zeitstempel, wann das Ergebnis der Aufgabe abläuft, in Millisekunden.
Name
preceding_tasks
Type
integer
Description
Die Anzahl der vorhergehenden Aufgaben. Sinnvoll nur, wenn der Status 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. Gibt 0 für FAILED-Aufgaben zurück (bei einem Fehler werden Credits zurückerstattet).
Name
prompt
Type
string
Description
Immer leer für den Vinylfigurenbau. Vorhanden für die Kompatibilität über Endpunkte hinweg mit der gemeinsamen V2ImageTo3DTaskResponse-Struktur, die von Bild zu 3D verwendet wird.
Name
negative_prompt
Type
string
Description
Immer leer für den Vinylfigurenbau. Vorhanden für die Endpunkt-Kompatibilität.
Name
texture_prompt
Type
string
Description
Immer leer für den Vinylfigurenbau. Vorhanden für die Endpunkt-Kompatibilität.
Name
texture_image_url
Type
string
Description
Immer leer für den Vinylfigurenbau. Vorhanden für die Endpunkt-Kompatibilität.
Name
model_urls
Type
object
Description
Herunterladbare URLs für das generierte 3D-Modell. Der Vinylfigurenbau erzeugt eine texturierte GLB plus das OBJ + MTL-Paar für Pipelines, die Wavefront OBJ bevorzugen. Das Feld-Layout entspricht dem Bild zu 3D model_urls Objekt, so dass zukünftige Format-Ergänzungen ohne eine Änderung der Struktur eingepflegt werden können.
Name
glb
Type
string
Description
Herunterladbare URL zur texturierten GLB-Datei.
Name
obj
Type
string
Description
Herunterladbare URL zur Wavefront OBJ-Datei (Geometrie + UV).
Name
mtl
Type
string
Description
Herunterladbare URL zur MTL-Materialdatei des OBJ-Begleiters. Kombinieren Sie mit obj und dem Eintrag aus texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Herunterladbare URL zur Miniaturansicht des Modells.
Name
texture_urls
Type
array
Description
Ein Array von Textur-URL-Objekten, die von dieser Aufgabe generiert wurden. Derzeit enthält es ein einziges Objekt mit der Basisfarbenkarte.