Přeměňte zdrojovou fotografii na sběratelskou vinylovou figurku s velkou hlavou 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 prostřednictvím input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Generujte jediný konceptuální obrázek ve stylu vinylové figurky ze zdrojové fotografie. Vrácené ID úkolu je to, co předáte jako input_task_id do koncového bodu pro sestavení. Podívejte se na
Objekt úkolu pro prototyp vinylové figurky
pro tvar odpovědi.
Parametry
Name
image_url
Type
string
Povinné
Description
Zdrojová fotografie pro Meshy, aby ji stylizovala jako vinylovou figurku s velkou hlavou. V současné době 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,<your base64-encoded image 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
Když 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 kompozitovat na jakékoli pozadí.
Vrací
Vlastnost result odpovědi obsahuje ID úkolu nově vytvořeného úkolu pro prototyp vinylové figurky. Pollujte koncový bod Získat úkol nebo se přihlaste k odběru streamu dokud úkol nedosáhne SUCCEEDED, poté předáte toto ID do koncového bodu pro sestavení jako input_task_id.
Generujte finální 3D vinylovou figurku s texturou z úspěšného prototypového úkolu. Sestavení používá stejný pipeline Obrázek na 3D jako Obrázek na 3D, takže formát objektu odpovědi a seznam výstupních URL se přesně shodují. Podívejte se na Objekt úkolu pro sestavení vinylové 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.
Prototypové úkoly vytvořené prostřednictvím webové aplikace nejsou akceptovány — koncový bod pro sestavení přijímá pouze prototypové úkoly vytvořené pomocí POST /openapi/creative-lab/vinyl-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í vinylové 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 dvojici OBJ + MTL z model_urls.obj a model_urls.mtl, pokud váš následný pipeline 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.
Požadavek
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de" }'
Načíst prototyp nebo úkol sestavení s platným 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 vinylové 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 náhrady (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 vinylové figurky ke zrušení.
Návratové hodnoty
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 vinylové figurky prostřednictvím Server-Sent Events (SSE). Cesta URL musí odpovídat fázi úkolu — otevření streamu na /prototype/:buildId/stream vyvolá jednorázový event: error payload s status_code: 404 a uzavře stream.
Parametry
Name
id
Type
path
Description
Jedinečný identifikátor pro úkol vinylové figurky ke streamování.
Vrací
Vrací stream objektů úkolu Vinylová figurka Prototyp nebo Vinylová figurka Stavba jako Server-Sent Events. Pro úkoly PENDING nebo IN_PROGRESS bude stream odpovědi obsahovat pouze nezbytná pole progress a status.
Získejte stránkovaný seznam svých úkolů pro vinylovou figurku pro jednu fázi.
Cesta URL vybírá fázi — /prototype vrací úkoly prototypu;
/build vrací úkoly stavby. Úkoly z jiné fáze nejsou zahrnuty
v žádné z odpovědí.
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 nevrací
úkoly stavby 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ě povoleno je 50 položek.
Name
sort_by
Type
string
výchozí -created_at
Description
Pole pro řazení. Dostupné hodnoty:
+created_at: Řazení podle času vytvoření vzestupně.
-created_at: Řazení podle času vytvoření sestupně.
Objekt úlohy prototypu vinylové figurky je pracovní jednotka, kterou Meshy sleduje
pro generování konceptuálního obrázku ve stylu vinylové figurky z výchozí fotografie.
Výstup této fáze je propojen do
fáze sestavení prostřednictvím input_task_id.
Vlastnosti
Name
id
Type
string
Description
Unikátní identifikátor pro úlohu. I když používáme k-tříděné UUID pro id úloh jako implementační detail, neměli byste dělat žádné předpoklady o formátu id.
Name
type
Type
string
Description
Typ úlohy. Hodnota je creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
Název úlohy zadaný při vytvoření úlohy. Prázdný řetězec, pokud nebyl poskytnut žá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
Postup ú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.
Č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 byla úloha zahájena, v milisekundách. Pokud úloha ještě nezačala, tato vlastnost bude 0.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy byla úloha dokončena, v milisekundách. Pokud úloha ještě není dokončena, tato vlastnost bude 0.
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.
Hodnota tohoto pole má smysl pouze pokud je stav úlohy PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybách 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. Přítomno, když je stav úlohy PENDING, IN_PROGRESS nebo SUCCEEDED. Vrací 0 pro úlohy FAILED (kredity jsou při selhání vráceny).
Name
image_urls
Type
array of strings
Description
Stahovatelné URL pro kandidáty konceptuálních obrázků generovaných touto prototypovou úlohou. 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 zásadní změny.
Objekt úlohy pro stavbu vinylové figurky je pracovní jednotka, kterou Meshy sleduje
pro generování texturované 3D vinylové figurky z úspěšné prototypové úlohy.
Používá stejný pipeline Obrázek na 3D jako Obrázek na 3D,
takže výstupní pole zrcadlí objekt úlohy tohoto koncového bodu task object.
Vlastnosti
Name
id
Type
string
Description
Unikátní identifikátor pro úlohu.
Name
type
Type
string
Description
Typ úlohy. Hodnota je creative-lab-vinyl-figure-build.
Name
name
Type
string
Description
Název úlohy zadaný při vytvoření úlohy. Prázdný řetězec, pokud nebyl poskytnut žá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 spuštěna, 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á smysl 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 úlohy FAILED (kredity jsou při neúspěchu vráceny).
Name
prompt
Type
string
Description
Vždy prázdné pro stavbu vinylové 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 stavbu vinylové figurky. Přítomné pro kompatibilitu mezi koncovými body.
Name
texture_prompt
Type
string
Description
Vždy prázdné pro stavbu vinylové figurky. Přítomné pro kompatibilitu mezi koncovými body.
Name
texture_image_url
Type
string
Description
Vždy prázdné pro stavbu vinylové figurky. Přítomné pro kompatibilitu mezi koncovými body.
Name
model_urls
Type
object
Description
Stahovatelné URL pro generovaný 3D model. Stavba vinylové figurky vydává texturovaný GLB plus pár OBJ + MTL pro pipeline, které preferují Wavefront OBJ. Tvar pole odpovídá objektu Image to 3D model_urls, takže budoucí přidání formátů proběhne bez narušení.
Name
glb
Type
string
Description
Stahovatelné URL k texturovanému GLB souboru.
Name
obj
Type
string
Description
Stahovatelné URL k Wavefront OBJ souboru (geometrie + UV).
Name
mtl
Type
string
Description
Stahovatelné URL k doprovodnému MTL materiálovému souboru pro OBJ. Spárujte s obj a položkou z texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Stahovatelné URL k miniatuře obrázku souboru modelu.
Name
texture_urls
Type
array
Description
Pole objektů URL textur generovaných touto úlohou. Aktuálně obsahuje jediný objekt se základní barevnou mapou.