Proměňte zdrojovou fotografii ve sběratelskou 3D figurku ve stylu chibi ve dvou fázích:
prototyp vygeneruje stylizovaný koncepční obrázek z vaší vstupní fotografie, poté
sestavení promění tento koncepční obrázek v texturovaný 3D model. Obě fáze
jsou propojeny prostřednictvím input_task_id.
Vygenerujte jeden koncepční obrázek ve stylu chibi ze zdrojové fotografie.
Vrácené ID úlohy je to, co předáte jako input_task_id koncovému bodu pro
sestavení. Podrobnosti o tvaru 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, která je přístupná z veřejného internetu.
Data URI: Base64 kódované data URI obrázku. Příklad data URI: data:image/jpeg;base64,<vaše base64 kódovaná data obrázku>.
Name
name
Type
string
Description
Volitelný název úlohy pro zobrazovací účely. Maximálně 100 znaků.
Name
remove_background
Type
boolean
výchozí false
Description
Když je nastaveno na true, prototypový obrázek se vrátí jako transparentní RGBA PNG s odstraněným pozadím, takže můžete objekt zkombinovat s libovolným pozadím.
Návratová hodnota
Vlastnost result odpovědi obsahuje id úlohy nově vytvořeného prototypu figurky. Dotazujte koncový bod Získání úlohy 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.
Vygenerujte finální texturovanou 3D figurku z úspěšné prototypové úlohy.
Build spouští stejný proces převodu 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í. Podrobnosti o tvaru odpovědi
naleznete v části The Figure Build Task Object.
Parametry
Name
input_task_id
Type
string
Povinné
Description
ID úlohy prototypové úlohy vytvořené prostřednictvím tohoto stejného OpenAPI koncového bodu. Prototyp musel být vytvořen se stejným API klíčem, musel dosáhnout stavu SUCCEEDED a musel vygenerovat přesně jeden kandidátský obrázek.
Prototypové úlohy vytvořené přes webovou aplikaci nejsou akceptovány — koncový bod pro build přijímá pouze prototypové úlohy vytvořené pomocí POST /openapi/creative-lab/figure/v1/prototype a jakýkoli jiný zdroj odmítne s chybou 404.
Name
name
Type
string
Description
Volitelný název úlohy pro zobrazení. Maximálně 100 znaků.
Návratové hodnoty
Vlastnost result v odpovědi obsahuje id úlohy nově vytvořené figure build úlohy. Dotazujte koncový bod Get a Task nebo se přihlaste k odběru streamu, dokud úloha nedosáhne stavu SUCCEEDED, a 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í proces preferuje OBJ).
Způsoby selhání
Name
400 - Bad Request
Description
Požadavek byl nepřijatelný. Časté příčiny:
Chybějící parametr: input_task_id je povinný.
Neplatné UUID: input_task_id není platné UUID.
Nadřazená úloha nebyla úspěšná: Odkazovaná prototypová úloha ještě nedosáhla stavu SUCCEEDED.
Žádný kandidát: Prototypová úloha byla úspěšná, ale nevygenerovala žádný kandidátský 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á prototypová úloha neexistuje, patří jinému uživateli nebo byla vytvořena přes webovou aplikaci (do build úlohy lze zřetězit pouze prototypové úlohy vytvořené v API mode).
Name
429 - Too Many Requests
Description
Překročili jste limit rychlosti.
Request
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" }'
Response
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Příklad buildu
Build úloha přemění vybraný prototypový obrázek na stažitelný texturovaný 3D model.
Načte úlohu prototypu nebo sestavení (build) na základě 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 ve stavu PENDING, kredity
spotřebované při jejím vytvoření budou vráceny. Úlohy, které jsou již
ve stavu IN_PROGRESS, jsou zrušeny bez vrácení kreditů (worker může
už 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.
Návratová hodnota
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 pomocí Server-Sent Events (SSE).
Cesta URL musí odpovídat fázi úlohy — otevření streamu na
/prototype/:buildId/stream vyvolá jediný payload event: error s
status_code: 404 a stream se uzavře.
Parametry
Name
id
Type
path
Description
Jedinečný identifikátor úlohy figurky, kterou chcete streamovat.
Návratová hodnota
Vrací proud objektů úlohy Figure Prototype
nebo Figure Build ve formě Server-Sent Events. Každý snímek nese kompletní objekt úlohy pro danou fázi — ve stejném tvaru, jaký vrací
koncový bod Get — takže dokud je úloha ve stavu PENDING nebo IN_PROGRESS,
výstupní pole prostě ještě nejsou vyplněná (null, [] nebo {}) a
finished_at je null.
Načtěte stránkovaný seznam vašich úkolů figurek pro jednu fázi. Cesta URL
určuje fázi — /prototype vrací úkoly prototypů; /build
vrací úkoly sestavení. Úkoly z druhé fáze nejsou zahrnuty v žádné
z odpovědí.
Path Parameters
Name
stage
Type
path
Povinné
Description
Buď prototype, nebo build. Kolekce vrací pouze úkoly,
jejichž fáze odpovídá adrese URL — načtení /prototype nikdy nevrátí
úkoly sestavení a naopak.
Query Parameters
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á hodnota je 100 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 Figure Prototype Task 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 řetězen do
fáze sestavení pomocí input_task_id.
Vlastnosti
Name
id
Type
string
Description
Jedinečný identifikátor úlohy. Přestože jako implementační detail používáme pro id úloh k-seřaditelné UUID, neměli byste 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 jejím vytvoření. Prázdný řetězec, pokud nebyl žádný název zadán.
Name
status
Type
string
Description
Stav úlohy. Možné hodnoty jsou jedna z PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Postup úlohy (progress). Pokud úloha ještě nebyla zahájena, bude tato vlastnost 0. Jakmile úloha uspěje, změní se 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, které uplynuly od 1. ledna 1970 UTC, podle
standardu RFC 3339.
Například pátek 1. září 2023 12:00:00 PM GMT je reprezentován jako 1693569600000. Toto platí
pro všechna časová razítka v Meshy API.
Name
started_at
Type
timestamp
Description
Časové razítko zahájení úlohy, v milisekundách. Pokud úloha ještě nebyla zahájena, 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ředcházejících úloh.
Hodnota tohoto pole má smysl pouze pokud je stav úlohy PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybě u neúspěšných úloh. Úplnou referenci objektu task_error naleznete v části Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných touto úlohou. Přítomno, pokud je stav úlohy PENDING, IN_PROGRESS nebo SUCCEEDED. Vrací 0 pro úlohy se stavem FAILED (v případě selhání jsou kredity vráceny).
Name
image_urls
Type
array of strings
Description
Stažitelné adresy URL pro kandidátní koncepční obrázky vygenerované touto úlohou prototypu. V současnosti API vždy vrací přesně jednoho kandidáta; pole je pole (array), aby budoucí revize mohly nabídnout více kandidátů bez zásadní změny (breaking change).
Objekt Figure Build Task je pracovní jednotka, kterou Meshy sleduje za účelem
vygenerování texturované 3D figurky z úspěšně dokončeného prototypového úkolu. Používá stejný
pipeline image-to-3D jako Obrázek na 3D,
takže výstupní pole odpovídají objektu úkolu tohoto koncového bodu.
Vlastnosti
Name
id
Type
string
Description
Jedinečný identifikátor úkolu.
Name
type
Type
string
Description
Typ úkolu. Hodnota je creative-lab-figure-build.
Name
name
Type
string
Description
Název úkolu zadaný při jeho vytvoření. Prázdný řetězec, pokud nebyl název zadán.
Name
status
Type
string
Description
Stav úkolu. Možné hodnoty jsou PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Postup (progress) úkolu. Pokud úkol ještě nebyl zahájen, tato vlastnost bude 0. Jakmile úkol úspěšně skončí, hodnota se změní na 100.
Name
created_at
Type
timestamp
Description
Časové razítko vytvoření úkolu, v milisekundách.
Name
started_at
Type
timestamp
Description
Časové razítko zahájení úkolu, v milisekundách.
Name
finished_at
Type
timestamp
Description
Časové razítko dokončení úkolu, v milisekundách.
Name
expires_at
Type
timestamp
Description
Časové razítko vypršení platnosti výsledku úkolu, v milisekundách.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úkolů. Má význam pouze tehdy, pokud je stav PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybě u neúspěšných úkolů. Úplný popis objektu task_error naleznete v části Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných tímto úkolem. U úkolů se stavem FAILED vrací 0 (kredity jsou při selhání vráceny).
Name
prompt
Type
string
Description
U figure build je vždy prázdné. Přítomné kvůli kompatibilitě napříč koncovými body se sdílenou strukturou V2ImageTo3DTaskResponse, kterou používá Obrázek na 3D.
Name
negative_prompt
Type
string
Description
U figure build je vždy prázdné. Přítomné kvůli kompatibilitě napříč koncovými body.
Name
texture_prompt
Type
string
Description
U figure build je vždy prázdné. Přítomné kvůli kompatibilitě napříč koncovými body.
Name
texture_image_url
Type
string
Description
U figure build je vždy prázdné. Přítomné kvůli kompatibilitě napříč koncovými body.
Name
model_urls
Type
object
Description
URL adresy ke stažení vygenerovaného 3D modelu. Figure build vytváří texturovaný soubor GLB a dvojici OBJ + MTL pro pipeline, které preferují formát Wavefront OBJ. Tvar tohoto pole odpovídá objektu model_urls z Obrázek na 3D, takže budoucí přidání formátů proběhne bez zásadní změny.
Name
glb
Type
string
Description
URL adresa ke stažení texturovaného souboru GLB.
Name
obj
Type
string
Description
URL adresa ke stažení souboru Wavefront OBJ (geometrie + UV).
Name
mtl
Type
string
Description
URL adresa ke stažení doprovodného materiálového souboru MTL k souboru OBJ. Používejte společně s obj a záznamem z texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL adresa ke stažení miniatury souboru modelu.
Name
texture_urls
Type
array
Description
Pole objektů URL adres textur vygenerovaných tímto úkolem. Aktuálně obsahuje jeden objekt s mapou základní barvy.
Name
base_color
Type
string
Description
URL adresa ke stažení obrázku mapy základní barvy.