Převeďte zdrojovou fotografii do 3D minifigurky ve stylu cihel ve dvou krocích:
prototyp generuje stylizovaný koncept z vaší vstupní fotografie, poté
stavba přemění tento konceptový obraz na 3D model s texturou. Oba kroky
jsou propojeny přes input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Vygenerujte jeden obrázek konceptu ve stylu kostek z výchozí fotografie. Vrácený ID úkolu předáte jako input_task_id na koncový bod build. Viz Objekt úlohy prototypu figurky z kostek pro tvar odpovědi.
Parametry
Name
image_url
Type
string
Povinné
Description
Výchozí fotografie pro Meshy ke stylizaci jako figurku z kostek. 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 dostupná z veřejného internetu.
Data URI: Data URI obrázku zakódovaná pomocí base64. Příklad data URI: data:image/jpeg;base64,<vaše base64-zakódovaná data obrázku>.
Name
name
Type
string
Description
Volitelný název úkolu pro účely zobrazení. Maximálně 100 znaků.
Návraty
Vlastnost result odpovědi obsahuje ID úkolu nově vytvořené úlohy prototypu figurky z kostek. Pohledejte koncový bod Získání úlohy nebo se přihlaste k odběru proudu, dokud úloha nedosáhne stavu SUCCEEDED, a poté předáte toto ID do koncového bodu build jako input_task_id.
Generování závěrečné cihlové figurky s texturou z úspěšného prototypového úkolu. Výroba probíhá v rámci stejné image-to-3D pipeline 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 tvorbu cihlové figurky pro tvar odpovědi.
Parametry
Name
input_task_id
Type
string
Povinné
Description
ID úkolu prototypového úkolu vytvořeného 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 SUCCEEDED, a musel produkovat přesně jeden kandidátní obrázek.
Prototypové úkoly vytvořené prostřednictvím webové aplikace nejsou přijaty — koncový bod přijímá pouze prototypové úkoly vytvořené
POST /openapi/creative-lab/brick-figure/v1/prototype a odmítá jakýkoliv jiný zdroj s 404.
Name
name
Type
string
Description
Nepovinný název úkolu pro zobrazení. Maximálně 100 znaků.
Vrátí
Vlastnost result odpovědi obsahuje ID úkolu nově vytvořeného úkolu pro tvoření cihlové figurky. Kontrolujte Získání úkolu koncový bod 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 vaše pipeline preferuje OBJ).
Způsoby 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 stále nedosáhl SUCCEEDED.
Žádný kandidát: Prototypový úkol uspěl, ale nevyprodukoval žádný kandidátní obrázek.
Name
401 - Unauthorized
Description
Autentizace neuspěla. Zkontrolujte prosím svůj API klíč.
Name
402 - Payment Required
Description
Nedostatečné kredity k 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 API režimu se mohou rozvětvit na výrobu).
Name
429 - Too Many Requests
Description
Překročili jste svůj limit rychlosti.
Požadavek
POST
/openapi/creative-lab/brick-figure/v1/build
# Fáze 2: napojení výroby na úspěšný prototypový úkolcurl https://api.meshy.ai/openapi/creative-lab/brick-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" }'
Načtěte prototyp nebo stavěcí úkol na základě platného úkolového id. Cesta URL
musí odpovídat fázi úkolu — stavěcí úkol načtený přes
/prototype/:id vrátí 404 a naopak.
Zrušit úkol s figurkou z kostek. Pokud je úkol stále PENDING, kredity spotřebované při vytváření jsou vráceny. Úkoly, které jsou již IN_PROGRESS, jsou zrušeny bez vrácení (pracovník již může spalovat zdroje). Úkoly, které již dosáhly koncového stavu (SUCCEEDED, FAILED, CANCELED), nelze zrušit.
Cesta URL musí odpovídat fázi úkolu — DELETE na /prototype/:buildId vrátí 404.
Parametry cesty
Name
id
Type
path
Description
Jedinečný identifikátor pro úkol s figurkou z kostek, který se má zrušit.
Návratové hodnoty
Vrátí 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 koncovém stavu a nelze jej zrušit.
Name
404 - Not Found
Description
Úkol neexistuje, náleží jinému uživateli nebo jeho fáze neodpovídá cestě URL.
Streamování aktualizací v reálném čase pro úkol s cihlovou figurkou prostřednictvím Server-Sent Events (SSE).
Cesta URL musí odpovídat fázi úkolu — otevření streamu na
/prototype/:buildId/stream vyšle jediný event: error payload s
status_code: 404 a uzavře stream.
Parametry
Name
id
Type
path
Description
Jedinečný identifikátor pro úkol s cihlovou figurkou ke streamování.
Výstupy
Vrátí proud objektů úkolů Cihlová figurka - Prototyp
nebo Cihlová figurka - Stavba jako
Server-Sent Events. Pro úkoly ve stavu PENDING nebo IN_PROGRESS proud
odpovědi zahrne pouze nezbytná pole progress a status.
// Příklad události chyby (špatná fáze nebo úkol nenalezen)event: errordata: {"status_code": 404,"message": "Task not found"}// Příklady událostí zpráv ilustrují postup úkolu.// Pro úkoly ve stavu PENDING nebo IN_PROGRESS, proud odpovědi nebude obsahovat všechna pole.event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","progress": 0,"status": "PENDING"}event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","type": "creative-lab-brick-figure-build","status": "SUCCEEDED","progress": 100,"created_at": 1729123500000,"started_at": 1729123510000,"finished_at": 1729123535000,"expires_at": 1729382735000,"task_error": null,"consumed_credits": 30,"prompt": "","negative_prompt": "","texture_prompt": "","texture_image_url": "","model_urls": {"glb":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***","obj":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***","mtl":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***" },"thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***","texture_urls": [ {"base_color":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***" } ]}
Získejte stránkovaný seznam vašich úkolů figurek z kostek pro jednu fázi. Cesta URL
vybírá fázi — /prototype vrací prototypové úkoly; /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 — získání /prototype nikdy nevrací
ú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ě povoleno je 100 položek.
Name
sort_by
Type
string
výchozí -created_at
Description
Pole pro třídění. Dostupné hodnoty:
+created_at: Třídit podle času vytvoření vzestupně.
-created_at: Třídit podle času vytvoření sestupně.
Prototyp úkolu Figurka z cihel je pracovní jednotkou, kterou Meshy sleduje pro
vytvoření konceptuálního obrazu ve stylu cihly ze zdrojové fotografie. Výstup
této fáze je propojen s fází sestavení
pomocí input_task_id.
Vlastnosti
Name
id
Type
string
Description
Jedinečný identifikátor pro úkol. I když používáme k-seřaditelné UUID pro ids úkolů jako detail implementace, neměli byste dělat žádné předpoklady o formátu id.
Name
type
Type
string
Description
Typ úkolu. Hodnota je creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Název úkolu dodaný při vytvoření úkolu. Prázdný řetězec, pokud nebyl zadán žá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
Průběh úkolu. Pokud úkol ještě nezačal, tato vlastnost bude 0. Jakmile úkol dosáhne úspěchu, stane se to 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 PM 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 null.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy byl úkol dokončen, v milisekundách. Pokud úkol není dokončen, tato vlastnost bude null.
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. 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, pokud je stav úkolu PENDING, IN_PROGRESS nebo SUCCEEDED. Vrací 0 pro úkoly FAILED (kredity jsou při neúspěchu vráceny).
Name
image_urls
Type
array of strings
Description
Stažitelné URL pro kandidátské koncepty obrázků vytvořené tímto prototypovým úkolem. V současné době 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 úkolu Stavba Figurky z Cihly je pracovní jednotka, kterou Meshy sleduje,
aby vygeneroval texturovanou 3D cihlovou figurku z úspěšného prototypového
úkolu. Používá stejný pipeline Obrázek na 3D jako
Obrázek na 3D, takže výstupní pole zrcadlí
task object tohoto koncového bodu.
Vlastnosti
Name
id
Type
string
Description
Unikátní identifikátor úkolu.
Name
type
Type
string
Description
Typ úkolu. Hodnota je creative-lab-brick-figure-build.
Name
name
Type
string
Description
Název úkolu zadaný při vytvoření úkolu. Prázdný řetězec, pokud nebyl uveden žá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ě nebyl zahájen, tato vlastnost bude 0. Jakmile je úkol úspěšný, tato hodnota bude 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í výsledku úkolu, v milisekundách.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úkolů. Významné, pouze když stav je PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybě u neúspěšných úkolů. Viz Errors pro úplnou referenci objektu task_error.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných tímto úkolem. Vrátí 0 pro úkoly FAILED (kredity jsou vráceny při selhání).
Name
prompt
Type
string
Description
Vždy prázdné pro stavbu figurky z cihel. Přítomné pro kompatibilitu s koncovými body se sdílenou strukturou V2ImageTo3DTaskResponse používanou ve Obrázek na 3D.
Name
negative_prompt
Type
string
Description
Vždy prázdné pro stavbu figurky z cihel. Přítomné pro kompatibilitu s koncovými body.
Name
texture_prompt
Type
string
Description
Vždy prázdné pro stavbu figurky z cihel. Přítomné pro kompatibilitu s koncovými body.
Name
texture_image_url
Type
string
Description
Vždy prázdné pro stavbu figurky z cihel. Přítomné pro kompatibilitu s koncovými body.
Name
model_urls
Type
object
Description
URL adresy ke stažení pro vygenerovaný 3D model. Stavba figurky z cihel vydává strukturovaný GLB a dvojici OBJ + MTL pro kanály, které preferují Wavefront OBJ. Tvar pole odpovídá objektu Image to 3D model_urls, aby bylo možné budoucí formátové doplňky začlenit bez narušení kompatibility.
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í souboru MTL materiálu, který doprovází OBJ. Spárujte s obj a položkou z texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL adresa ke stažení miniatury obrázku souboru modelu.
Name
texture_urls
Type
array
Description
Pole objektů URL textur generovaných tímto úkolem. Aktuálně obsahuje jediný objekt s mapou základní barvy.
Name
base_color
Type
string
Description
URL adresa ke stažení obrázku mapy základní barvy.