Verander je foto's in op maat gemaakte koelkastmagneten — een afgeronde rechthoekige gekleurde diepte-reliëf met een vlakke magnetische achterkant, geschikt voor de koelkast — in twee fasen: prototype genereert een gekleurd conceptbeeld van je invoerfoto, vervolgens verandert bouw dat conceptbeeld in een reliëf 3D-model. De twee fasen zijn gekoppeld via input_task_id.
POST /openapi/creative-lab/fridge-magnet/v1/prototype
Genereer een enkel ingekleurd conceptafbeelding van de bronfoto. De
geretourneerde taak-ID is wat je doorgeeft als input_task_id aan de build
endpoint. Raadpleeg
Het Koelkastmagneet Prototype Taak Object
voor de vorm van de respons.
Parameters
Name
image_url
Type
string
Verplicht
Description
Bronfoto voor Meshy om in te kleuren tot een koelkastmagneet-klaar conceptafbeelding. We ondersteunen momenteel .jpg, .jpeg, .png, en .webp formaten.
Er zijn twee manieren om de afbeelding te leveren:
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. 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.
Dit regelt alleen de afbeelding die deze endpoint retourneert. Het is gescheiden van de buildoptie met dezelfde naam (standaard true), die achtergrondverwijdering regelt vóór het reliëf.
Retourneert
De result eigenschap van de respons bevat de taak id van de nieuw aangemaakte koelkastmagneet prototype taak. Poll de Haal een Taak op 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 opgegeven image_url is 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 verkeerd gevormd.
Inhoud gemarkeerd: De invoerafbeelding werd 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/fridge-magnet/v1/prototype
# Stage 1: generate a colorized fridge magnet concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/fridge-magnet/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":"01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"}
Prototype voorbeeld
Begin met een bronfoto, genereer vervolgens de prototype-afbeelding die wordt gebruikt door de koelkastmagneet bouwfase.
Genereer de definitieve 3D-printbare koelkastmagneet vanuit een geslaagde prototype taak. De bouw voert een dieptekaart-reliëfpijplijn uit op de ingekleurde conceptafbeelding van het prototype en levert een enkel mesh-artifact in het door u gevraagde formaat. Raadpleeg Het Koelkastmagneet Bouwtaak Object voor de responsvorm.
Parameters
Name
input_task_id
Type
string
Verplicht
Description
De taak-ID van een prototype taak gemaakt via dezezelfde OpenAPI endpoint. Het prototype moet zijn gemaakt 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 geproduceerd door POST /openapi/creative-lab/fridge-magnet/v1/prototype en weigert elke andere bron met 404.
Name
name
Type
string
Description
Optionele taaknaam voor weergavedoeleinden. Maximaal 100 tekens.
options
Optionele afstemparameters voor de reliëfgeometrie. Elk veld heeft een redelijke standaardwaarde — stuur alleen de velden die u wilt overschrijven.
Name
badge_shape
Type
string
standaard rounded-rect
Description
Omtreksilhouet van de koelkastmagneet. Beschikbare waarden:
circle
rounded-rect (standaard)
hexagon
shield
star
Name
size_mm
Type
number
standaard 60
Description
Lengte van de rand van het begrenzende vierkant van de koelkastmagneet, in millimeters. Bereik: (0, 400].
Name
relief_height_mm
Type
number
standaard 3.3
Description
Maximale reliëfhoogte boven de basis, in millimeters. Bereik: [0, 20].
Name
relief_offset_mm
Type
number
standaard 0
Description
Verticale offset toegepast op het reliëf vóór extrusie, in millimeters. Bereik: [0, 20].
Name
base_thickness_mm
Type
number
standaard 2.0
Description
Dikte van de vlakke basisplaat achter het reliëf, in millimeters. De standaard koelkastmagneet heeft een dikkere basis van 2 mm — geeft de magneet genoeg body om de koelkast te grijpen zonder dat het reliëf fragiel aanvoelt. Bereik: [0, 20].
Name
has_closed_back
Type
boolean
standaard true
Description
Of de achterkant van de koelkastmagneet is verzegeld als een gesloten oppervlak (de zijde waarop u de magneet plakt). Stel in op false voor een open schaal.
Name
relief_curve
Type
string
standaard linear
Description
Overdrachtscurve die dieptekaartwaarden naar reliëfhoogte mapt. Beschikbare waarden:
linear (standaard)
gamma
s-curve
Name
curve_param
Type
number
standaard 1.0
Description
Vormparameter voor de overdrachtscurve (alleen zinvol wanneer relief_curvegamma is). Bereik: (0, 10].
Name
invert_depth
Type
boolean
standaard false
Description
Keer de interpretatie van de dieptekaart om zodat donkere gebieden hoger reliëf worden.
Name
smoothing
Type
number
standaard 0.24
Description
Gladmakingssterkte toegepast op de dieptekaart vóór reliëfextractie. Bereik: [0, 10].
Laagdoorlaatdrempel voor dieptekaartwaarden; alles hieronder wordt vastgezet op nul. Bereik: [0, 1].
Name
remove_background
Type
boolean
standaard true
Description
Verwijder automatisch de achtergrond van de conceptafbeelding van het prototype voordat het reliëf wordt gemaakt.
Gescheiden van de prototype parameter met dezelfde naam (standaard false), die bepaalt of de prototype afbeelding zelf met transparantie wordt geretourneerd.
Name
export_resolution
Type
integer
standaard 512
Description
Mesh-resolutie gebruikt voor export. Bereik: [64, 2048].
output
Optionele draadformaatselector. Standaard is glb.
Name
format
Type
string
standaard glb
Description
Artifactbundel geretourneerd door de bouw. Beschikbare waarden:
glb (standaard) — retourneert een enkele model.glb onder model_urls.glb.
obj — zipt model.obj + model.mtl + texture.png en retourneert de bundel onder model_urls.obj.
zip — zipt elk artifact dat de generator uitzendt en retourneert de bundel onder model_urls.bundle_zip.
Retourneert
De result eigenschap van de respons bevat de taak id van de nieuw aangemaakte koelkastmagneet bouwtaak. Poll de Haal een Taak op endpoint of abonneer op de stream totdat de taak SUCCEEDED bereikt, en download vervolgens het artifact van de enkele vermelding in model_urls.
Foutmodi
Name
400 - Bad Request
Description
Het verzoek was onacceptabel. Veelvoorkomende oorzaken:
Ontbrekende parameter: input_task_id is vereist.
Ongeldige UUID: De input_task_id is geen geldige UUID.
Ouder niet geslaagd: De gerefereerde prototype taak heeft SUCCEEDED nog niet bereikt.
Geen kandidaat: De prototype taak is geslaagd maar heeft geen kandidaat-afbeelding geproduceerd.
Opties buiten bereik: Een van de options velden viel buiten het toegestane bereik of enum set.
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 gerefereerde prototype taak bestaat niet, behoort tot een andere gebruiker, of is gemaakt via de webapp (alleen API-modus prototype taken schakelen in bouw).
Haal een prototype- of bouwtaak op met een geldig taak id. Het URL-pad
moet overeenkomen met de fase van de taak — een bouwtaak opgehaald via
/prototype/:id geeft 404, en vice versa.
Annuleer een koelkastmagneet-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 werknemer kan al bronnen aan het verbruiken zijn). Taken die al een eindstatus hebben bereikt (SUCCEEDED, FAILED, CANCELED) kunnen niet worden geannuleerd.
Het URL-pad moet overeenkomen met de fase van de taak — DELETE op
/prototype/:buildId retourneert 404.
Padparameters
Name
id
Type
path
Description
Unieke identificatie voor de koelkastmagneet-taak om te annuleren.
Retourneert
Retourneert 204 No Content bij succes met een lege body.
Foutmodi
Name
400 - Bad Request
Description
De taak is al in een eindstatus en kan niet worden geannuleerd.
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 koelkastmagneet-taak via Server-Sent Events (SSE).
Het URL-pad moet overeenkomen met de fase van de taak — het openen van een stream bij
/prototype/:buildId/stream geeft een enkele event: error payload met
status_code: 404 en sluit de stream.
Parameters
Name
id
Type
path
Description
Unieke identificatie voor de koelkastmagneet-taak om te streamen.
Retourneert
Retourneert een stream van Koelkastmagneet Prototype
of Koelkastmagneet Build taakobjecten als
Server-Sent Events. Voor PENDING of IN_PROGRESS taken, zal de responsstream
alleen de noodzakelijke progress en status velden bevatten.
// Error event example (wrong stage or task not found)event: errordata: {"status_code": 404,"message": "Task not found"}// Message event examples illustrate task progress.// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.event: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","progress": 0,"status": "PENDING"}event: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","type": "creative-lab-fridge-magnet-build","status": "SUCCEEDED","progress": 100,"created_at": 1729543250000,"started_at": 1729543258000,"finished_at": 1729543285000,"expires_at": 1729802485000,"task_error": null,"consumed_credits": 20,"model_urls": {"glb":"https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***" }}
Haal een gepagineerde lijst op van je koelkastmagneet taken voor een enkele fase. Het URL-pad selecteert de fase — /prototype retourneert prototype taken; /build retourneert build taken. 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 — het ophalen van /prototype retourneert nooit
build taken en vice versa.
Queryparameters
Name
page_num
Type
integer
standaard 1
Description
Paginanummer voor paginering.
Name
page_size
Type
integer
standaard 10
Description
Limiet voor paginagrootte. Maximum toegestaan is 50 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 Koelkastmagneet Prototype Taakobject is een werkunit die Meshy bijhoudt om een ingekleurde conceptafbeelding te genereren van een bronfoto. De output van deze fase wordt gekoppeld aan de bouwfase via input_task_id.
Eigenschappen
Name
id
Type
string
Description
Unieke identificatie voor de taak. Hoewel we een k-sortable UUID gebruiken voor taak-id's als implementatiedetail, moet je geen aannames doen over het formaat van de id.
Name
type
Type
string
Description
Type van de taak. De waarde is creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
De taaknaam die werd 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, 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 is verstreken 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 0 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 0 zijn.
Name
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorgaande taken.
De waarde van dit veld is alleen betekenisvol 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 dat door deze taak is verbruikt. Aanwezig wanneer de taakstatus PENDING, IN_PROGRESS of SUCCEEDED is. Geeft 0 terug voor FAILED taken (credits worden terugbetaald bij mislukking).
Name
image_urls
Type
array of strings
Description
Downloadbare URL's voor de conceptafbeelding kandidaten gegenereerd door deze prototype taak. Momenteel retourneert de API altijd precies één kandidaat; het veld is een array zodat toekomstige revisies meerdere kandidaten kunnen tonen zonder een brekende wijziging.
Het Koelkastmagneet Bouwtaak object is een werkunit die Meshy bijhoudt om de uiteindelijke 3D koelkastmagneet mesh te genereren van een geslaagde prototypetaak. De bouw voert een dieptekaartreliëfpijplijn uit op de conceptafbeelding van het prototype en publiceert een enkel mesh artefact in het formaat dat de aanroeper heeft aangevraagd.
Eigenschappen
Name
id
Type
string
Description
Unieke identificatie voor de taak.
Name
type
Type
string
Description
Type van de taak. De waarde is creative-lab-fridge-magnet-build.
Name
name
Type
string
Description
De taaknaam die werd opgegeven toen de taak werd aangemaakt. Lege string als er geen naam werd 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, 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 taakresultaat verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorgaande taken. Betekenisvol 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 terugbetaald bij mislukking).
Name
model_urls
Type
object
Description
Downloadbare URL's voor het gegenereerde artefact, gesorteerd op artefactnaam. Bevat altijd precies één item — het formaat dat is aangevraagd via het bouwverzoek's output.format. De sleutel komt overeen met het aangevraagde formaat:
Name
glb
Type
string
Description
Downloadbare URL naar het GLB-bestand. Aanwezig wanneer output.formatglb was (de standaard).
Name
obj
Type
string
Description
Downloadbare URL naar een zip-bundel met model.obj, model.mtl, en texture.png. Aanwezig wanneer output.formatobj was.
Name
bundle_zip
Type
string
Description
Downloadbare URL naar een zip-bundel van elk artefact dat de generator uitzendt. Aanwezig wanneer output.formatzip was.