Verwandeln Sie ein Ausgangsfoto in zwei Schritten in eine Chibi-3D-Sammelfigur:
prototype generiert aus Ihrem Eingabefoto ein stilisiertes Konzeptbild, anschließend
wandelt build dieses Konzeptbild in ein 3D-Modell mit Textur um. Die beiden Schritte
sind über input_task_id verknüpft.
Generiert ein einzelnes Konzeptbild im Chibi-Stil aus dem Quellfoto. Die
zurückgegebene Aufgaben-ID übergeben Sie als input_task_id an den Build-
endpoint. Siehe
Das Figure Prototype Task Object
für die Struktur der Antwort.
Parameter
Name
image_url
Type
string
Erforderlich
Description
Quellfoto, das Meshy als Chibi-Figur stilisieren soll. 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 ü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
name
Type
string
Description
Optionaler Aufgabenname für Anzeigezwecke. Maximal 100 Zeichen.
Rückgabe
Die Eigenschaft result der Antwort enthält die Aufgaben-id der neu erstellten Figur-Prototyp-Aufgabe. Fragen Sie den Get a Task-endpoint ab oder abonnieren Sie den stream, bis die Aufgabe SUCCEEDED erreicht, und übergeben Sie diese ID dann als input_task_id an den Build-endpoint.
Fehlermodi
Name
400 - Bad Request
Description
Die Anfrage war nicht akzeptabel. Häufige Ursachen:
Fehlender Parameter: image_url ist erforderlich.
Ungültiges Bildformat: Die bereitgestellte image_url hat kein unterstütztes Format (.jpg, .jpeg, .png, .webp).
Bildabmessungen außerhalb des zulässigen Bereichs: Das Bild ist zu klein, überschreitet die maximale Dateigröße oder überschreitet die maximale Pixelanzahl.
Nicht erreichbare URL: Die image_url konnte nicht heruntergeladen werden (404 oder Timeout).
Ungültige Data URI: Der base64-String ist fehlerhaft.
Inhalt markiert: Das Eingabebild wurde von der NSFW- oder Moderation für geistiges Eigentum markiert.
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 Rate-Limit überschritten.
Request
POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurl https://api.meshy.ai/openapi/creative-lab/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":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Generiert die endgültige texturierte 3D-Figur aus einer erfolgreich abgeschlossenen Prototyp-Aufgabe.
Der Build führt dieselbe Image-to-3D-Pipeline aus wie
Image to 3D, daher entsprechen das Format des Antwortobjekts und die
Liste der Ausgabe-URLs exakt. Siehe
Das Figure-Build-Aufgabenobjekt für die
Antwortstruktur.
Parameter
Name
input_task_id
Type
string
Erforderlich
Description
Die Aufgaben-ID einer Prototyp-Aufgabe, die über denselben OpenAPI-endpoint erstellt wurde. Der Prototyp muss mit derselben API key erstellt worden sein, muss SUCCEEDED erreicht haben und muss genau ein Kandidatenbild erzeugt haben.
Prototyp-Aufgaben, die über die Webapp erstellt wurden, werden nicht akzeptiert — der Build-endpoint akzeptiert nur Prototyp-Aufgaben, die von POST /openapi/creative-lab/figure/v1/prototype erzeugt wurden, und lehnt jede andere Quelle mit 404 ab.
Name
name
Type
string
Description
Optionaler Aufgabenname für Anzeigezwecke. Maximal 100 Zeichen.
Rückgabe
Die Eigenschaft result der Antwort enthält die Aufgaben-id der neu erstellten Figure-Build-Aufgabe. Fragen Sie den Eine Aufgabe abrufen-endpoint ab oder abonnieren Sie den Stream, bis die Aufgabe SUCCEEDED erreicht, und laden Sie dann die texturierte GLB-Datei von model_urls.glb herunter (oder das OBJ- + MTL-Paar von model_urls.obj und model_urls.mtl, falls Ihre nachgelagerte Pipeline OBJ bevorzugt).
Fehlermodi
Name
400 - Bad Request
Description
Die Anfrage war unzulässig. Häufige Ursachen:
Fehlender Parameter: input_task_id ist erforderlich.
Ungültige UUID: Die input_task_id ist keine gültige UUID.
Übergeordnete Aufgabe nicht erfolgreich: Die referenzierte Prototyp-Aufgabe hat SUCCEEDED noch nicht erreicht.
Kein Kandidat: Die Prototyp-Aufgabe war erfolgreich, hat aber kein Kandidatenbild erzeugt.
Name
401 - Unauthorized
Description
Die Authentifizierung ist fehlgeschlagen. Bitte prüfen Sie Ihre API key.
Name
402 - Payment Required
Description
Nicht genügend Credits, um diese Aufgabe auszuführen.
Name
404 - Not Found
Description
Die referenzierte Prototyp-Aufgabe existiert nicht, gehört zu einem anderen Benutzer oder wurde über die Webapp erstellt (nur Prototyp-Aufgaben im API-Modus können in den Build übergehen).
Name
429 - Too Many Requests
Description
Sie haben Ihr Ratenlimit überschritten.
Request
POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurl https://api.meshy.ai/openapi/creative-lab/figure/v1/build \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Response
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Build-Beispiel
Die Build-Aufgabe verwandelt das ausgewählte Prototypbild in ein herunterladbares texturiertes 3D-Modell.
Rufe eine Prototype- oder Build-Aufgabe anhand einer gültigen Aufgaben-id ab. Der URL-Pfad
muss zur Phase der Aufgabe passen — eine Build-Aufgabe, die über
/prototype/:id abgerufen wird, gibt 404 zurück, und umgekehrt.
Bricht eine Figurenaufgabe ab. Wenn die Aufgabe noch PENDING ist, werden die
bei der Erstellung verbrauchten Credits erstattet. Aufgaben, die bereits
IN_PROGRESS sind, werden ohne Erstattung abgebrochen (der Worker verbraucht möglicherweise bereits
Ressourcen). Aufgaben, die bereits einen Endzustand erreicht haben
(SUCCEEDED, FAILED, CANCELED), können nicht abgebrochen werden.
Der URL-Pfad muss der Phase der Aufgabe entsprechen — DELETE auf
/prototype/:buildId gibt 404 zurück.
Pfadparameter
Name
id
Type
path
Description
Eindeutige Kennung der abzubrechenden Figurenaufgabe.
Rückgabe
Gibt bei Erfolg 204 No Content mit einem leeren Body 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 ihre Phase stimmt nicht mit dem URL-Pfad überein.
Streame Echtzeit-Updates für eine Figurenaufgabe über Server-Sent Events (SSE).
Der URL-Pfad muss der Phase der Aufgabe entsprechen — das Öffnen eines Streams unter
/prototype/:buildId/stream gibt ein einzelnes event: error-Payload mit
status_code: 404 aus und schließt den Stream.
Parameter
Name
id
Type
path
Description
Eindeutige Kennung der zu streamenden Figurenaufgabe.
Rückgabewerte
Gibt einen Stream von Aufgabenobjekten des Typs Figurenprototyp
oder Figuren-Build als
Server-Sent Events zurück. Bei Aufgaben mit PENDING oder IN_PROGRESS enthält der Antwort-Stream
nur die erforderlichen Felder progress und status.
Rufen Sie eine paginierte Liste Ihrer Figurenaufgaben für eine einzelne Phase ab. Der URL-
Pfad wählt die Phase aus — /prototype gibt Prototypaufgaben zurück; /build
gibt Build-Aufgaben zurück. Aufgaben aus der jeweils anderen Phase sind in keiner
Antwort 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
Begrenzung der Seitengröße. Maximal zulässig 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 aufsteigend sortieren.
-created_at: Nach Erstellungszeit absteigend sortieren.
Das Figurenprototyp-Aufgabenobjekt ist eine Arbeitseinheit, die Meshy nachverfolgt, um
aus einem Quellfoto ein Konzeptbild im Chibi-Stil zu erzeugen. Die Ausgabe
dieser Phase wird über input_task_id mit der Build-Phase
verkettet.
Eigenschaften
Name
id
Type
string
Description
Eindeutiger Bezeichner für die 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 Aufgabe. Der Wert ist creative-lab-figure-prototype.
Name
name
Type
string
Description
Der Aufgabenname, der beim Erstellen der Aufgabe angegeben wurde. Leere Zeichenkette, 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 diese Eigenschaft 0. Sobald die Aufgabe erfolgreich abgeschlossen wurde, wird sie zu 100.
Name
created_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe erstellt wurde, in Millisekunden.
Ein Zeitstempel stellt die Anzahl der seit dem 1. Januar 1970 UTC verstrichenen Millisekunden dar, gemäß
dem Standard RFC 3339.
Zum Beispiel wird Freitag, 1. September 2023, 12:00:00 PM GMT als 1693569600000 dargestellt. Dies gilt
für alle Zeitstempel in der Meshy API.
Name
started_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe gestartet wurde, in Millisekunden. Wenn die Aufgabe noch nicht gestartet wurde, ist diese Eigenschaft 0.
Name
finished_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe abgeschlossen wurde, in Millisekunden. Wenn die Aufgabe noch nicht abgeschlossen wurde, ist diese Eigenschaft 0.
Name
expires_at
Type
timestamp
Description
Zeitstempel, wann das Aufgabenergebnis abläuft, in Millisekunden.
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 durch diese Aufgabe verbrauchten Credits. Vorhanden, wenn der Aufgabenstatus PENDING, IN_PROGRESS oder SUCCEEDED ist. Gibt 0 für FAILED-Aufgaben zurück (Credits werden bei Fehlschlag erstattet).
Name
image_urls
Type
array of strings
Description
Herunterladbare URLs für die Konzeptbild-Kandidaten, die von dieser Prototyp-Aufgabe generiert wurden. Derzeit gibt die API immer genau einen Kandidaten zurück; das Feld ist ein Array, damit zukünftige Revisionen mehrere Kandidaten ohne Breaking Change bereitstellen können.
Das Figure Build Task-Objekt ist eine Arbeitseinheit, die Meshy verfolgt, um
aus einer erfolgreich abgeschlossenen Prototyp-Aufgabe eine texturierte 3D-Figur zu
generieren. Es verwendet dieselbe Image-to-3D-Pipeline wie Image to 3D,
sodass die Ausgabefelder dem Aufgabenobjekt dieses endpoints entsprechen.
Eigenschaften
Name
id
Type
string
Description
Eindeutige Kennung für die Aufgabe.
Name
type
Type
string
Description
Typ der Aufgabe. Der Wert ist creative-lab-figure-build.
Name
name
Type
string
Description
Der beim Erstellen der Aufgabe angegebene Aufgabenname. Leere Zeichenkette, 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 diese Eigenschaft 0. Sobald die Aufgabe erfolgreich abgeschlossen wurde, wird sie zu 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 Aufgabenergebnis abläuft, in Millisekunden.
Name
preceding_tasks
Type
integer
Description
Die Anzahl der vorangehenden Aufgaben. Nur aussagekräftig, 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 (Credits werden bei Fehlschlag erstattet).
Name
prompt
Type
string
Description
Für Figure Build immer leer. Vorhanden für endpointübergreifende Kompatibilität mit der gemeinsam genutzten V2ImageTo3DTaskResponse-Struktur, die von Image to 3D verwendet wird.
Name
negative_prompt
Type
string
Description
Für Figure Build immer leer. Vorhanden für endpointübergreifende Kompatibilität.
Name
texture_prompt
Type
string
Description
Für Figure Build immer leer. Vorhanden für endpointübergreifende Kompatibilität.
Name
texture_image_url
Type
string
Description
Für Figure Build immer leer. Vorhanden für endpointübergreifende Kompatibilität.
Name
model_urls
Type
object
Description
Herunterladbare URLs für das generierte 3D-Modell. Figure Build gibt ein texturiertes GLB sowie das OBJ- + MTL-Paar für Pipelines aus, die Wavefront OBJ bevorzugen. Die Feldstruktur entspricht dem Image to 3D model_urls-Objekt, sodass zukünftige Formaterweiterungen ohne Breaking Change eingefügt 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, die zur OBJ-Datei gehört. Mit obj und dem Eintrag aus texture_urls[0].base_color kombinieren.
Name
thumbnail_url
Type
string
Description
Herunterladbare URL zum Vorschaubild der Modelldatei.
Name
texture_urls
Type
array
Description
Ein Array von Textur-URL-Objekten, die von dieser Aufgabe generiert wurden. Enthält derzeit ein einzelnes Objekt mit der Basisfarben-Map.