Förvandla ett källfoto till en samlarobjekt 3D-miniatur i två steg:
prototype genererar en stiliserad konceptbild från ditt inskickade foto, sedan
build förvandlas konceptbilden till en texturerad 3D-modell. De två stegen är
kopplade via input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Generera en enda konceptbild i Lego-stil från källfotot. Det returnerade uppgifts-ID:t är det du skickar som input_task_id till byggendpointen. Se The Brick Figure Prototype Task Object för svarets form.
Parametrar
Name
image_url
Type
string
Obligatorisk
Description
Källfoto för Meshy att stilisera som en Legofigur. Vi stödjer för närvarande .jpg, .jpeg, .png och .webp format.
Det finns två sätt att tillhandahålla bilden:
Publikt tillgänglig URL: En URL som är tillgänglig från det publika internet.
Data URI: En base64-kodad data URI av bilden. Exempel på en data URI: data:image/jpeg;base64,<dina base64-kodade bilddata>.
Name
name
Type
string
Description
Valfritt uppgiftsnamn för visningsändamål. Max 100 tecken.
Returnerar
result-egenskapen i svaret innehåller uppgiftsid för den nyligen skapade prototypuppgiften för Legofiguren. Hämta Get a Task endpointen eller prenumerera på streamen tills uppgiften når SUCCEEDED, och skicka sedan det ID:t till byggendpointen som input_task_id.
Feltyper
Name
400 - Bad Request
Description
Begäran var oacceptabel. Vanliga orsaker:
Saknad parameter: image_url krävs.
Ogiltigt bildformat: Den angivna image_url är inte ett stödformat (.jpg, .jpeg, .png, .webp).
Bilddimensioner utanför gränserna: Bilden är för liten, överskrider maximum filstorlek eller maksimum pixelantal.
Onåbar URL: Den image_url kunde inte laddas ner (404 eller timeout).
Ogiltig Data URI: Base64-strängen är felaktig.
Innehåll flaggat: Ingångsbilden var flaggad av NSFW eller immateriell moderator.
Name
401 - Unauthorized
Description
Autentisering misslyckades. Kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckliga credits för att utföra denna uppgift.
Name
403 - Forbidden
Description
Indatabilden flaggades för immaterialrättsintrång.
Name
429 - Too Many Requests
Description
Du har överskridit din hastighetsgräns.
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Steg 1: generera en konceptbild i Lego-stilcurl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<din publikt tillgängliga bild-url eller base64-kodade data URI>" }'
Generera den slutliga texturerade 3D-tegelfiguren från en lyckad prototypuppgift. Bygget kör samma bild-till-3D-pipeline som
Bild till 3D, så svarobjektformatet och listan med utdata-URL:er matchar exakt. Hänvisa till
Tegelfigurens bygguppgiftsobjekt för svarformatet.
Parametrar
Name
input_task_id
Type
string
Obligatorisk
Description
Uppgifts-ID för en prototypuppgift skapad via denna samma OpenAPI-endpoint. Prototypen måste ha skapats med samma API-nyckel, måste ha uppnått SUCCEEDED, och måste ha producerat exakt en kandidatbild.
Prototypuppgifter skapade genom webappen accepteras inte — bygg-endpoint accepterar endast prototypuppgifter producerade av POST /openapi/creative-lab/brick-figure/v1/prototype och avvisar andra källor med 404.
Name
name
Type
string
Description
Valfritt uppgiftsnamn för visningsändamål. Max 100 tecken.
Returnerar
result-egenskapen i svaret innehåller uppgifts-id för den nyligen skapade bygguppgiften för tegelfiguren. Använd Hämta en uppgift-endpointen eller prenumerera på strömmen tills uppgiften når SUCCEEDED, och ladda sedan ner den texturerade GLB från model_urls.glb (eller OBJ + MTL-paret från model_urls.obj och model_urls.mtl om din nedströms pipeline föredrar OBJ).
Felmod
Name
400 - Bad Request
Description
Förfrågan var oacceptabel. Vanliga orsaker:
Saknad parameter: input_task_id krävs.
Ogiltig UUID: input_task_id är inte en giltig UUID.
Förälder inte lyckad: Den refererade prototypuppgiften har ännu inte nått SUCCEEDED.
Ingen kandidat: Prototypuppgiften lyckades men producerade ingen kandidatbild.
Name
401 - Unauthorized
Description
Autentiseringen misslyckades. Vänligen kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckliga credits för att utföra denna uppgift.
Name
404 - Not Found
Description
Den refererade prototypuppgiften existerar inte, tillhör en annan användare, eller skapades genom webappen (endast API-läge prototypuppgifter kedjas till bygg).
Name
429 - Too Many Requests
Description
Du har överskridit din hastighetsgräns.
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Steg 2: kedja bygg från en lyckad prototypuppgiftcurl 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" }'
Hämta en prototyps- eller bygguppgift med ett giltigt uppgifts-id. URL-sökvägen
måste matcha uppgiftens steg — en bygguppgift hämtad via
/prototype/:id returnerar 404, och vice versa.
Avbryt en brick figure-uppgift. Om uppgiften fortfarande är PENDING återbetalas de credits
som förbrukades vid skapandet. Uppgifter som redan är
IN_PROGRESS avbryts utan återbetalning (arbetaren kan redan hålla på att bränna resurser). Uppgifter som redan har nått ett slutligt tillstånd
(SUCCEEDED, FAILED, CANCELED) kan inte avbrytas.
URL-sökvägen måste matcha uppgiftens stadium — DELETE på
/prototype/:buildId returnerar 404.
Sökvägsparametrar
Name
id
Type
path
Description
Unikt identifierare för brick figure-uppgiften som ska avbrytas.
Returnerar
Returnerar 204 No Content vid framgång med ett tomt svar.
Felmodeller
Name
400 - Bad Request
Description
Uppgiften är redan i ett slutligt tillstånd och kan inte avbrytas.
Name
404 - Not Found
Description
Uppgiften existerar inte, tillhör en annan användare, eller dess stadium matchar inte URL-sökvägen.
Strömma uppdateringar i realtid för en legofiguruppgift via Server-Sent Events (SSE).
URL-sökvägen måste matcha uppgiftens stadie — att öppna en ström vid
/prototype/:buildId/stream emittrar en enda event: error payload med
status_code: 404 och stänger strömmen.
Parametrar
Name
id
Type
path
Description
Unik identifierare för legofiguruppgiften att strömma.
Returnerar
Returnerar en ström av Legofigur Prototyp
eller Legofigur Bygg uppgiftsobjekt som
Server-Sent Events. För PENDING eller IN_PROGRESS uppgifter kommer svarströmmen
endast att inkludera de nödvändiga progress och status fälten.
Hämta en paginerad lista över dina brickfigursuppgifter för ett enda steg. URL-sökvägen
väljer steget — /prototype returnerar prototypsuppgifter; /build
returnerar bygguppgifter. Uppgifter från det andra steget ingår inte i någon
av svaren.
Sökvägsparametrar
Name
stage
Type
path
Obligatorisk
Description
Antingen prototype eller build. Samlingen returnerar endast uppgifter
vars steg matchar URL-sökvägen — att hämta /prototype returnerar aldrig
bygguppgifter och vice versa.
Frågeparametrar
Name
page_num
Type
integer
standard 1
Description
Sidnummer för paginering.
Name
page_size
Type
integer
standard 10
Description
Begränsning för sidstorlek. Maximalt tillåtet är 100 objekt.
Name
sort_by
Type
string
standard -created_at
Description
Fält att sortera efter. Tillgängliga värden:
+created_at: Sortera efter skapandetid i stigande ordning.
-created_at: Sortera efter skapandetid i fallande ordning.
Prototyp-objektet för tegelfiguren är en arbetsenhet som Meshy håller reda på för att generera en tegelstilad konceptbild från ett källfoto. Resultatet av detta steg kedjas till byggsteget via input_task_id.
Egenskaper
Name
id
Type
string
Description
Unikt identifierare för uppgiften. Även om vi använder ett k-sorterbart UUID för uppgifts-id som en implementeringsdetalj, bör du inte göra några antaganden om formatet av id.
Name
type
Type
string
Description
Typ av uppgift. Värdet är creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Uppgiftsnamnet som angavs när uppgiften skapades. Tom sträng om inget namn angavs.
Name
status
Type
string
Description
Status för uppgiften. Möjliga värden är en av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Uppgiftens framsteg. Om uppgiften inte har påbörjats än, kommer denna egenskap att vara 0. När uppgiften har lyckats kommer detta bli 100.
Name
created_at
Type
timestamp
Description
Tidsstämpeln för när uppgiften skapades, i millisekunder.
En tidsstämpel representerar antalet millisekunder som har förflutit sedan den 1 januari 1970 UTC, enligt
RFC 3339-standarden.
Till exempel, fredag den 1 september 2023 kl. 12:00:00 GMT representeras som 1693569600000. Detta gäller
för alla tidsstämplar i Meshy API.
Name
started_at
Type
timestamp
Description
Tidsstämpeln för när uppgiften startades, i millisekunder. Om uppgiften inte har startats än, kommer denna egenskap att vara null.
Name
finished_at
Type
timestamp
Description
Tidsstämpeln för när uppgiften avslutades, i millisekunder. Om uppgiften inte har avslutats än, kommer denna egenskap att vara null.
Name
expires_at
Type
timestamp
Description
Tidsstämpeln för när uppgiftens resultat går ut, i millisekunder.
Name
preceding_tasks
Type
integer
Description
Antalet tidigare uppgifter.
Värdet för detta fält är meningsfullt endast om uppgiftens status är PENDING.
Name
task_error
Type
object
Description
Felinformation för misslyckade uppgifter. Se Fel för den fulla referens för task_error-objektet.
Name
consumed_credits
Type
integer
Description
Antalet credits förbrukade av denna uppgift. Närvarande när uppgiftens status är PENDING, IN_PROGRESS, eller SUCCEEDED. Återgår 0 för FAILED-uppgifter (credits återbetalas vid misslyckande).
Name
image_urls
Type
array of strings
Description
Nedladdningsbara URL:er för konceptbildskandidaterna som genereras av denna prototypuppgift. För närvarande returnerar API alltid exakt en kandidat; fältet är en array så att framtida revideringar kan hantera flera kandidater utan att bryta kompatibilitet.
Objektet för bygguppgiften Brick Figur är en arbetsenhet som Meshy följer för att generera en texturerad 3D-brickfigur från en lyckad prototypuppgift. Den använder samma bild-till-3D-pipeline som används av Bild till 3D, så utmatningsfälten speglar den endpointens uppgiftsobjekt.
Egenskaper
Name
id
Type
string
Description
Unikt identifierare för uppgiften.
Name
type
Type
string
Description
Typ av uppgift. Värdet är creative-lab-brick-figure-build.
Name
name
Type
string
Description
Uppgiftsnamn som angavs när uppgiften skapades. Tom sträng om inget namn angavs.
Name
status
Type
string
Description
Status för uppgiften. Möjliga värden är en av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Framsteg för uppgiften. Om uppgiften inte har startat än kommer denna egenskap att vara 0. När uppgiften har lyckats kommer denna att bli 100.
Name
created_at
Type
timestamp
Description
Tidsstämpel för när uppgiften skapades, i millisekunder.
Name
started_at
Type
timestamp
Description
Tidsstämpel för när uppgiften startades, i millisekunder.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när uppgiften avslutades, i millisekunder.
Name
expires_at
Type
timestamp
Description
Tidsstämpel för när uppgiftsresultatet går ut, i millisekunder.
Name
preceding_tasks
Type
integer
Description
Antal föregående uppgifter. Meningsfullt endast när status är PENDING.
Name
task_error
Type
object
Description
Felinformation för misslyckade uppgifter. Se Fel för full task_error objektreferens.
Name
consumed_credits
Type
integer
Description
Antalet poäng som används av denna uppgift. Returnerar 0 för FAILED uppgifter (poäng återbetalas vid misslyckande).
Name
prompt
Type
string
Description
Alltid tom för tegel figur byggen. Finns för kompatibilitet mellan endpoints med den delade V2ImageTo3DTaskResponse formen använd av Bild till 3D.
Name
negative_prompt
Type
string
Description
Alltid tom för tegel figur byggen. Finns för kompatibilitet mellan endpoints.
Name
texture_prompt
Type
string
Description
Alltid tom för tegel figur byggen. Finns för kompatibilitet mellan endpoints.
Name
texture_image_url
Type
string
Description
Alltid tom för tegel figur byggen. Finns för kompatibilitet mellan endpoints.
Name
model_urls
Type
object
Description
Nedladdningsbara URL:er för den genererade 3D-modellen. Tegel figur bygget avger en texturerad GLB plus OBJ + MTL-paret för pipelines som föredrar Wavefront OBJ. Fältformen matchar Bild till 3D model_urls objektet så att framtida formatläggningar kan ske utan att bryta förändringar.
Name
glb
Type
string
Description
Nedladdningsbar URL till den texturerade GLB-filen.
Name
obj
Type
string
Description
Nedladdningsbar URL till Wavefront OBJ-filen (geometri + UV).
Name
mtl
Type
string
Description
Nedladdningsbar URL till OBJ-kompanjonen MTL-materialfilen. Kombinera med obj och posten från texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Nedladdningsbar URL till miniatyrbilden av modelfilen.
Name
texture_urls
Type
array
Description
En lista med URL-objekt för texturer genererade av denna uppgift. Innehåller för närvarande ett enda objekt med basfärgkartan.