Zet een bronfoto om in een vinyl verzamelfiguur met een groot hoofd in twee
fasen: prototype genereert een gestileerde conceptafbeelding op basis van uw
invoerfoto, en build zet die conceptafbeelding vervolgens om in een getextureerd
3D-model. De twee fasen zijn met elkaar verbonden via input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Genereer een enkele afbeelding in vinyl-figuurstijl op basis van de bronfoto. De geretourneerde taak-ID is wat je meegeeft als input_task_id aan de build-endpoint. Raadpleeg
Het Vinyl Figure Prototype Task Object
voor de vorm van de response.
Parameters
Name
image_url
Type
string
Verplicht
Description
Bronfoto die Meshy stileert als een big-head vinyl figuur. We ondersteunen momenteel de formaten .jpg, .jpeg, .png en .webp.
Er zijn twee manieren om de afbeelding aan te leveren:
Publiek toegankelijke URL: Een URL die toegankelijk is vanaf het publieke 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. Maximaal 100 tekens.
Name
remove_background
Type
boolean
standaard false
Description
Wanneer ingesteld op true, wordt de prototype-afbeelding geretourneerd als een transparante RGBA PNG met de achtergrond verwijderd, zodat je het onderwerp op elke achtergrond kunt samenstellen.
Retourwaarden
De result-eigenschap van de response bevat de taak-id van de nieuw aangemaakte vinyl figure prototype-taak. Poll de Get a Task-endpoint of neem een abonnement op de stream totdat de taak SUCCEEDED bereikt, en geef die ID vervolgens door aan de build-endpoint als input_task_id.
Faalmodi
Name
400 - Bad Request
Description
Het verzoek was onaanvaardbaar. Veelvoorkomende oorzaken:
Ontbrekende parameter: image_url is verplicht.
Ongeldig afbeeldingsformaat: De opgegeven image_url heeft geen ondersteund formaat (.jpg, .jpeg, .png, .webp).
Afbeeldingsafmetingen 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 onjuist gevormd.
Content gemarkeerd: De invoerafbeelding is gemarkeerd door NSFW- of intellectuele-eigendom-moderation.
Name
401 - Unauthorized
Description
Authenticatie mislukt. Controleer je API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
429 - Too Many Requests
Description
Je hebt je rate limit overschreden.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Stage 1: generate a vinyl-figure-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Response
{"result":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototype-voorbeeld
Begin met een bronfoto en genereer vervolgens de prototype-afbeelding die door de build-fase wordt gebruikt.
Genereer het uiteindelijke getextureerde 3D vinyl figure vanaf een geslaagde prototype-taak. De build doorloopt dezelfde image-to-3D pipeline als
Afbeelding naar 3D, dus het formaat van het response-object en de
lijst van output-URL's komen exact overeen. Raadpleeg
Het Vinyl Figure Build Task Object
voor de vorm van de respons.
Parameters
Name
input_task_id
Type
string
Verplicht
Description
De taak-ID van een prototype-taak die via dit zelfde OpenAPI-endpoint is aangemaakt. Het prototype moet zijn aangemaakt met dezelfde API-sleutel, moet SUCCEEDED hebben bereikt en moet precies één kandidaatafbeelding hebben opgeleverd.
Prototype-taken die via de webapp zijn aangemaakt worden niet geaccepteerd — de build-endpoint accepteert alleen prototype-taken die zijn geproduceerd door POST /openapi/creative-lab/vinyl-figure/v1/prototype en wijst elke andere bron af met 404.
Name
name
Type
string
Description
Optionele taaknaam voor weergavedoeleinden. Maximaal 100 tekens.
Retourwaarden
De result-property van de respons bevat de taak-id van de nieuw aangemaakte vinyl figure build-taak. Poll de Get a Task-endpoint of abonneer je op de stream totdat de taak SUCCEEDED bereikt, en download vervolgens de getextureerde GLB via model_urls.glb (of het OBJ + MTL-paar via model_urls.obj en model_urls.mtl als jouw downstream-pipeline OBJ verkiest).
Faalmodi
Name
400 - Bad Request
Description
Het verzoek was onacceptabel. Veelvoorkomende oorzaken:
Ontbrekende parameter: input_task_id is verplicht.
Ongeldige UUID: De input_task_id is geen geldige UUID.
Bovenliggende taak niet geslaagd: De verwezen prototype-taak heeft SUCCEEDED nog niet bereikt.
Geen kandidaat: De prototype-taak is geslaagd, maar heeft geen kandidaatafbeelding opgeleverd.
Name
401 - Unauthorized
Description
Authenticatie is mislukt. Controleer je API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
404 - Not Found
Description
De verwezen prototype-taak bestaat niet, behoort tot een andere gebruiker, of is aangemaakt via de webapp (alleen prototype-taken in API-mode kunnen doorgeschakeld worden naar build).
Name
429 - Too Many Requests
Description
Je hebt je rate limit overschreden.
Request
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" }'
Haal een prototype- of buildtaak op aan de hand van een geldige taak-id. Het URL-pad
moet overeenkomen met de fase van de taak — een buildtaak die wordt opgehaald via
/prototype/:id geeft 404 terug, en omgekeerd.
Annuleer een vinyl figure-taak. Als de taak nog PENDING is, worden de
credits die bij het aanmaken zijn verbruikt terugbetaald. Taken die al
IN_PROGRESS zijn, worden geannuleerd zonder terugbetaling (de worker
verbruikt mogelijk al bronnen). Taken die al een eindtoestand hebben
bereikt (SUCCEEDED, FAILED, CANCELED) kunnen niet worden geannuleerd.
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 vinyl figure-taak die geannuleerd moet worden.
Retourneert
Geeft 204 No Content terug bij succes met een lege inhoud.
Foutmodi
Name
400 - Bad Request
Description
De taak bevindt zich al in een eindtoestand en kan niet worden geannuleerd.
Name
404 - Not Found
Description
De taak bestaat niet, behoort toe aan een andere gebruiker, of de fase komt niet overeen met het URL-pad.
Stream realtime updates voor een vinyl figure task via Server-Sent Events
(SSE). Het URL-pad moet overeenkomen met de fase van de task — het openen
van een stream op /prototype/:buildId/stream levert een enkele
event: error-payload met status_code: 404 op en sluit de stream.
Parameters
Name
id
Type
path
Description
Unieke identifier voor de vinyl figure task om te streamen.
Retourneert
Retourneert een stream van Vinyl Figure Prototype
of Vinyl Figure Build task-objecten
als Server-Sent Events. Elk frame bevat het volledige task-object voor de fase — dezelfde vorm die
de Get-endpoint retourneert — dus terwijl de task PENDING of IN_PROGRESS is, zijn de
outputvelden simpelweg nog niet ingevuld (null, [] of {}) en is
finished_at gelijk aan null.
Haal een gepagineerde lijst op van je vinyl figure-taken voor één fase.
Het URL-pad selecteert de fase — /prototype geeft prototype-taken terug;
/build geeft build-taken terug. Taken uit de andere fase worden niet
opgenomen in een van beide responses.
Padparameters
Name
stage
Type
path
Verplicht
Description
Ofwel prototype ofwel build. De verzameling geeft alleen taken terug
waarvan de fase overeenkomt met de URL — het opvragen van /prototype
geeft nooit build-taken terug en vice versa.
Queryparameters
Name
page_num
Type
integer
standaard 1
Description
Paginanummer voor paginering.
Name
page_size
Type
integer
standaard 10
Description
Paginagroottelimiet. Maximaal toegestaan zijn 100 items.
Name
sort_by
Type
string
standaard -created_at
Description
Veld om op te sorteren. Beschikbare waarden:
+created_at: Sorteer op aanmaaktijd in oplopende volgorde.
-created_at: Sorteer op aanmaaktijd in aflopende volgorde.
Het Vinyl Figure Prototype Task-object is een werkeenheid die Meshy bijhoudt
om een conceptafbeelding in vinyl-figuurstijl te genereren op basis van een bronfoto.
De uitvoer van deze fase wordt via input_task_id gekoppeld aan
de build-fase.
Eigenschappen
Name
id
Type
string
Description
Unieke identifier voor de task. Hoewel we als implementatiedetail een k-sorteerbare UUID gebruiken voor task-id's, mag je geen aannames doen over de indeling van de id.
Name
type
Type
string
Description
Type van de task. De waarde is creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
De taaknaam die werd opgegeven bij het aanmaken van de task. Lege string als er geen naam is opgegeven.
Name
status
Type
string
Description
Status van de task. Mogelijke waarden zijn een van PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress van de task. Als de task nog niet is gestart, is deze eigenschap 0. Zodra de task is geslaagd, wordt dit 100.
Name
created_at
Type
timestamp
Description
Tijdstempel van wanneer de task is aangemaakt, in milliseconden.
Een tijdstempel geeft het aantal milliseconden weer dat is verstreken sinds 1 januari 1970 UTC, volgens
de RFC 3339-standaard.
Vrijdag 1 september 2023 12:00:00 PM GMT wordt bijvoorbeeld weergegeven als 1693569600000. Dit geldt
voor alle tijdstempels in de Meshy API.
Name
started_at
Type
timestamp
Description
Tijdstempel van wanneer de task is gestart, in milliseconden. Als de task nog niet is gestart, is deze eigenschap 0.
Name
finished_at
Type
timestamp
Description
Tijdstempel van wanneer de task is voltooid, in milliseconden. Als de task nog niet is voltooid, is deze eigenschap 0.
Name
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande tasks.
De waarde van dit veld is alleen betekenisvol als de taakstatus PENDING is.
Name
task_error
Type
object
Description
Foutdetails voor mislukte tasks. Zie Fouten voor de volledige referentie van het task_error-object.
Name
consumed_credits
Type
integer
Description
Het aantal credits dat door deze task is verbruikt. Aanwezig wanneer de taakstatus PENDING, IN_PROGRESS, of SUCCEEDED is. Geeft 0 terug voor FAILED-tasks (credits worden bij mislukking terugbetaald).
Name
image_urls
Type
array of strings
Description
Downloadbare URL's voor de conceptafbeeldingkandidaten die door deze prototype-task zijn gegenereerd. Momenteel geeft de API altijd precies één kandidaat terug; het veld is een array zodat toekomstige revisies meerdere kandidaten kunnen aanbieden zonder een breaking change.
Het Vinyl Figure Build Task object is een werkeenheid die Meshy bijhoudt
om een getextureerde 3D vinyl figuur te genereren uit een geslaagde prototype-taak.
Het gebruikt dezelfde image-to-3D pipeline die wordt gebruikt door Afbeelding naar 3D,
dus de outputvelden komen overeen met het task object van die endpoint.
Eigenschappen
Name
id
Type
string
Description
Unieke identifier voor de taak.
Name
type
Type
string
Description
Type van de taak. De waarde is creative-lab-vinyl-figure-build.
Name
name
Type
string
Description
De taaknaam die is opgegeven bij het aanmaken van de taak. 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
Progress van de taak. Als de taak nog niet is gestart, is deze eigenschap 0. Zodra de taak is geslaagd, wordt dit 100.
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 resultaat van de taak verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande taken. Alleen relevant wanneer de status PENDING is.
Name
task_error
Type
object
Description
Foutdetails voor mislukte taken. Zie Fouten voor de volledige referentie van het task_error-object.
Name
consumed_credits
Type
integer
Description
Het aantal credits dat door deze taak is verbruikt. Geeft 0 terug voor FAILED-taken (credits worden terugbetaald bij een mislukking).
Name
prompt
Type
string
Description
Altijd leeg voor vinyl figure build. Aanwezig voor compatibiliteit tussen endpoints met de gedeelde V2ImageTo3DTaskResponse-vorm die wordt gebruikt door Afbeelding naar 3D.
Name
negative_prompt
Type
string
Description
Altijd leeg voor vinyl figure build. Aanwezig voor compatibiliteit tussen endpoints.
Name
texture_prompt
Type
string
Description
Altijd leeg voor vinyl figure build. Aanwezig voor compatibiliteit tussen endpoints.
Name
texture_image_url
Type
string
Description
Altijd leeg voor vinyl figure build. Aanwezig voor compatibiliteit tussen endpoints.
Name
model_urls
Type
object
Description
Downloadbare URL's voor het gegenereerde 3D-model. De vinyl figure build levert een getextureerde GLB plus het OBJ + MTL-paar voor pipelines die de voorkeur geven aan Wavefront OBJ. De vorm van dit veld komt overeen met het Image to 3D model_urls-object, zodat toekomstige formaattoevoegingen zonder breaking change kunnen worden ingepast.
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 bijbehorende OBJ MTL-materiaalbestand. Combineer met obj en het item 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 texture-URL-objecten die door deze taak zijn gegenereerd. Bevat momenteel een enkel object met de basiskleurenkaart.
Name
base_color
Type
string
Description
Downloadbare URL naar de afbeelding van de basiskleurenkaart.