Verander een bronfoto in een verzamelbare 3D minifiguur in baksteenstijl in twee fasen:
prototype genereert een gestileerd conceptbeeld van uw invoerfoto, daarna
build verandert dat conceptbeeld in een ge3D-model met texture. De twee fasen
zijn verbonden via input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Genereer een enkel conceptbeeld in baksteenstijl vanuit de bronfoto. De
geretourneerde taak-ID is wat je opgeeft als input_task_id aan de build
endpoint. Raadpleeg
Het Brick Figuur Prototype Taak Object
voor de responsvorm.
Parameters
Name
image_url
Type
string
Verplicht
Description
Bronfoto voor Meshy om te stijlen als een baksteen minifiguur. We ondersteunen momenteel .jpg, .jpeg, .png, en .webp formaten.
Er zijn twee manieren om de afbeelding te verstrekken:
Publiek toegankelijke URL: Een URL die toegankelijk is vanaf het openbare internet.
Data URI: Een base64-gecodeerde data URI van de afbeelding. Voorbeeld van een data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Optionele taaknaam voor weergavedoeleinden. Maximum 100 tekens.
Retourneert
De result eigenschap van de respons bevat de taak id van de nieuw gecreëerde brick figuur prototype taak. Poll de Get a Task endpoint of abonneer je op de stream totdat de taak SUCCEEDED bereikt, en geef die ID dan door aan de build endpoint als input_task_id.
Foutmodi
Name
400 - Bad Request
Description
Het verzoek was onacceptabel. Veelvoorkomende oorzaken:
Ontbrekende parameter: image_url is vereist.
Ongeldig afbeeldingsformaat: De verstrekte image_url is geen ondersteund formaat (.jpg, .jpeg, .png, .webp).
Afbeeldingsdimensies buiten bereik: De afbeelding is te klein, overschrijdt de maximale bestandsgrootte of overschrijdt het maximale aantal pixels.
Onbereikbare URL: De image_url kon niet worden gedownload (404 of timeout).
Ongeldige Data URI: De base64-string is ongeldig.
Inhoud gemarkeerd: De ingevoerde afbeelding was gemarkeerd door NSFW of intellectuele eigendoms moderation.
Name
401 - Unauthorized
Description
Authenticatie mislukt. Controleer alsjeblieft je API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
403 - Forbidden
Description
De invoerafbeelding is gemarkeerd wegens schending van intellectueel eigendom.
Name
429 - Too Many Requests
Description
Je hebt je rate limit overschreden.
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Fase 1: genereer een conceptbeeld in baksteenstijlcurl 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": "<your publicly accessible image url or base64-encoded data URI>" }'
Genereer de uiteindelijke getextureerde 3D-brickfiguur vanuit een geslaagde prototype
taak. De bouwtaak voert dezelfde afbeelding-naar-3D-pijplijn uit als
Afbeelding naar 3D, zodat het formaat van het responsobject en de
lijst van output-URLs exact overeenkomen. Raadpleeg
Het Brick Figuur Bouwtaak Object voor de
vorm van het antwoord.
Parameters
Name
input_task_id
Type
string
Verplicht
Description
De taak-ID van een prototype taak gecreëerd via dezezelfde OpenAPI endpoint. Het prototype moet zijn gecreëerd met dezelfde API-sleutel, moet SUCCEEDED hebben bereikt, en moet precies één kandidaat-afbeelding hebben geproduceerd.
Prototype taken gemaakt via de webapp worden niet geaccepteerd — de bouw endpoint accepteert alleen prototype taken gemaakt door POST /openapi/creative-lab/brick-figure/v1/prototype en weigert elke andere bron met 404.
Name
name
Type
string
Description
Optionele taaknaam voor weergavedoeleinden. Maximaal 100 karakters.
Retourneert
De result eigenschap van de respons bevat de taak id van de nieuw gecreëerde brickfiguur bouwtaak. Poll de Haal een Taak op endpoint of abonneer je op de stream totdat de taak SUCCEEDED bereikt, download daarna de getextureerde GLB van model_urls.glb (of het OBJ + MTL paar van model_urls.obj en model_urls.mtl als je downstream pijplijn de voorkeur geeft aan OBJ).
Foutmodi
Name
400 - Bad Request
Description
Het verzoek was onacceptabel. Veelvoorkomende oorzaken:
Missende parameter: input_task_id is vereist.
Ongeldige UUID: De input_task_id is geen geldige UUID.
Ouder niet geslaagd: De genoemde prototype taak heeft nog geen SUCCEEDED bereikt.
Geen kandidaat: De prototype taak is geslaagd maar heeft geen kandidaat-afbeelding geproduceerd.
Name
401 - Unauthorized
Description
Authenticatie mislukt. Controleer uw API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
404 - Not Found
Description
De genoemde prototype taak bestaat niet, behoort tot een andere gebruiker, of werd gecreëerd via de webapp (alleen API-mode prototype taken worden doorgezet naar bouw).
Name
429 - Too Many Requests
Description
U heeft uw rate limit overschreden.
Verzoek
POST
/openapi/creative-lab/brick-figure/v1/build
# Fase 2: bouwketting van een geslaagde prototype taakcurl 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" }'
Haal een prototype of bouwtaak op met een geldige taak id. Het pad van de URL
moet overeenkomen met de fase van de taak — een bouwtaak opgehaald via
/prototype/:id geeft 404 terug, en vice versa.
Annuleer een brick figuur taak. Als de taak nog PENDING is, worden de credits die bij het aanmaken zijn verbruikt teruggestort. Taken die al IN_PROGRESS zijn worden geannuleerd zonder terugbetaling (de werker kan al bronnen aan het verbranden zijn). Taken die al een eindstatus hebben bereikt (SUCCEEDED, FAILED, CANCELED) kunnen niet geannuleerd worden.
Het URL-pad moet overeenkomen met de fase van de taak — DELETE op /prototype/:buildId geeft 404 terug.
Padparameters
Name
id
Type
path
Description
Unieke identificatie voor de brick figuur taak om te annuleren.
Retourneert
Retourneert 204 No Content bij succes met een lege inhoud.
Foutmodi
Name
400 - Bad Request
Description
De taak is al in een eindstatus en kan niet geannuleerd worden.
Name
404 - Not Found
Description
De taak bestaat niet, behoort tot een andere gebruiker, of de fase komt niet overeen met het URL-pad.
Stream real-time updates voor een brick figuur taak via Server-Sent Events (SSE).
Het URL-pad moet overeenkomen met de fase van de taak — het openen van een stream op
/prototype/:buildId/stream zendt een enkele event: error payload uit met
status_code: 404 en sluit de stream.
Parameters
Name
id
Type
path
Description
Unieke identifier voor de brick figuur taak om te streamen.
Geeft terug
Geeft een stream terug van Brick Figuur Prototype
of Brick Figuur Build taakobjecten als
Server-Sent Events. Voor PENDING of IN_PROGRESS taken zal de responsestream
alleen de noodzakelijke progress en status velden omvatten.
// Error event voorbeeld (verkeerde fase of taak niet gevonden)event: errordata: {"status_code": 404,"message": "Task not found"}// Bericht evenement voorbeelden illustreren de voortgang van de taak.// Voor PENDING of IN_PROGRESS taken bevat de responsestream niet alle velden.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=***" } ]}
Haal een gepagineerde lijst van je brick figure-taken voor een enkele fase op. Het URL-pad
selecteert de fase — /prototype retourneert prototypetaken; /build
retourneert bouwtaken. Taken van de andere fase zijn niet opgenomen in beide
antwoorden.
Padparameters
Name
stage
Type
path
Verplicht
Description
Ofwel prototype of build. De collectie retourneert alleen taken
waarvan de fase overeenkomt met de URL — ophalen van /prototype retourneert nooit
bouwtaken en vice versa.
Queryparameters
Name
page_num
Type
integer
standaard 1
Description
Paginanummer voor paginering.
Name
page_size
Type
integer
standaard 10
Description
Beperking van paginagrootte. Maximum toegestaan is 100 items.
Name
sort_by
Type
string
standaard -created_at
Description
Veld om op te sorteren. Beschikbare waarden:
+created_at: Sorteren op creatietijd in oplopende volgorde.
-created_at: Sorteren op creatietijd in aflopende volgorde.
Het Brick Figuur Prototype Taak object is een werkunit die Meshy bijhoudt om
een baksteenstijl conceptafbeelding te genereren vanuit een bronfoto. De uitvoer van
deze fase wordt gekoppeld aan de bouwfase
via input_task_id.
Eigenschappen
Name
id
Type
string
Description
Unieke identifier voor de taak. Hoewel we een k-sortable UUID gebruiken voor taak-ID's als implementatiedetail, moet je geen aannames doen over de indeling van de id.
Name
type
Type
string
Description
Type van de taak. De waarde is creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
De taaknaam geleverd toen de taak werd aangemaakt. Lege string als er geen naam is opgegeven.
Name
status
Type
string
Description
Status van de taak. Mogelijke waarden zijn: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Voortgang van de taak. Als de taak nog niet begonnen is, zal deze eigenschap 0 zijn. Zodra de taak is geslaagd, wordt dit 100.
Name
created_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is aangemaakt, in milliseconden.
Een tijdstempel vertegenwoordigt het aantal milliseconden dat verstreken is sinds 1 januari 1970 UTC, volgens
de RFC 3339 standaard.
Bijvoorbeeld, vrijdag 1 september 2023 12:00:00 PM GMT wordt weergegeven als 1693569600000. Dit geldt
voor alle tijdstempels in Meshy API.
Name
started_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is gestart, in milliseconden. Als de taak nog niet is gestart, zal deze eigenschap null zijn.
Name
finished_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is voltooid, in milliseconden. Als de taak nog niet is voltooid, zal deze eigenschap null zijn.
Name
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande taken.
De waarde van dit veld is alleen zinvol als de taakstatus PENDING is.
Name
task_error
Type
object
Description
Foutdetails voor mislukte taken. Zie Fouten voor de volledige task_error objectreferentie.
Name
consumed_credits
Type
integer
Description
Het aantal credits verbruikt door deze taak. Aanwezig wanneer de taakstatus PENDING, IN_PROGRESS, of SUCCEEDED is. Geeft 0 terug voor FAILED taken (credits worden terugbetaald bij falen).
Name
image_urls
Type
array of strings
Description
Downloadbare URL's voor de conceptbeeldkandidaten gegenereerd door deze prototype-taak. Momenteel retourneert de API altijd precies één kandidaat; het veld is een array zodat toekomstige revisies meerdere kandidaten kunnen weergeven zonder een brekende verandering.
Het Baksteen Figuur Bouw Taak object is een werkunit die Meshy bijhoudt om een getextureerde 3D baksteen figuur te genereren van een geslaagde prototype taak. Het gebruikt dezelfde afbeelding-naar-3D pijplijn die wordt gebruikt door Afbeelding naar 3D, dus de uitvoervelden spiegelen de taak object van die endpoint.
Eigenschappen
Name
id
Type
string
Description
Unieke identificator voor de taak.
Name
type
Type
string
Description
Type van de taak. De waarde is creative-lab-brick-figure-build.
Name
name
Type
string
Description
De taaknaam die is opgegeven toen de taak werd aangemaakt. Lege string als er geen naam is opgegeven.
Name
status
Type
string
Description
Status van de taak. Mogelijke waarden zijn een van PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Voortgang van de taak. Als de taak nog niet is gestart, zal deze eigenschap 0 zijn. Zodra de taak is geslaagd, zal dit 100 worden.
Name
created_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is aangemaakt, in milliseconden.
Name
started_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is gestart, in milliseconden.
Name
finished_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is voltooid, in milliseconden.
Name
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande taken. Zinvol alleen wanneer de status PENDING is.
Name
task_error
Type
object
Description
Foutdetails voor mislukte taken. Zie Fouten voor de volledige task_error objectreferentie.
Name
consumed_credits
Type
integer
Description
Het aantal credits dat door deze taak is verbruikt. Geeft 0 terug voor FAILED taken (credits worden bij een mislukking terugbetaald).
Name
prompt
Type
string
Description
Altijd leeg voor brick figure build. Aanwezig voor cross-endpoint compatibiliteit met de gedeelde V2ImageTo3DTaskResponse vorm gebruikt door Afbeelding naar 3D.
Name
negative_prompt
Type
string
Description
Altijd leeg voor brick figure build. Aanwezig voor cross-endpoint compatibiliteit.
Name
texture_prompt
Type
string
Description
Altijd leeg voor brick figure build. Aanwezig voor cross-endpoint compatibiliteit.
Name
texture_image_url
Type
string
Description
Altijd leeg voor brick figure build. Aanwezig voor cross-endpoint compatibiliteit.
Name
model_urls
Type
object
Description
Downloadbare URL's voor het gegenereerde 3D-model. De brick figure build levert een getextureerde GLB plus het OBJ + MTL paar voor pipelines die Wavefront OBJ prefereren. De veldvorm komt overeen met de Afbeelding naar 3D model_urls object zodat toekomstige formaat toevoegingen zonder brekende verandering ingevoegd kunnen worden.
Name
glb
Type
string
Description
Downloadbare URL naar het getextureerde GLB-bestand.
Name
obj
Type
string
Description
Downloadbare URL naar het Wavefront OBJ-bestand (geometrie + UV).
Name
mtl
Type
string
Description
Downloadbare URL naar het OBJ begeleidende MTL materiaalbestand. Combineren met obj en de vermelding uit texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Downloadbare URL naar de thumbnail-afbeelding van het modelbestand.
Name
texture_urls
Type
array
Description
Een array van textuur URL-objecten gegenereerd door deze taak. Bevat momenteel een enkel object met de basiskleur map.
Name
base_color
Type
string
Description
Downloadbare URL naar de basiskleur map afbeelding.