Verwandeln Sie ein Ausgangsfoto in eine sammelbare 3D-Figur im Chibi-Stil in zwei Phasen:
Prototyp erzeugt ein stilisiertes Konzeptbild aus Ihrem Eingabefoto, dann
Build verwandelt dieses Konzeptbild in ein 3D-Modell mit Textur. Die beiden Phasen
sind über input_task_id verbunden.
Erzeugen Sie ein einzelnes Chibi-Stil-Konzeptbild aus dem Ausgangsfoto. Die
zurückgegebene Aufgaben-ID ist das, was Sie als input_task_id an den Build
Endpunkt übergeben. Siehe
Das Figur-Prototyp-Aufgabenobjekt
für die Antwortstruktur.
Parameter
Name
image_url
Type
string
Erforderlich
Description
Ausgangsfoto, 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 aus dem öffentlichen 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.
Name
remove_background
Type
boolean
Standard false
Description
Wenn auf true gesetzt, wird das Prototypbild als transparentes RGBA PNG mit entferntem Hintergrund zurückgegeben, sodass Sie das Subjekt auf jeden Hintergrund komponieren können.
Rückgaben
Die result-Eigenschaft der Antwort enthält die Aufgaben-id der neu erstellten Figur-Prototyp-Aufgabe. Abfragen Sie den Get a Task Endpunkt oder abonnieren Sie den stream, bis die Aufgabe SUCCEEDED erreicht, und übergeben Sie dann diese ID an den Build Endpunkt als input_task_id.
Fehlerarten
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 ist kein unterstütztes Format (.jpg, .jpeg, .png, .webp).
Bildabmessungen außerhalb des 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: Der base64-String ist fehlerhaft.
Inhalt markiert: Das Eingabebild wurde von NSFW oder Moderation des geistigen Eigentums markiert.
Name
401 - Unauthorized
Description
Authentifizierung fehlgeschlagen. Bitte überprüfen Sie Ihren API-Schlüssel.
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.
Anfrage
POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/figure/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Antwort
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototyp-Beispiel
Beginnen Sie mit einem Ausgangsporträt und erzeugen Sie dann das Prototypbild, das in der Build-Phase verwendet wird.
Erzeugen Sie die endgültige 3D-Figur mit Textur aus einer erfolgreichen Prototyp-Aufgabe.
Der Build führt die gleiche Bild-zu-3D-Pipeline aus wie
Bild zu 3D, sodass das Format des Antwortobjekts und die
Liste der Ausgabe-URLs genau übereinstimmen. Siehe
Das Figur-Build-Aufgabenobjekt für die
Antwortstruktur.
Parameter
Name
input_task_id
Type
string
Erforderlich
Description
Die Aufgaben-ID einer Prototyp-Aufgabe, die über diesen gleichen OpenAPI-Endpunkt erstellt wurde. Der Prototyp muss mit dem gleichen API-Schlüssel erstellt worden sein, muss SUCCEEDED erreicht haben und muss genau ein Kandidatenbild produziert haben.
Prototyp-Aufgaben, die über die Webanwendung erstellt wurden, werden nicht akzeptiert — der Build-Endpunkt akzeptiert nur Prototyp-Aufgaben, die durch POST /openapi/creative-lab/figure/v1/prototype produziert 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 Figur-Build-Aufgabe. Abfragen Sie den Get a Task Endpunkt oder abonnieren Sie den Stream, bis die Aufgabe SUCCEEDED erreicht, und laden Sie dann die texturierte 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).
Fehlerarten
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 noch nicht SUCCEEDED 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
Unzureichende Credits, um diese Aufgabe auszufü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 den Build überführt).
Name
429 - Too Many Requests
Description
Sie haben Ihre Ratenbegrenzung überschritten.
Anfrage
POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Antwort
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Build-Beispiel
Die Build-Aufgabe verwandelt das ausgewählte Prototyp-Bild in ein herunterladbares 3D-Modell mit Textur.
Abrufen einer Prototyp- oder Bauaufgabe mit 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.
Eine Figur-Aufgabe abbrechen. 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 Arbeiter könnte bereits Ressourcen verbrauchen). Aufgaben, die bereits einen Endzustand erreicht haben (SUCCEEDED, FAILED, CANCELED), können nicht abgebrochen werden.
Der URL-Pfad muss mit der Phase der Aufgabe übereinstimmen — DELETE auf
/prototype/:buildId gibt 404 zurück.
Pfadparameter
Name
id
Type
path
Description
Eindeutiger Bezeichner für die zu stornierende Figur-Aufgabe.
Rückgaben
Gibt 204 No Content bei Erfolg mit leerem 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 einem anderen Benutzer oder ihre Phase stimmt nicht mit dem URL-Pfad überein.
Streamen Sie Echtzeit-Updates für eine Figur-Aufgabe über Server-Sent Events (SSE).
Der URL-Pfad muss der Phase der Aufgabe entsprechen — das Öffnen eines Streams bei
/prototype/:buildId/stream gibt eine einzelne event: error Payload mit
status_code: 404 aus und schließt den Stream.
Parameter
Name
id
Type
path
Description
Eindeutiger Bezeichner für die zu streamende Figur-Aufgabe.
Rückgaben
Gibt einen Stream von Figure Prototype
oder Figure Build Aufgabenobjekten als
Server-Sent Events zurück. Für PENDING oder IN_PROGRESS Aufgaben wird der Antwortstream
nur die notwendigen progress und status Felder enthalten.
Rufen Sie eine paginierte Liste Ihrer Figur-Aufgaben für eine einzelne Phase ab. Der URL-Pfad wählt die Phase aus — /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
Seitenlimit. Maximal erlaubt sind 50 Elemente.
Name
sort_by
Type
string
Standard -created_at
Description
Feld zum Sortieren. Verfügbare Werte:
+created_at: Sortieren nach Erstellungszeit in aufsteigender Reihenfolge.
-created_at: Sortieren nach Erstellungszeit in absteigender Reihenfolge.
Das Figur-Prototyp-Task-Objekt ist eine Arbeitseinheit, die Meshy verfolgt, um ein chibi-stilisiertes Konzeptbild aus einem Ausgangsfoto zu erstellen. Das Ergebnis dieser Phase wird über input_task_id in die Bauphase eingebunden.
Eigenschaften
Name
id
Type
string
Description
Eindeutiger Bezeichner für die Aufgabe. Obwohl 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 Aufgabe. Der Wert ist creative-lab-figure-prototype.
Name
name
Type
string
Description
Der bei der Erstellung der Aufgabe angegebene Aufgabenname. Leerer String, wenn kein Name angegeben wurde.
Name
status
Type
string
Description
Status der Aufgabe. Mögliche Werte sind 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 ist, wird sie 100.
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, 12:00:00 Uhr 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 ist, ist diese Eigenschaft 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 dann 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 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).
Name
image_urls
Type
array of strings
Description
Herunterladbare URLs für die von dieser Prototyp-Aufgabe generierten Konzeptbildkandidaten. Derzeit gibt die API immer genau einen Kandidaten zurück; das Feld ist ein Array, damit zukünftige Revisionen mehrere Kandidaten ohne eine breaking change bereitstellen können.
Das Figure Build Task Objekt ist eine Arbeitseinheit, die Meshy verfolgt, um eine texturierte 3D-Figur aus einer erfolgreichen Prototyp-Aufgabe zu generieren. Es verwendet denselben Bild-zu-3D-Pipeline, der von Bild zu 3D verwendet wird, sodass die Ausgabefelder das Task-Objekt dieses Endpunkts widerspiegeln.
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-figure-build.
Name
name
Type
string
Description
Der bei der Erstellung der Aufgabe angegebene Aufgabenname. Leerer String, wenn kein Name angegeben wurde.
Name
status
Type
string
Description
Status der Aufgabe. Mögliche Werte sind PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
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
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. Nur sinnvoll, 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 Objekt-Referenz.
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 einem Fehler zurückerstattet).
Name
prompt
Type
string
Description
Immer leer für Figure Build. Vorhanden für die Kompatibilität zwischen Endpunkten mit der gemeinsamen V2ImageTo3DTaskResponse Form, die von Bild zu 3D verwendet wird.
Name
negative_prompt
Type
string
Description
Immer leer für Figure Build. Vorhanden für die Kompatibilität zwischen Endpunkten.
Name
texture_prompt
Type
string
Description
Immer leer für Figure Build. Vorhanden für die Kompatibilität zwischen Endpunkten.
Name
texture_image_url
Type
string
Description
Immer leer für Figure Build. Vorhanden für die Kompatibilität zwischen Endpunkten.
Name
model_urls
Type
object
Description
Herunterladbare URLs für das generierte 3D-Modell. Der Figure Build gibt ein texturiertes GLB plus das OBJ + MTL Paar für Pipelines aus, die Wavefront OBJ bevorzugen. Die Feldform entspricht dem Bild zu 3D model_urls Objekt, sodass zukünftige Format-Ergänzungen ohne eine 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 OBJ-Begleitdatei MTL Material. Kombinieren Sie mit obj und dem Eintrag aus texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Herunterladbare URL zum Miniaturbild der Modelldatei.
Name
texture_urls
Type
array
Description
Ein Array von Textur-URL-Objekten, die von dieser Aufgabe generiert wurden. Derzeit enthält es ein einzelnes Objekt mit der Basisfarbkarte.