Proměňte zdrojovou fotografii na sběratelskou 3D figurku s velkou hlavou ve dvou
fázích: prototyp generuje stylizovaný konceptní obraz z vaší vstupní
fotografie, poté sestavení tento konceptní obraz přetváří na 3D model s texturou.
Oba kroky jsou propojeny pomocí input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Vygenerujte jedinečný obrázek konceptu 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
The Vinyl Figure Prototype Task Object
pro tvar odpovědi.
Parametry
Name
image_url
Type
string
Povinné
Description
Zdrojová fotografie, kterou má Meshy vyzdobit 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 účely zobrazení. Maximálně 100 znaků.
Vrací
result vlastnost odpovědi obsahuje id nově vytvořeného úkolu prototypu vinylové figurky. Dotazujte koncový bod Get a Task nebo se přihlašte k odběru streamu, dokud úkol nedosáhne stavu SUCCEEDED, poté předáte toto ID do build endpoint jako input_task_id.
Vygenerovat konečnou figurku s 3D texturou z úspěšného prototypu úkolu. Sestavení běží ve stejné pipeline Obrázek na 3D jako
Obrázek na 3D, takže formát objektu odpovědi a
seznam výstupních URL adres se přesně shodují. Podívejte se na
Objekt úlohy 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 téhož OpenAPI koncového bodu. Prototyp musel být vytvořen se stejným API klíčem, musel dosáhnout SUCCEEDED a musel vyprodukovat přesně jeden kandidátní obrázek.
Prototypy vytvořené prostřednictvím webové aplikace nejsou přijímány — koncový bod sestavení akceptuje pouze prototypy 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é jméno úkolu pro zobrazení. Maximálně 100 znaků.
Návratové hodnoty
Vlastnost result odpovědi obsahuje id úkolu nově vytvořené úlohy sestavení vinylové figurky. Dotazujte koncový bod Získat úlohu nebo se přihlaste k odběru streamu, dokud úloha nedosáhne SUCCEEDED, a poté stáhněte GLB s texturou z model_urls.glb (nebo dvojici OBJ + MTL z model_urls.obj a model_urls.mtl, pokud vaše downstream 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 vyžadován.
Neplatné UUID: input_task_id není platné UUID.
Rodič nebyl úspěšný: Odkazovaný prototyp úkolu ještě nedosáhl SUCCEEDED.
Žádný kandidát: Prototyp úkolu byl úspěšný, ale nevyprodukoval žádný kandidátní obrázek.
Name
401 - Unauthorized
Description
Autentizace selhala. Zkontrolujte prosím váš API klíč.
Name
402 - Payment Required
Description
Nedostatečné kredity k provedení tohoto úkolu.
Name
404 - Not Found
Description
Odkazovaný prototyp úkolu neexistuje, patří jinému uživateli nebo byl vytvořen prostřednictvím webové aplikace (pouze prototypy v režimu API se řetězí do sestavení).
Name
429 - Too Many Requests
Description
Překročili jste váš limit rychlosti.
Požadavek
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Fáze 2: navázání sestavení na úspěšný prototyp úkolucurl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de" }'
Načtěte prototyp nebo build úkol pomocí platného id úkolu. Cesta URL musí odpovídat fázi úkolu — build úkol načtený přes
/prototype/:id vrátí 404, a naopak.
Zrušit úkol na vinylovou figurku. Pokud je úkol stále ještě PENDING, jsou při vytvoření spotřebované kredity vráceny. Úkoly, které již jsou ve stavu IN_PROGRESS, jsou zrušeny bez vrácení peněz (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 na vinylovou figurku, který má být zrušen.
Vrací
Vrací 204 No Content při úspěchu s prázdným tělem.
Módy chyb
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 fáze neodpovídá cestě URL.
Streamování aktualizací v reálném čase pro úlohu vinylové figurky přes Server-Sent Events (SSE). Cesta URL musí odpovídat fázi úlohy — otevření streamu na /prototype/:buildId/stream vysílá jeden event: error payload s status_code: 404 a uzavírá stream.
Parametry
Name
id
Type
path
Description
Jedinečný identifikátor pro úlohu vinylové figurky ke streamování.
Vrátí
Vrátí stream objektů úloh Vinylová Figurková Prototyp nebo Vinylová Figurková Stavba jako Server-Sent Events. Pro úlohy PENDING nebo IN_PROGRESS bude stream odpovědí zahrnovat pouze nezbytná pole progress a status.
Získejte stránkovaný seznam svých úkolů vinilových figurek pro jedinou fázi.
Cesta URL vybírá fázi — /prototype vrací úkoly prototypu;
/build vrací úkoly stavby. Úkoly z druhé 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 — vyžadování /prototype nikdy nevrátí
ú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í povolená hodnota 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 Vinyl Figure prototypu je pracovní jednotka, kterou Meshy sleduje,
aby vytvořila konceptuální obrázek ve stylu vinylové figurky ze zdrojové fotografie.
Výstup této fáze je propojen s
fáze sestavení pomocí input_task_id.
Vlastnosti
Name
id
Type
string
Description
Unikátní identifikátor úkolu. Přestože jako implementační detail používáme k-tříděné UUID pro id úkolů, neměli byste dělat žádné předpoklady ohledně formátu id.
Name
type
Type
string
Description
Typ úkolu. Hodnota je creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
Název úkolu poskytnutý 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 jedna z 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, toto se stane 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 od 1. ledna 1970 UTC, následující
standard 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 vyprší výsledek úkolu, v milisekundách.
Name
preceding_tasks
Type
integer
Description
Počet předešlý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. Podívejte se na 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 FAILED úkoly (kredity jsou při neúspěchu vráceny).
Name
image_urls
Type
array of strings
Description
Stahovatelné URL adresy pro koncept kandidátů na obrázky generované tímto prototypovým úkolem. Aktuálně API vždy vrací přesně jednoho kandidáta; pole je pole, aby budoucí úpravy mohly zobrazit více kandidátů bez porušení compatibility.
Objekt úlohy sestavení vinylové figurky je pracovní jednotka, kterou Meshy sleduje,
aby vygeneroval texturovanou 3D vinylovou figurku z úspěšné prototypové úlohy.
Používá stejný proces Obrázek na 3D, který využívá Obrázek na 3D,
takže výstupní pole zrcadlí objekt úlohy tohoto koncového bodu task object.
Vlastnosti
Name
id
Type
string
Description
Jedinečný identifikátor úkolu.
Name
type
Type
string
Description
Typ úkolu. Hodnota je creative-lab-vinyl-figure-build.
Name
name
Type
string
Description
Název úkolu dodaný při vytvář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
Progrese úkolu. Pokud úkol ještě nezačal, bude tato vlastnost 0. Jakmile bude úkol úspěšný, tuto hodnotu bude mít 100.
Name
created_at
Type
timestamp
Description
Časové razítko, kdy byl úkol vytvořen, v milisekundách.
Name
started_at
Type
timestamp
Description
Časové razítko, kdy byl úkol zahájen, v milisekundách.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy byl úkol dokončen, v milisekundách.
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ů. Má smysl pouze, když je stav PENDING.
Name
task_error
Type
object
Description
Podrobnosti chyb pro neúspěšné úkoly. Podívejte se na Chyby pro plnou referenci objektu task_error.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných tímto úkolem. Vrací 0 pro neúspěšné úkoly (kredity jsou vráceny v případě neúspěchu).
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
Stažitelné URL pro generovaný 3D model. Stavba vinylové figurky emituje texturovaný GLB plus pár OBJ + MTL pro potrubí, která preferují Wavefront OBJ. Tvar pole odpovídá objektu Obrázek na 3D model_urls, aby se budoucí přidání formátu vešla bez přerušení změny.
Name
glb
Type
string
Description
Stažitelná URL na texturovaný GLB soubor.
Name
obj
Type
string
Description
Stažitelná URL na Wavefront OBJ soubor (geometrie + UV).
Name
mtl
Type
string
Description
Stažitelná URL na MTL soubor materiálu doprovázejícího OBJ. Spárovat s obj a položkou z texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Stažitelná URL na miniaturu modelového souboru.
Name
texture_urls
Type
array
Description
Pole objektů URL textur generovaných tímto úkolem. V současné době obsahuje jeden objekt se základní mapou barev.