Přeměňte zdrojovou fotografii na sběratelskou 3D figurku ve stylu chibi ve dvou fázích:
prototyp generuje stylizovaný konceptuální obrázek z vaší vstupní fotografie, poté
sestavení přemění tento konceptuální obrázek na 3D model s texturou. Obě fáze
jsou propojeny pomocí input_task_id.
Vygenerujte jediný konceptuální obrázek ve stylu chibi ze zdrojové fotografie. Vrácené ID úkolu je to, co předáte jako input_task_id do koncového bodu sestavení. Podívejte se na Objekt úkolu prototypu figurky pro tvar odpovědi.
Parametry
Name
image_url
Type
string
Povinné
Description
Zdrojová fotografie pro Meshy, která bude stylizována jako chibi figurka. Aktuálně podporujeme formáty .jpg, .jpeg, .png a .webp.
Existují dva způsoby, jak poskytnout obrázek:
Veřejně přístupná URL: URL, 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,<váš base64-kódovaný obrázkový data>.
Name
name
Type
string
Description
Volitelný název úkolu pro zobrazení. Maximálně 100 znaků.
Name
remove_background
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, prototypový obrázek je vrácen jako průhledný RGBA PNG s odstraněným pozadím, takže můžete subjekt složit na jakékoliv pozadí.
Vrací
Vlastnost result odpovědi obsahuje ID úkolu nově vytvořeného úkolu prototypu figurky. Dotazujte koncový bod Získat úkol nebo se přihlaste k odběru streamu, dokud úkol nedosáhne stavu SUCCEEDED, poté toto ID předejte do koncového bodu sestavení jako input_task_id.
Generování finální texturované 3D figurky z úspěšného prototypového úkolu. Sestavení běží stejným obrazovým na 3D potrubím jako Obrázek na 3D, takže formát objektu odpovědi a seznam výstupních URL se přesně shodují. Viz Objekt úkolu pro sestavení figurky pro tvar odpovědi.
Parametry
Name
input_task_id
Type
string
Povinné
Description
ID úkolu prototypu vytvořeného prostřednictvím tohoto stejného OpenAPI koncového bodu. Prototyp musí být vytvořen se stejným API klíčem, musí dosáhnout SUCCEEDED a musí produkovat přesně jeden kandidátní obrázek.
Prototypy vytvořené prostřednictvím webové aplikace nejsou přijímány — koncový bod pro sestavení přijímá pouze prototypy vytvořené pomocí POST /openapi/creative-lab/figure/v1/prototype a odmítá jakýkoli jiný zdroj s 404.
Name
name
Type
string
Description
Volitelný název úkolu pro zobrazovací účely. Maximálně 100 znaků.
Vrací
Vlastnost result odpovědi obsahuje ID úkolu nově vytvořeného úkolu pro sestavení figurky. Dotazujte koncový bod Získat úkol nebo se přihlaste k odběru streamu, dokud úkol nedosáhne SUCCEEDED, poté stáhněte texturovaný GLB z model_urls.glb (nebo pár OBJ + MTL z model_urls.obj a model_urls.mtl, pokud váš následný potrubí preferuje OBJ).
Režimy selhání
Name
400 - Bad Request
Description
Požadavek byl nepřijatelný. Běžné příčiny:
Chybějící parametr: input_task_id je povinný.
Neplatný UUID: input_task_id není platný UUID.
Rodič nedosáhl úspěchu: Odkazovaný prototypový úkol ještě nedosáhl SUCCEEDED.
Žádný kandidát: Prototypový úkol uspěl, ale neprodukoval žádný kandidátní obrázek.
Name
401 - Unauthorized
Description
Autentizace selhala. Zkontrolujte prosím svůj API klíč.
Name
402 - Payment Required
Description
Nedostatečné kredity pro provedení tohoto úkolu.
Name
404 - Not Found
Description
Odkazovaný prototypový úkol neexistuje, patří jinému uživateli nebo byl vytvořen prostřednictvím webové aplikace (pouze prototypové úkoly v režimu API se řetězí do sestavení).
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 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 sestavení
Úkol pro sestavení promění vybraný prototypový obrázek na stahovatelný texturovaný 3D model.
Načtěte úkol prototypu nebo sestavení pomocí platného id úkolu. Cesta URL
musí odpovídat fázi úkolu — úkol sestavení načtený přes
/prototype/:id vrátí 404, a naopak.
Zrušit úkol figurky. Pokud je úkol stále PENDING, kredity spotřebované při vytvoření jsou vráceny. Úkoly, které jsou již IN_PROGRESS, jsou zrušeny bez vrácení (pracovník již může spotřebovávat zdroje). Úkoly, které již dosáhly konečného stavu (SUCCEEDED, FAILED, CANCELED), nelze zrušit.
Cesta URL musí odpovídat fázi úkolu — DELETE na
/prototype/:buildId vrací 404.
Parametry cesty
Name
id
Type
path
Description
Unikátní identifikátor úkolu figurky ke zrušení.
Vrací
Vrací 204 No Content při úspěchu s prázdným tělem.
Režimy selhání
Name
400 - Bad Request
Description
Úkol je již v konečném stavu a nelze jej zrušit.
Name
404 - Not Found
Description
Úkol neexistuje, patří jinému uživateli nebo jeho fáze neodpovídá cestě URL.
Streamujte aktualizace v reálném čase pro úkol s figurkou prostřednictvím Server-Sent Events (SSE).
Cesta URL musí odpovídat fázi úkolu — otevření streamu na
/prototype/:buildId/stream vyvolá jediný event: error payload s
status_code: 404 a uzavře stream.
Parametry
Name
id
Type
path
Description
Unikátní identifikátor pro úkol s figurkou ke streamování.
Vrací
Vrací stream objektů úkolu Figure Prototype
nebo Figure Build jako
Server-Sent Events. Pro úkoly PENDING nebo IN_PROGRESS bude stream
odpovědí obsahovat pouze potřebná pole progress a status.
Získejte stránkovaný seznam svých úkolů pro figurky pro jednu fázi. Cesta URL
vybírá fázi — /prototype vrací úkoly prototypu; /build
vrací úkoly sestavení. Úkoly z jiné fáze nejsou zahrnuty v žádné odpovědi.
Parametry cesty
Name
stage
Type
path
Povinné
Description
Buď prototype nebo build. Kolekce vrací pouze úkoly,
jejichž fáze odpovídá URL — načítání /prototype nikdy nevrátí
úkoly 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 pro řazení. Dostupné hodnoty:
+created_at: Řadit podle času vytvoření vzestupně.
Objekt úkolu prototypu figurky je pracovní jednotka, kterou Meshy sleduje pro
vytvoření chibi-stylu konceptuálního obrázku ze zdrojové fotografie. Výstup
této fáze je propojen do fáze sestavení
pomocí input_task_id.
Vlastnosti
Name
id
Type
string
Description
Unikátní identifikátor pro úkol. I když používáme k-tříděné UUID pro id úkolů jako implementační detail, neměli byste dělat žádné předpoklady o formátu id.
Name
type
Type
string
Description
Typ úkolu. Hodnota je creative-lab-figure-prototype.
Name
name
Type
string
Description
Název úkolu zadaný při vytvoření úkolu. Prázdný řetězec, pokud nebyl poskytnut žádný název.
Name
status
Type
string
Description
Stav úkolu. Možné hodnoty jsou PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Postup úkolu. Pokud úkol ještě nezačal, tato vlastnost bude 0. Jakmile úkol uspěje, stane se 100.
Name
created_at
Type
timestamp
Description
Časové razítko, kdy byl úkol vytvořen, 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, kdy byl úkol zahájen, v milisekundách. Pokud úkol ještě nezačal, tato vlastnost bude 0.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy byl úkol dokončen, v milisekundách. Pokud úkol ještě není dokončen, tato vlastnost bude 0.
Name
expires_at
Type
timestamp
Description
Časové razítko, kdy výsledek úkolu vyprší, v milisekundách.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úkolů.
Hodnota tohoto pole má smysl pouze pokud je stav úkolu PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybách pro neúspěšné úkoly. Viz Chyby pro úplnou referenci objektu task_error.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných tímto úkolem. Přítomno, když je stav úkolu PENDING, IN_PROGRESS nebo SUCCEEDED. Vrací 0 pro úkoly FAILED (kredity jsou v případě selhání vráceny).
Name
image_urls
Type
array of strings
Description
Stahovatelné URL pro kandidáty konceptuálních obrázků generovaných tímto prototypovým úkolem. Aktuálně API vždy vrací přesně jednoho kandidáta; pole je polem, takže budoucí revize mohou zobrazit více kandidátů bez narušení kompatibility.
Objekt úlohy pro vytvoření figurky je pracovní jednotka, kterou Meshy sleduje, aby
vygeneroval texturovanou 3D figurku z úspěšné prototypové úlohy. Používá
stejný proces převodu obrázku na 3D jako Obrázek na 3D,
takže výstupní pole zrcadlí objekt úlohy tohoto koncového bodu.
Vlastnosti
Name
id
Type
string
Description
Unikátní 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 PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress úlohy. Pokud úloha ještě nezačala, tato vlastnost bude 0. Jakmile úloha uspěje, stane se 100.
Name
created_at
Type
timestamp
Description
Časové razítko, kdy byla úloha vytvořena, v milisekundách.
Name
started_at
Type
timestamp
Description
Časové razítko, kdy byla úloha zahájena, v milisekundách.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy byla úloha dokončena, v milisekundách.
Name
expires_at
Type
timestamp
Description
Časové razítko, kdy výsledek úlohy vyprší, v milisekundách.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úloh. Má význam pouze, když je stav PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybě pro neúspěšné úlohy. Viz Chyby pro úplnou referenci objektu task_error.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných touto úlohou. Vrací 0 pro FAILED úlohy (kredity jsou při selhání vráceny).
Name
prompt
Type
string
Description
Vždy prázdné pro vytvoření figurky. Přítomné pro kompatibilitu mezi koncovými body se sdíleným tvarem V2ImageTo3DTaskResponse používaným Obrázek na 3D.
Name
negative_prompt
Type
string
Description
Vždy prázdné pro vytvoření figurky. Přítomné pro kompatibilitu mezi koncovými body.
Name
texture_prompt
Type
string
Description
Vždy prázdné pro vytvoření figurky. Přítomné pro kompatibilitu mezi koncovými body.
Name
texture_image_url
Type
string
Description
Vždy prázdné pro vytvoření figurky. Přítomné pro kompatibilitu mezi koncovými body.
Name
model_urls
Type
object
Description
Stahovatelné URL pro vygenerovaný 3D model. Vytvoření figurky generuje texturovaný GLB plus pár OBJ + MTL pro procesy, které preferují Wavefront OBJ. Tvar pole odpovídá objektu Obrázek na 3D model_urls, takže budoucí přidání formátů proběhne bez narušení.
Name
glb
Type
string
Description
Stahovatelné URL pro texturovaný GLB soubor.
Name
obj
Type
string
Description
Stahovatelné URL pro Wavefront OBJ soubor (geometrie + UV).
Name
mtl
Type
string
Description
Stahovatelné URL pro doprovodný MTL materiálový soubor k OBJ. Spárujte s obj a položkou z texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Stahovatelné URL pro miniaturu obrázku modelového souboru.
Name
texture_urls
Type
array
Description
Pole objektů URL textur generovaných touto úlohou. Aktuálně obsahuje jeden objekt se základní barevnou mapou.
Name
base_color
Type
string
Description
Stahovatelné URL pro obrázek základní barevné mapy.