Proměňte zdrojovou fotografii ve sběratelskou 3D figurku ve stylu chibi ve dvou fázích:
prototyp vygeneruje stylizovaný konceptový obrázek z vaší vstupní fotografie, poté
sestavení promění tento konceptový obrázek v 3D model s mapami textur. Obě fáze
jsou propojené prostřednictvím input_task_id.
Vygenerujte jeden koncepční obrázek ve stylu chibi ze zdrojové fotografie.
Vrácené ID úlohy je to, které předáte jako input_task_id koncovému bodu
pro sestavení. Informace o struktuře odpovědi najdete v části
Objekt úlohy prototypu figurky.
Parametry
Name
image_url
Type
string
Povinné
Description
Zdrojová fotografie, kterou má Meshy stylizovat jako chibi figurku. Aktuálně podporujeme formáty .jpg, .jpeg, .png a .webp.
Obrázek lze poskytnout dvěma způsoby:
Veřejně přístupná URL adresa: URL adresa dostupná z veřejného internetu.
Data URI: Data URI obrázku zakódovaný v base64. Příklad Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Volitelný název úlohy pro účely zobrazení. Maximálně 100 znaků.
Návratová hodnota
Vlastnost result odpovědi obsahuje id nově vytvořené úlohy prototypu figurky. Dotazujte se na koncový bod Získat úlohu nebo se přihlaste k odběru streamu, dokud úloha nedosáhne stavu SUCCEEDED, a poté toto ID předejte koncovému bodu pro sestavení jako input_task_id.
Režimy selhání
Name
400 - Bad Request
Description
Požadavek nebyl přijatelný. Časté příčiny:
Chybějící parametr: image_url je povinný.
Neplatný formát obrázku: Poskytnuté image_url není v podporovaném formátu (.jpg, .jpeg, .png, .webp).
Rozměry obrázku mimo rozsah: Obrázek je příliš malý, překračuje maximální velikost souboru nebo překračuje maximální počet pixelů.
Nedostupná URL adresa: image_url se nepodařilo stáhnout (404 nebo timeout).
Neplatný Data URI: Řetězec base64 má nesprávný formát.
Označený obsah: Vstupní obrázek byl označen moderation kvůli NSFW obsahu nebo duševnímu vlastnictví.
Name
401 - Unauthorized
Description
Autentizace selhala. Zkontrolujte prosím svůj API klíč.
Name
402 - Payment Required
Description
Nedostatek kreditů k provedení této úlohy.
Name
429 - Too Many Requests
Description
Překročili jste svůj limit rychlosti.
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.
Vygenerujte finální 3D figurku s texturami z úspěšné úlohy prototypu.
Sestavení spouští stejný pipeline obrázku na 3D jako
Obrázek na 3D, takže formát objektu odpovědi a
seznam výstupních URL přesně odpovídají. Tvar odpovědi najdete v části
Objekt úlohy sestavení figurky.
Parametry
Name
input_task_id
Type
string
Povinné
Description
ID úlohy prototypu vytvořené prostřednictvím stejného koncového bodu OpenAPI. Prototyp musel být vytvořen se stejným API klíčem, musel dosáhnout stavu SUCCEEDED a musel vytvořit přesně jeden kandidátní obrázek.
Úlohy prototypu vytvořené přes webovou aplikaci nejsou přijímány — koncový bod sestavení přijímá pouze úlohy prototypu vytvořené pomocí POST /openapi/creative-lab/figure/v1/prototype a jakýkoli jiný zdroj odmítne s 404.
Name
name
Type
string
Description
Volitelný název úlohy pro účely zobrazení. Maximálně 100 znaků.
Vrací
Vlastnost result odpovědi obsahuje id nově vytvořené úlohy sestavení figurky. Dotazujte se na koncový bod Získat úlohu nebo se přihlaste k odběru streamu, dokud úloha nedosáhne stavu SUCCEEDED, poté stáhněte texturovaný GLB z model_urls.glb (nebo dvojici OBJ + MTL z model_urls.obj a model_urls.mtl, pokud váš navazující pipeline preferuje OBJ).
Režimy selhání
Name
400 - Bad Request
Description
Požadavek nebyl přijatelný. Běžné příčiny:
Chybějící parametr: input_task_id je povinný.
Neplatné UUID: input_task_id není platné UUID.
Nadřazená úloha není úspěšná: Odkazovaná úloha prototypu ještě nedosáhla stavu SUCCEEDED.
Žádný kandidát: Úloha prototypu uspěla, ale nevytvořila žádný kandidátní obrázek.
Name
401 - Unauthorized
Description
Autentizace selhala. Zkontrolujte prosím svůj API klíč.
Name
402 - Payment Required
Description
Nedostatek kreditů k provedení této úlohy.
Name
404 - Not Found
Description
Odkazovaná úloha prototypu neexistuje, patří jinému uživateli nebo byla vytvořena přes webovou aplikaci (do sestavení lze řetězit pouze úlohy prototypu v API mode).
Name
429 - Too Many Requests
Description
Překročili jste svůj limit rychlosti.
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 example
The build task turns the selected prototype image into a downloadable textured 3D model.
Načte úlohu prototypu nebo sestavení podle platného id úlohy. Cesta URL
musí odpovídat fázi úlohy — úloha sestavení načtená přes
/prototype/:id vrátí 404 a naopak.
Zruší úlohu figurky. Pokud je úloha stále PENDING, kredity
spotřebované při vytvoření se vrátí. Úlohy, které jsou již
IN_PROGRESS, se zruší bez vrácení kreditů (worker už může
spotřebovávat zdroje). Úlohy, které již dosáhly konečného stavu
(SUCCEEDED, FAILED, CANCELED), nelze zrušit.
Cesta URL musí odpovídat fázi úlohy — DELETE na
/prototype/:buildId vrátí 404.
Parametry cesty
Name
id
Type
path
Description
Jedinečný identifikátor úlohy figurky, kterou chcete zrušit.
Vrací
Při úspěchu vrací 204 No Content s prázdným tělem.
Režimy selhání
Name
400 - Bad Request
Description
Úloha je již v konečném stavu a nelze ji zrušit.
Name
404 - Not Found
Description
Úloha neexistuje, patří jinému uživateli nebo její fáze neodpovídá cestě URL.
Streamujte aktualizace úlohy figurky v reálném čase prostřednictvím Server-Sent Events (SSE).
Cesta URL musí odpovídat fázi úlohy — otevření streamu na
/prototype/:buildId/stream vyšle jeden event: error payload s
status_code: 404 a stream zavře.
Parametry
Name
id
Type
path
Description
Jedinečný identifikátor úlohy figurky, kterou chcete streamovat.
Vrací
Vrací stream objektů úloh Prototyp figurky
nebo Sestavení figurky jako
Server-Sent Events. U úloh PENDING nebo IN_PROGRESS bude stream
odpovědi obsahovat pouze nezbytná pole progress a status.
Načte stránkovaný seznam vašich úloh figurky pro jednu fázi. Cesta URL
vybírá fázi — /prototype vrací úlohy prototypu; /build
vrací úlohy sestavení. Úlohy z druhé fáze nejsou zahrnuty v žádné
odpovědi.
Parametry cesty
Name
stage
Type
path
Povinné
Description
Buď prototype, nebo build. Kolekce vrací pouze úlohy,
jejichž fáze odpovídá URL — načtení /prototype nikdy nevrátí
úlohy sestavení a naopak.
Parametry dotazu
Name
page_num
Type
integer
výchozí 1
Description
Číslo stránky pro stránkování.
Name
page_size
Type
integer
výchozí 10
Description
Limit velikosti stránky. Maximální povolený počet je 50 položek.
Name
sort_by
Type
string
výchozí -created_at
Description
Pole, podle kterého se má řadit. Dostupné hodnoty:
+created_at: Řadit podle času vytvoření vzestupně.
Objekt úlohy prototypu figurky je pracovní jednotka, kterou Meshy sleduje za účelem
vygenerování koncepčního obrázku ve stylu chibi ze zdrojové fotografie. Výstup
této fáze je zřetězen do fáze sestavení
prostřednictvím input_task_id.
Vlastnosti
Name
id
Type
string
Description
Jedinečný identifikátor úlohy. I když jako implementační detail používáme pro ID úloh k-sortable UUID, neměli byste si dělat žádné předpoklady o formátu id.
Name
type
Type
string
Description
Typ úlohy. Hodnota je creative-lab-figure-prototype.
Name
name
Type
string
Description
Název úlohy zadaný při vytvoření úlohy. Prázdný řetězec, pokud nebyl zadán žádný název.
Name
status
Type
string
Description
Stav úlohy. Možné hodnoty jsou jedna z PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
progress úlohy. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 0. Jakmile úloha úspěšně skončí, hodnota se změní na 100.
Name
created_at
Type
timestamp
Description
Časové razítko vytvoření úlohy v milisekundách.
Časové razítko představuje počet milisekund uplynulých od 1. ledna 1970 UTC podle
standardu RFC 3339.
Například pátek 1. září 2023 12:00:00 GMT je reprezentován jako 1693569600000. To platí
pro všechna časová razítka v Meshy API.
Name
started_at
Type
timestamp
Description
Časové razítko spuštění úlohy v milisekundách. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 0.
Name
finished_at
Type
timestamp
Description
Časové razítko dokončení úlohy v milisekundách. Pokud úloha ještě nebyla dokončena, bude tato vlastnost 0.
Name
expires_at
Type
timestamp
Description
Časové razítko vypršení platnosti výsledku úlohy v milisekundách.
Name
preceding_tasks
Type
integer
Description
Počet předchozích úloh.
Hodnota tohoto pole má význam pouze v případě, že stav úlohy je PENDING.
Name
task_error
Type
object
Description
Podrobnosti chyby pro neúspěšné úlohy. Úplnou referenci objektu task_error najdete v části Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných touto úlohou. Přítomno, když je stav úlohy PENDING, IN_PROGRESS nebo SUCCEEDED. Pro úlohy FAILED vrací 0 (kredity jsou při selhání vráceny).
Name
image_urls
Type
array of strings
Description
URL ke stažení kandidátních konceptuálních obrázků vygenerovaných touto prototypovou úlohou. API v současnosti vždy vrací přesně jednoho kandidáta; pole je polem proto, aby budoucí revize mohly zpřístupnit více kandidátů bez zásadní změny.
Objekt úlohy sestavení figurky je pracovní jednotka, kterou Meshy sleduje za účelem
generování otexturované 3D figurky z úspěšně dokončené úlohy prototypu. Spouští
stejný pipeline obrázku na 3D, jaký používá Obrázek na 3D,
takže výstupní pole odpovídají objektu úlohy tohoto koncového bodu.
Vlastnosti
Name
id
Type
string
Description
Jedinečný identifikátor úlohy.
Name
type
Type
string
Description
Typ úlohy. Hodnota je creative-lab-figure-build.
Name
name
Type
string
Description
Název úlohy zadaný při jejím vytvoření. Prázdný řetězec, pokud nebyl zadán žádný název.
Name
status
Type
string
Description
Stav úlohy. Možné hodnoty jsou jedna z PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress úlohy. Pokud úloha ještě nebyla spuštěna, tato vlastnost bude 0. Jakmile úloha úspěšně skončí, bude mít hodnotu 100.
Name
created_at
Type
timestamp
Description
Časové razítko vytvoření úlohy v milisekundách.
Name
started_at
Type
timestamp
Description
Časové razítko spuštění úlohy v milisekundách.
Name
finished_at
Type
timestamp
Description
Časové razítko dokončení úlohy v milisekundách.
Name
expires_at
Type
timestamp
Description
Časové razítko vypršení platnosti výsledku úlohy v milisekundách.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úloh. Smysluplné pouze tehdy, když je status PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybě u neúspěšných úloh. Úplnou referenci objektu task_error najdete v části Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných touto úlohou. Pro úlohy FAILED vrací 0 (kredity jsou při selhání vráceny).
Name
prompt
Type
string
Description
Pro sestavení figurky vždy prázdné. Přítomno kvůli kompatibilitě napříč koncovými body se sdíleným tvarem V2ImageTo3DTaskResponse používaným službou Obrázek na 3D.
Name
negative_prompt
Type
string
Description
Pro sestavení figurky vždy prázdné. Přítomno kvůli kompatibilitě napříč koncovými body.
Name
texture_prompt
Type
string
Description
Pro sestavení figurky vždy prázdné. Přítomno kvůli kompatibilitě napříč koncovými body.
Name
texture_image_url
Type
string
Description
Pro sestavení figurky vždy prázdné. Přítomno kvůli kompatibilitě napříč koncovými body.
Name
model_urls
Type
object
Description
URL ke stažení pro vygenerovaný 3D model. Sestavení figurky vytváří GLB s texturou plus dvojici OBJ + MTL pro pipeline, které preferují Wavefront OBJ. Tvar pole odpovídá objektu model_urls v Obrázek na 3D, takže budoucí přidání formátů lze zařadit bez průlomové změny.
Name
glb
Type
string
Description
URL ke stažení pro soubor GLB s texturou.
Name
obj
Type
string
Description
URL ke stažení pro soubor Wavefront OBJ (geometrie + UV).
Name
mtl
Type
string
Description
URL ke stažení pro doprovodný soubor materiálu MTL k OBJ. Použijte společně s obj a položkou z texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL ke stažení pro obrázek miniatury souboru modelu.
Name
texture_urls
Type
array
Description
Pole objektů s URL textur vygenerovaných touto úlohou. Aktuálně obsahuje jeden objekt s mapou základní barvy.